Configure CleanThat

[cleanthat]

Welcome to CleanThat!

This onboarding Pull-Request helps you configuring Cleanthat. It can safely be merged right-away.

🚦 To activate CleanThat, merge this Pull-Request. To disable CleanThat, simply close this Pull-Request unmerged.

---

Configuration Summary

Based on the default config's presets, CleanThat will:

• Apply formatting over 'glob:**/*.MD' (markdown) files with the help of Spotless

🔡 Would you like to change the way CleanThat is cleaning your code? Simply edit the .cleanthat/cleanthat.yaml in this branch with your custom config.

What to Expect

• Pull-Request being open to clean the default branch.
• Commits being applied to not protected branches (see meta.refs.protected_patterns in .cleanthat/cleanthat.yaml)

---

This PR has been generated by CleanThat.
X-GitHub-Delivery=random-bb2ceaaf-e824-4fd5-9b05-afffb5a0c46e

---

@solven-eu/cleanthat-notify please look at me

---

Important

Configure CleanThat with Spotless for automatic code formatting on markdown files, with branch protection rules.

• Configuration:
  • Adds .cleanthat/cleanthat.yaml to configure CleanThat with Spotless for code formatting.
  • Sets protected_patterns for branches: develop, main, master.
  • Excludes release/* branches from cleaning.
  • Allows editing of non-protected branches.
• Formatting:
  • Configures Spotless in .cleanthat/spotless.yaml for json and markdown formats.
  • Uses jackson for JSON with ORDER_MAP_ENTRIES_BY_KEYS feature.
  • Uses flexmark and freshmark for Markdown with specific parameters.

^{This description was created by for 9368e2d. You can customize this summary. It will automatically update as commits are pushed.}

Summary by Bito

• This pull request introduces the configuration for CleanThat, enabling automatic code formatting for Markdown files using Spotless.
• It establishes branch protection rules, allowing edits on non-protected branches while excluding certain branches from cleaning.
• The configuration files for CleanThat and Spotless are added to facilitate these features.
• Overall, this pull request introduces configurations for CleanThat and Spotless, impacting code formatting and branch protection rules.

[codesherlock-ai]

We could not run your PR Review. We noticed that you are part of an Org. We require everyone who is part of an Org to SignUp via GitHub so we can track your individual usage and maximize on your usage capacity. Enroll into CodeSherlock system by signing up via GitHub using the SignUp link. Also, please note — every user pays for their own usage.

[codoki-pr-intelligence]

Codoki - Action needed

Almost there! 🚀 We’ll run this review once you’re connected to Codoki.

Quick setup (≈2 minutes):

1. Sign up at codoki.ai with your GitHub (free).
2. If your team already uses Codoki, ask an admin to invite you (Codoki → Members). Otherwise create a workspace and connect this repo.
3. Re-run checks on this PR.

What you’ll get:

• ✅ 15 free PR reviews / month
• 🧠 Context-aware reviews that use your framework & rules
• ⚙️ 5 custom rules and team configs
• 🚀 Up to 5× faster merges with inline suggestions

_{Need help? info@codoki.ai}

[coderabbitai]

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[ellipsis-dev]

Important

Looks good to me! 👍

Reviewed everything up to 9368e2d in 1 minute and 54 seconds. Click for details.

• Reviewed 63 lines of code in 2 files
• Skipped 0 files when reviewing.
• Skipped posting 4 draft comments. View those below.
• Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.

1. .cleanthat/cleanthat.yaml:20

• Draft comment:
  Empty 'source_code: {}' block for engine 'spotless' seems redundant. Remove if not needed.
• Reason this comment was not posted:
  Confidence changes required: 33% <= threshold 50% None

2. .cleanthat/cleanthat.yaml:16

• Draft comment:
  Verify that 'line_ending: "GIT"' is intended, as spotless config uses 'GIT_ATTRIBUTES'.
• Reason this comment was not posted:
  Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 15% vs. threshold = 50% The comment is asking the author to "Verify that..." which is explicitly mentioned in the rules as a pattern that indicates the comment is likely not useful. The comment references another file (spotless.yaml) that I cannot see in the diff to confirm whether there's actually an inconsistency. Without being able to see the spotless.yaml file, I cannot verify if there's a real conflict. The comment is speculative about whether this is a problem - it's not definitively stating there IS an issue, just suggesting there MIGHT be one. This violates the rule about not making speculative comments. It's possible that "GIT" and "GIT_ATTRIBUTES" are actually incompatible settings that would cause a real runtime error, and the automated tool has access to the spotless.yaml file that I don't. The suggestion might be based on legitimate knowledge of how cleanthat configuration works. Even if there is a real inconsistency, the comment starts with "Verify that..." which is explicitly called out as not useful. The comment doesn't provide strong evidence that this is definitely wrong - it's asking for verification. Without seeing the spotless.yaml file in the diff, I cannot confirm this is a real issue, and the rules state I should delete comments when understanding requires more context from other files. This comment should be deleted because it asks the author to "verify" something rather than stating a definite issue, and it references another file not visible in the diff to justify the concern. Without strong evidence in the visible diff that this is wrong, and given the "Verify that..." pattern, this comment should be removed.

3. .cleanthat/spotless.yaml:5

• Draft comment:
  Confirm that using 'line_ending: "GIT_ATTRIBUTES"' here aligns with the main config's 'GIT' setting.
• Reason this comment was not posted:
  Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 10% vs. threshold = 50% This comment is asking the PR author to "confirm" alignment between two settings. This directly violates the rule: "Do NOT ask the PR author to confirm their intention, to explain, to double-check things, to ensure the behavior is intended, to make sure their change is tested, or similar." The comment doesn't identify a specific problem - it's just asking for verification. It's also speculative about whether there might be a misalignment, rather than definitively stating there is an issue. The comment doesn't suggest a specific code change. Perhaps there is a genuine configuration conflict between "GIT_ATTRIBUTES" and "native" that would cause issues, and the comment is trying to highlight this. Maybe I'm missing domain-specific knowledge about Spotless configuration that would make this a valid concern. Even if there were a potential conflict, the comment should state the issue definitively and suggest a fix, not ask the author to "confirm" things. The comment doesn't explain what the problem would be or what should be changed, making it not actionable. This comment should be deleted because it asks the PR author to confirm/verify settings rather than pointing out a definite issue with a clear fix. It violates the rule against asking for confirmation.

4. .cleanthat/spotless.yaml:16

• Draft comment:
  Double-check if both markdown steps ('flexmark' and 'freshmark') are necessary to avoid overlapping formatting.
• Reason this comment was not posted:
  Confidence changes required: 33% <= threshold 50% None

Workflow ID: wflow_OJOQjIPasILlCxyQ

^{You can customize by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.}