feat(commitlint): ignore "wip" messages in commitlint

[mheob]

Summary by CodeRabbit

• New Features

  • Commit linting now ignores "wip" messages, allowing work-in-progress commits without errors.
  • Enhanced integration with SonarLint for improved code quality checks.

• Configuration Changes

  • Adjusted code formatting and linting settings to prioritize ESLint over Prettier.

[changeset-bot]

🦋 Changeset detected

Latest commit: 8461ded

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@mheob/commitlint-config	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
eslint-config	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 14, 2024 0:23am

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes introduce a minor update to the @mheob/commitlint-config package, allowing commit messages that contain "wip" (work in progress) to bypass linting errors. This is achieved by adding an ignores property in the configuration. Additionally, modifications to the .vscode/settings.json file adjust code formatting and linting settings, including disabling Prettier and configuring ESLint to fix issues on save. A new configuration for SonarLint is also added to facilitate integration for code quality checks.

Changes

File Path	Change Summary
packages/commitlint-config/src/index.ts	Added ignores: [message => /wip/i.test(message)] to ignore "wip" messages in commitlint.
.vscode/settings.json	Modified settings: disabled Prettier, set editor.formatOnSave to false, configured ESLint, and added SonarLint connection settings.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant CommitLint
    participant ESLint
    participant SonarLint

    Developer->>CommitLint: Commit message (e.g., "wip: work in progress")
    CommitLint-->>Developer: Ignore commit (no linting error)
    
    Developer->>ESLint: Save file
    ESLint-->>Developer: Fix issues on save

    Developer->>SonarLint: Analyze code
    SonarLint-->>Developer: Provide code quality feedback

Loading

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

Failed to generate code suggestions for PR

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud