Comments (3)
Makes total sense. Will think about this more and look into it soon! Much appreciated. :)
from markdownlint.
On the subject of custom rule errors, it would be useful if configurable rules stated the config in their error message. For example, I just got these CI errors on some doc updates for eslint:
docs/rules/sort-imports.md: 164: MD004 Unordered list style
docs/rules/sort-imports.md: 37: MD007 Unordered list indentation
I had to search build scripts to work out what params had been sent to the linter, for example how many spaces should be used for list indentation? It would save time if errors looked like this:
docs/rules/sort-imports.md: 164: MD004 Use {asterisk} style for unordered lists
docs/rules/sort-imports.md: 37: MD007 Use {4} spaces when indenting lists
That will enable me, and others, to see at a glance what needs changing to fix an error.
from markdownlint.
This ended up being a bigger task than I expected, but I think it's a significant improvement, thanks for suggesting it!
PS - I did not implement a guidance message because it seems like configuration/process that will be handled differently by various projects (documentation, output message, code comment, etc.).
from markdownlint.
Related Issues (20)
- (MD033 - Inline HTML)
- SRockt HOT 1
- Ignore long lines in HTML comments HOT 3
- MD044: Proper name matched in Hugo-style relref links HOT 7
- MD025 Multiple top-level headings with`title` frontmatter HOT 1
- MD025: Support docfx tabs
- MD051: Support docfx tabs HOT 1
- Store rule config in editorconfig compatible files HOT 5
- ignore a rule for a specific file in the general configuration
- Question: New MD051 warnings upgrading from v14 to v15 HOT 4
- Commit f272517 is a breaking change to 0.33.0 (Update MD024/no-duplicate-heading to remove duplicate parameter allow…) HOT 2
- MD055/56 Don't properly handle pipes in content HOT 4
- MD013: can I set blockquote line length? HOT 5
- MD029: Ordered list with Note block HOT 1
- The rule "MD050 - Strong style" should show problems in a file, but does not. HOT 3
- MD029: any interest in zero_one_or_ordered? HOT 9
- MD013 : Issue with MarkdownLint Configuration Ignoring Line Length Exceeding 80 Words HOT 3
- Customizing plugins, other options with VSCode extension HOT 2
- MD034: Email autolink with incomplete domain in angle brackets incorrectly reported as a violation HOT 2
- MD050 Regression HOT 4
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from markdownlint.