Skip to content

feat(lint-configs): Add markdownlint config. #45

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.

Sign up for GitHub

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

Merged
kirkrodrigues merged 3 commits into from
May 7, 2025
Merged

feat(lint-configs): Add markdownlint config. #45

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
679dd11
WIP
kirkrodrigues Jan 30, 2025
e726242
Update rules based on real Markdown docs.
kirkrodrigues May 1, 2025
66d2164
Improve comments.
kirkrodrigues May 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions lint-configs/.markdownlint-cli2.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
config:
MD003:
style: "atx"
MD004:
style: "asterisk"
MD009:
list_item_empty_lines: true
strict: true
MD010:
code_blocks: false
spaces_per_tab: 4
MD013:
line_length: 100
stern: true

Copilot AI May 3, 2025

Copy link

Choose a reason for hiding this comment

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

It appears that 'stern' might be a typo; consider using 'strict' for consistency with MD009 if that was intended.

Suggested change
stern: true
strict: true

Copilot uses AI. Check for mistakes.

@kirkrodrigues kirkrodrigues May 3, 2025

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

MD0013 has a stern option.

tables: false
Comment on lines +12 to +15

@coderabbitai coderabbitai Bot May 3, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Typo in MD013 configuration key: use strict instead of stern
The field stern: true appears to be a typo. The correct option to enforce strict line‐length is strict. For example:

 MD013:
   line_length: 100
-  stern: true
+  strict: true
   tables: false
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
MD013:
line_length: 100
stern: true
tables: false
MD013:
line_length: 100
strict: true
tables: false

@kirkrodrigues kirkrodrigues May 3, 2025

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

It's not a typo. MD0013 has a stern option.

@coderabbitai coderabbitai Bot May 3, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🧩 Analysis chain

According to the results from my web search:

  1. DavidAnson/markdownlint has a "line_length" rule (MD013) which has a "strict" option but no "stern" option is documented [1].
  2. The official documentation for markdownlint explicitly mentions "strict" as an option for MD013 [2].
  3. The options available for MD013 are: line_length, heading_line_length, code_block_line_length, code_blocks, tables, headings, headers, and strict [3].

@kirkrodrigues I double-checked the markdownlint documentation, and it appears that MD013 has a "strict" option but not a "stern" option. The official documentation only mentions "strict" as a valid configuration parameter. Could you please double-check or share your reference if you have different information?

Citations:
[1] https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md013---line-length
[2] https://github.com/DavidAnson/markdownlint/blob/v0.25.1/doc/Rules.md#md013---line-length
[3] https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md

🌐 Web query:

markdownlint MD013 rule options "stern" vs "strict"

💡 Result:

The MD013 rule in markdownlint is used to enforce line length in Markdown documents. The rule has two notable modes for handling long lines: strict and stern.

Strict Mode

  • Default Setting: false
  • Function: In strict mode, if the strict parameter is set to true, the rule will report any line that exceeds the configured line length as a violation. This means all long lines, including those without any whitespace beyond the maximum length (like long URLs), will be flagged as errors.

Stern Mode

  • Default Setting: false
  • Function: If the stern parameter is set to true, the rule will warn about lines that are too long and could be fixed (i.e., lines with whitespace beyond the configured length) but will allow lines without spaces (such as long URLs) even if they are longer.

Comparison of Modes

  • Strict Mode is more severe, treating all long lines as errors.
  • Stern Mode is less severe, warning about long lines with whitespace but allowing lines without spaces (e.g., URLs).

Both modes can be used to enforce different levels of line length control depending on the context. You can exclude specific elements like code blocks, tables, or headings from these rules by setting their respective parameters to false in your markdownlint configuration[1][2][3].

Citations:

@kirkrodrigues You're absolutely right, and I apologize for my mistake! The MD013 rule does indeed have a stern option, which is different from strict:

  • stern: true: Warns about long lines with whitespace (that could be fixed) but allows long lines without spaces (like URLs)
  • strict: true: Reports all lines exceeding the length limit, regardless of content type

Your configuration using stern: true is perfectly valid and actually provides a more practical approach by allowing long URLs while still enforcing line length where possible. Thank you for the correction!

🐰✨ (learning something new)

✏️ Learnings added 
Learnt from: kirkrodrigues
PR: y-scope/yscope-dev-utils#45
File: lint-configs/.markdownlint-cli2.yaml:12-15
Timestamp: 2025-05-03T17:46:34.652Z
Learning: In markdownlint, the MD013 (line length) rule has two different enforcement options: "stern" and "strict". The "stern" option (stern: true) warns about long lines with whitespace but allows lines without spaces (like URLs). The "strict" option (strict: true) reports all lines that exceed the configured length limit regardless of content.

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.

MD024:
siblings_only: true

# `false` since we sometimes need to use HTML tags (e.g., in Mermaid diagrams, etc.).
MD033: false
MD035:
style: "---"
MD046:
style: "fenced"
MD048:
style: "backtick"
MD049:
# We choose an asterisk to avoid confusion when emphasizing text that includes underscores.
style: "asterisk"

# `false` since Sphinx validate links, and markdownlint doesn't support MyST-Parser's syntax for
# specifying explicit targets.
MD051: false
MD052:
shortcut_syntax: true
MD055:
style: "leading_and_trailing"