Skip to content
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

Sort output by file line order rather than rule number #416

Open
JayBeeDe opened this issue Jun 3, 2022 · 1 comment
Open

Sort output by file line order rather than rule number #416

JayBeeDe opened this issue Jun 3, 2022 · 1 comment
Labels
enhancement New feature or request

Comments

@JayBeeDe
Copy link

JayBeeDe commented Jun 3, 2022

Describe the Enhancement:

Add a CLI parameter such as "-S" flag in order to require the output to be sorted by file line number rather than line reference.

Impacted Rules:

All rules

Describe the Need:

Current implementation example

mdl README.md -r "~MD033,~MD013"
README.md:6: MD004 Unordered list style
README.md:7: MD004 Unordered list style
README.md:10: MD004 Unordered list style
README.md:11: MD004 Unordered list style
README.md:12: MD004 Unordered list style
README.md:13: MD004 Unordered list style
README.md:161: MD004 Unordered list style
README.md:162: MD004 Unordered list style
README.md:175: MD004 Unordered list style
README.md:176: MD004 Unordered list style
README.md:177: MD004 Unordered list style
README.md:179: MD004 Unordered list style
README.md:62: MD029 Ordered list item prefix
README.md:71: MD029 Ordered list item prefix
README.md:74: MD029 Ordered list item prefix
README.md:77: MD029 Ordered list item prefix
README.md:80: MD029 Ordered list item prefix
README.md:71: MD032 Lists should be surrounded by blank lines
README.md:74: MD032 Lists should be surrounded by blank lines
README.md:77: MD032 Lists should be surrounded by blank lines
README.md:80: MD032 Lists should be surrounded by blank lines

A detailed description of the rules is available at https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md

Target implementation example

mdl README.md -r "~MD033,~MD013" -S
README.md:6: MD004 Unordered list style
README.md:7: MD004 Unordered list style
README.md:10: MD004 Unordered list style
README.md:11: MD004 Unordered list style
README.md:12: MD004 Unordered list style
README.md:13: MD004 Unordered list style
README.md:62: MD029 Ordered list item prefix
README.md:71: MD029 Ordered list item prefix
README.md:71: MD032 Lists should be surrounded by blank lines
README.md:74: MD029 Ordered list item prefix
README.md:74: MD032 Lists should be surrounded by blank lines
README.md:77: MD029 Ordered list item prefix
README.md:77: MD032 Lists should be surrounded by blank lines
README.md:80: MD029 Ordered list item prefix
README.md:80: MD032 Lists should be surrounded by blank lines
README.md:161: MD004 Unordered list style
README.md:162: MD004 Unordered list style
README.md:175: MD004 Unordered list style
README.md:176: MD004 Unordered list style
README.md:177: MD004 Unordered list style
README.md:179: MD004 Unordered list style

A detailed description of the rules is available at https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md

Current Alternative

Using the bash sort function:

mdl README.md -r "~MD033,~MD013" | sort -V
@JayBeeDe JayBeeDe added the enhancement New feature or request label Jun 3, 2022
@jaymzh
Copy link
Member

jaymzh commented Jun 8, 2022

Seems reasonable. I'd accept a PR for that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants