Skip to content

feat: split "long code blocks" rule into suggestion and warning #173

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
SecondSkoll merged 5 commits into from
Feb 23, 2026
Merged

feat: split "long code blocks" rule into suggestion and warning #173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5eb0f44
reduce "long codeblock" rule to 35 lines
dwilding Feb 3, 2026
9606f41
add suggestion rule for >25 lines
dwilding Feb 3, 2026
7f08210
expect blank line after MyST options
dwilding Feb 11, 2026
180e71c
match codeblock lines more carefully
dwilding Feb 11, 2026
911d556
fix: 17a/b allow no blank line in MD after option block
SecondSkoll Feb 11, 2026
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
11 changes: 0 additions & 11 deletions styles/Canonical/017-Avoid-long-code-blocks.yml
View file
Open in desktop

This file was deleted.

11 changes: 11 additions & 0 deletions styles/Canonical/017a-Suggest-code-over-25-lines.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
extends: existence
message: "Use 25 or fewer lines in code blocks"
link: https://docs.ubuntu.com/styleguide/en/#code-examples-in-documentation
level: suggestion
scope: raw
nonword: true
tokens:
- '``` ?({(code-block|code|sourcecode)})?[^{}\n]*\n((:[^\n]+:[^\n]*\n)+\n?)?(?!```)[^:\n][^\n]*\n(\n|(?!```)[^:\n][^\n]*\n){25,}```'
- '::: ?({(code-block|code|sourcecode)})?[^{}\n]*\n((:[^\n]+:[^\n]*\n)+\n?)?(?!:::)[^:\n][^\n]*\n(\n|(?!:::)[^:\n][^\n]*\n){25,}:::'
- '::\n\n(( {3}[^\n]+)?\n){25,} {3}[^\n]+\n'
- '\.\. (code-block|code|sourcecode)::( [^\n]+)?\n(( {3,12}:[^\n:]*:[^\n]*\n)*)?\n(( {3}[^\n]+)?\n){25,} {3}[^\n]+\n'
11 changes: 11 additions & 0 deletions styles/Canonical/017b-Warn-code-over-35-lines.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
extends: existence
message: "Use 35 or fewer lines in code blocks"
link: https://docs.ubuntu.com/styleguide/en/#code-examples-in-documentation
level: warning
scope: raw
nonword: true
tokens:
- '``` ?({(code-block|code|sourcecode)})?[^{}\n]*\n((:[^\n]+:[^\n]*\n)+\n?)?(?!```)[^:\n][^\n]*\n(\n|(?!```)[^:\n][^\n]*\n){35,}```'
- '::: ?({(code-block|code|sourcecode)})?[^{}\n]*\n((:[^\n]+:[^\n]*\n)+\n?){0.1}(?!:::)[^:\n][^\n]*\n(\n|(?!:::)[^:\n][^\n]*\n){35,}:::'
- '::\n\n(( {3}[^\n]+)?\n){35,} {3}[^\n]+\n'
- '\.\. (code-block|code|sourcecode)::( [^\n]+)?\n(( {3,12}:[^\n:]*:[^\n]*\n)*)?\n(( {3}[^\n]+)?\n){35,} {3}[^\n]+\n'
Loading