Skip to content

Commit e802906

Browse files
committed
rename MDS036 to max-section-length
Align with max-file-length naming. "Size" was ambiguous (bytes? tokens?); "length" mirrors the file-level analog and makes it clear the limit counts lines. Renames: - package sectionsizelimits -> maxsectionlength - rule name section-size-limits -> max-section-length - fixture dir MDS036-section-size-limits -> MDS036-max-section-length
1 parent fb6019c commit e802906

13 files changed

Lines changed: 39 additions & 38 deletions

File tree

cmd/mdsmith/main.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ import (
4040
_ "github.com/jeduden/mdsmith/internal/rules/linelength"
4141
_ "github.com/jeduden/mdsmith/internal/rules/listindent"
4242
_ "github.com/jeduden/mdsmith/internal/rules/maxfilelength"
43+
_ "github.com/jeduden/mdsmith/internal/rules/maxsectionlength"
4344
_ "github.com/jeduden/mdsmith/internal/rules/nobareurls"
4445
_ "github.com/jeduden/mdsmith/internal/rules/noduplicateheadings"
4546
_ "github.com/jeduden/mdsmith/internal/rules/noemphasisasheading"
@@ -51,7 +52,6 @@ import (
5152
_ "github.com/jeduden/mdsmith/internal/rules/paragraphreadability"
5253
_ "github.com/jeduden/mdsmith/internal/rules/paragraphstructure"
5354
_ "github.com/jeduden/mdsmith/internal/rules/requiredstructure"
54-
_ "github.com/jeduden/mdsmith/internal/rules/sectionsizelimits"
5555
_ "github.com/jeduden/mdsmith/internal/rules/singletrailingnewline"
5656
_ "github.com/jeduden/mdsmith/internal/rules/tableformat"
5757
_ "github.com/jeduden/mdsmith/internal/rules/tablereadability"

internal/config/config_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ import (
2828
_ "github.com/jeduden/mdsmith/internal/rules/linelength"
2929
_ "github.com/jeduden/mdsmith/internal/rules/listindent"
3030
_ "github.com/jeduden/mdsmith/internal/rules/maxfilelength"
31+
_ "github.com/jeduden/mdsmith/internal/rules/maxsectionlength"
3132
_ "github.com/jeduden/mdsmith/internal/rules/nobareurls"
3233
_ "github.com/jeduden/mdsmith/internal/rules/noduplicateheadings"
3334
_ "github.com/jeduden/mdsmith/internal/rules/noemphasisasheading"
@@ -38,7 +39,6 @@ import (
3839
_ "github.com/jeduden/mdsmith/internal/rules/paragraphreadability"
3940
_ "github.com/jeduden/mdsmith/internal/rules/paragraphstructure"
4041
_ "github.com/jeduden/mdsmith/internal/rules/requiredstructure"
41-
_ "github.com/jeduden/mdsmith/internal/rules/sectionsizelimits"
4242
_ "github.com/jeduden/mdsmith/internal/rules/singletrailingnewline"
4343
_ "github.com/jeduden/mdsmith/internal/rules/tableformat"
4444
_ "github.com/jeduden/mdsmith/internal/rules/tablereadability"

internal/engine/categories_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,14 @@ import (
2626
_ "github.com/jeduden/mdsmith/internal/rules/headingstyle"
2727
_ "github.com/jeduden/mdsmith/internal/rules/linelength"
2828
_ "github.com/jeduden/mdsmith/internal/rules/listindent"
29+
_ "github.com/jeduden/mdsmith/internal/rules/maxsectionlength"
2930
_ "github.com/jeduden/mdsmith/internal/rules/nobareurls"
3031
_ "github.com/jeduden/mdsmith/internal/rules/noduplicateheadings"
3132
_ "github.com/jeduden/mdsmith/internal/rules/noemphasisasheading"
3233
_ "github.com/jeduden/mdsmith/internal/rules/nohardtabs"
3334
_ "github.com/jeduden/mdsmith/internal/rules/nomultipleblanks"
3435
_ "github.com/jeduden/mdsmith/internal/rules/notrailingpunctuation"
3536
_ "github.com/jeduden/mdsmith/internal/rules/notrailingspaces"
36-
_ "github.com/jeduden/mdsmith/internal/rules/sectionsizelimits"
3737
_ "github.com/jeduden/mdsmith/internal/rules/singletrailingnewline"
3838
_ "github.com/jeduden/mdsmith/internal/rules/tokenbudget"
3939
)

internal/integration/rules_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ import (
3232
_ "github.com/jeduden/mdsmith/internal/rules/linelength"
3333
_ "github.com/jeduden/mdsmith/internal/rules/listindent"
3434
_ "github.com/jeduden/mdsmith/internal/rules/maxfilelength"
35+
_ "github.com/jeduden/mdsmith/internal/rules/maxsectionlength"
3536
_ "github.com/jeduden/mdsmith/internal/rules/nobareurls"
3637
_ "github.com/jeduden/mdsmith/internal/rules/noduplicateheadings"
3738
_ "github.com/jeduden/mdsmith/internal/rules/noemphasisasheading"
@@ -43,7 +44,6 @@ import (
4344
_ "github.com/jeduden/mdsmith/internal/rules/paragraphreadability"
4445
_ "github.com/jeduden/mdsmith/internal/rules/paragraphstructure"
4546
_ "github.com/jeduden/mdsmith/internal/rules/requiredstructure"
46-
_ "github.com/jeduden/mdsmith/internal/rules/sectionsizelimits"
4747
_ "github.com/jeduden/mdsmith/internal/rules/singletrailingnewline"
4848
_ "github.com/jeduden/mdsmith/internal/rules/tableformat"
4949
_ "github.com/jeduden/mdsmith/internal/rules/tablereadability"

internal/rules/MDS036-section-size-limits/README.md renamed to internal/rules/MDS036-max-section-length/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
22
id: MDS036
3-
name: section-size-limits
3+
name: max-section-length
44
status: ready
55
description: Section length must not exceed per-level or per-heading limits.
66
---
7-
# MDS036: section-size-limits
7+
# MDS036: max-section-length
88

99
Section length must not exceed per-level or per-heading limits.
1010

1111
- **ID**: MDS036
12-
- **Name**: `section-size-limits`
12+
- **Name**: `max-section-length`
1313
- **Status**: ready
1414
- **Default**: disabled
1515
- **Fixable**: no
@@ -40,15 +40,15 @@ Enable with a default limit:
4040

4141
```yaml
4242
rules:
43-
section-size-limits:
43+
max-section-length:
4444
max: 100
4545
```
4646
4747
Per-level and per-heading overrides:
4848
4949
```yaml
5050
rules:
51-
section-size-limits:
51+
max-section-length:
5252
max: 100
5353
per-level:
5454
1: 200
@@ -62,7 +62,7 @@ Disable:
6262
6363
```yaml
6464
rules:
65-
section-size-limits: false
65+
max-section-length: false
6666
```
6767
6868
## Examples

internal/rules/MDS036-section-size-limits/bad/default.md renamed to internal/rules/MDS036-max-section-length/bad/default.md

File renamed without changes.

internal/rules/MDS036-section-size-limits/bad/per-level.md renamed to internal/rules/MDS036-max-section-length/bad/per-level.md

File renamed without changes.

internal/rules/MDS036-section-size-limits/good/default.md renamed to internal/rules/MDS036-max-section-length/good/default.md

File renamed without changes.

internal/rules/MDS036-section-size-limits/good/per-level.md renamed to internal/rules/MDS036-max-section-length/good/per-level.md

File renamed without changes.

internal/rules/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,5 +52,5 @@ row: "| [{id}]({filename}) | `{name}` | {status} | {description} |"
5252
| [MDS031](MDS031-unclosed-code-block/README.md) | `unclosed-code-block` | ready | Fenced code blocks must have a closing fence delimiter. |
5353
| [MDS032](MDS032-no-empty-alt-text/README.md) | `no-empty-alt-text` | ready | Images must have non-empty alt text for accessibility. |
5454
| [MDS033](MDS033-directory-structure/README.md) | `directory-structure` | ready | Markdown files must exist only in explicitly allowed directories. |
55-
| [MDS036](MDS036-section-size-limits/README.md) | `section-size-limits` | ready | Section length must not exceed per-level or per-heading limits. |
55+
| [MDS036](MDS036-max-section-length/README.md) | `max-section-length` | ready | Section length must not exceed per-level or per-heading limits. |
5656
<?/catalog?>

0 commit comments

Comments
 (0)