starred/markdownlint

Fork 0

mirror of https://github.com/DavidAnson/markdownlint.git synced 2026-04-25 01:05:55 +03:00

[GH-ISSUE #83] Split rules into their own files? #1915

New issue

Closed

opened 2026-03-07 20:02:44 +03:00 by kerem · 7 comments

kerem commented

2026-03-07 20:02:44 +03:00

Owner

Originally created by @JoshuaKGoldberg on GitHub (Oct 22, 2017).
Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/83

https://github.com/DavidAnson/markdownlint/blob/master/lib/rules.js is huge. It would be easier to develop if the rules were in their own files.

Originally created by @JoshuaKGoldberg on GitHub (Oct 22, 2017). Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/83 https://github.com/DavidAnson/markdownlint/blob/master/lib/rules.js is huge. It would be easier to develop if the rules were in their own files.

kerem

2026-03-07 20:02:44 +03:00

closed this issue
added the
fixed in next

refactoring
labels

kerem commented

2026-03-07 20:02:45 +03:00

Author

Owner

@DavidAnson commented on GitHub (Oct 22, 2017):

See https://github.com/DavidAnson/markdownlint/issues/42 for some context. This has not been an issue yet, but will be naturally fixed when that’s supported.

@DavidAnson commented on GitHub (Oct 22, 2017): See https://github.com/DavidAnson/markdownlint/issues/42 for some context. This has not been an issue yet, but will be naturally fixed when that’s supported.

kerem commented

2026-03-07 20:02:45 +03:00

Author

Owner

@JoshuaKGoldberg commented on GitHub (Oct 23, 2017):

Would you be upset if I sent a PR?

@JoshuaKGoldberg commented on GitHub (Oct 23, 2017): Would you be upset if I sent a PR?

kerem commented

2026-03-07 20:02:45 +03:00

Author

Owner

@DavidAnson commented on GitHub (Oct 23, 2017):

I learn/remember a lot by revisiting the complete set of rules regularly in the process of maintaining things and find it convenient to search across all rules at once. Similarly, it’s easy to share helper methods within the same file. Neither is a deal breaker, but I worry that a change like this would make my life harder without significant benefit to offset that.

@DavidAnson commented on GitHub (Oct 23, 2017): I learn/remember a lot by revisiting the complete set of rules regularly in the process of maintaining things and find it convenient to search across all rules at once. Similarly, it’s easy to share helper methods within the same file. Neither is a deal breaker, but I worry that a change like this would make my life harder without significant benefit to offset that.

kerem commented

2026-03-07 20:02:45 +03:00

Author

Owner

@braebot commented on GitHub (Oct 23, 2017):

I'm 👍 to splitting them up into separate files. I found it hard to read the existing rules with the current file structure.

@braebot commented on GitHub (Oct 23, 2017): I'm 👍 to splitting them up into separate files. I found it hard to read the existing rules with the current file structure.

kerem commented

2026-03-07 20:02:45 +03:00

Author

Owner

@JoshuaKGoldberg commented on GitHub (Oct 29, 2017):

I worry that a change like this would make my life harder without significant benefit to offset that.

Fun story: one of my early projects was something like 500 global constructs (functions, variables) across maybe a dozen files. It felt nice having things all together... but in actuality it became a huge unorganized mess of helper utilities thrown all over the place. Eventually it became impossible to work on because you'd need three tabs open of the same file, lint/compile rebuilds were horrendously slow, and I'd repeatedly get lost. markdownlint certainly isn't there (phew!) but I would be scared to slip down that path.

I'll send a PR for this and if you hate it, no worries. 😄

@JoshuaKGoldberg commented on GitHub (Oct 29, 2017): > I worry that a change like this would make my life harder without significant benefit to offset that. Fun story: one of my early projects was something like 500 global constructs (functions, variables) across maybe a dozen files. It felt nice having things all together... but in actuality it became a huge unorganized mess of helper utilities thrown all over the place. Eventually it became impossible to work on because you'd need three tabs open of the same file, lint/compile rebuilds were horrendously slow, and I'd repeatedly get lost. markdownlint certainly isn't there (phew!) but I would be scared to slip down that path. I'll send a PR for this and if you hate it, no worries. 😄

kerem commented

2026-03-07 20:02:46 +03:00

Author

Owner

@JoshuaKGoldberg commented on GitHub (Jan 16, 2018):

Re the PR: I ended up not having time to dig into the coverage failures. Issue's still open!

@JoshuaKGoldberg commented on GitHub (Jan 16, 2018): Re the PR: I ended up not having time to dig into the coverage failures. Issue's still open!

kerem commented

2026-03-07 20:02:46 +03:00

Author

Owner

@DavidAnson commented on GitHub (Jan 17, 2018):

It should happen as part of my refactoring to support custom rules.

@DavidAnson commented on GitHub (Jan 17, 2018): It should happen as part of my refactoring to support custom rules.

kerem referenced this issue

2026-03-07 20:09:29 +03:00

[GH-ISSUE #1915] MD046: enable parsing/linting of over-indented blocks when set to fenced style #2628