Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Markdownlint Showcase #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
nimratcoderabbit wants to merge 3 commits into main from preview/markdownlint
Closed

Conversation

Copy link

@nimratcoderabbit nimratcoderabbit commented Jul 14, 2025 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • Chores
    • Added a configuration file for markdownlint-cli2 to enforce specific markdown style rules and output results in JSON format.
    • Introduced a test markdown file with various formatting examples to validate linting rules.

Copy link

coderabbitai bot commented Jul 14, 2025 •
edited
Loading

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

A new markdownlint-cli2 configuration file was added to enable specific linting rules and output results in JSON format. A markdown test file with intentional YAML formatting errors was introduced to validate the linting rules and configuration.

Changes

File(s) Change Summary
markdownlint/.markdownlint-cli2.jsonc Added configuration enabling rules MD001, MD002, MD022, MD031 with JSON output formatter.
markdownlint/test.md Added test markdown file containing YAML examples with deliberate indentation and syntax errors.

Poem

Linting rules now set in stone,
With JSON output—clearly shown!
Test markdown lines, some neat, some wild,
Formatting errors, purposefully compiled.
The linter stands ready, its mission in sight,
To tidy our docs and make markdown right!
📝✨

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 08efcb2 and 70b4e06.

📒 Files selected for processing (1)
  • markdownlint/test.md (1 hunks)
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch preview/markdownlint
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai auto-generate unit tests to generate unit tests for this 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
markdownlint/.markdownlint-cli2.jsonc (1)

2-9: Trim redundant rule declarations or explicitly enable the rule you’re actually showcasing

With "default": true, every core rule (including MD018 that the sample file triggers) is already active. The extra "MD001" ... "MD031" lines add no functional value and may confuse future maintainers about which rules are really in scope. Either delete them or, if you intend to highlight a subset, drop "default": true and list only the wanted rules (including MD018).

Example minimal config that still exercises all rules:

 "outputFormatters": [["markdownlint-cli2-formatter-json"]],
- "config": {
- "default": true,
- "MD001": true,
- "MD002": true,
- "MD022": true,
- "MD031": true
- }
+ "config": { "default": true }
markdownlint/test.md (1)

6-7: Same concern for list spacing and trailing blanks

The missing space after "-" triggers MD030; the trailing spaces trigger MD009. Confirm they remain contained in a dedicated "negative test" area so production docs stay clean.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ef04b8d and 08efcb2.

📒 Files selected for processing (2)
  • markdownlint/.markdownlint-cli2.jsonc (1 hunks)
  • markdownlint/test.md (1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
markdownlint/test.md

1-1: No space after hash on atx style heading

(MD018, no-missing-space-atx)

2-2: No space after hash on atx style heading

(MD018, no-missing-space-atx)

🔇 Additional comments (2)
markdownlint/.markdownlint-cli2.jsonc (1)

1-10: Looks good otherwise – valid JSONC and supported formatter

The file parses cleanly and uses the officially-maintained markdownlint-cli2-formatter-json, so the basic setup is sound.

markdownlint/test.md (1)

1-2: Flag test file so CI doesn’t fail on purpose-built lint errors

This file intentionally violates MD018/MD001. Be sure the path is excluded (e.g., via .markdownlintignore) or the CI job will red-fail when markdownlint runs in "strict" mode.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] approved these changes

@alexcoderabbitai alexcoderabbitai Awaiting requested review from alexcoderabbitai

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant

AltStyle によって変換されたページ (->オリジナル) /