Use multiple markdownlint.yaml /versions and /schemas #115
Conversation
| MD024: false # duplicate headings | ||
| MD032: false # blanks-around-lists Lists should be surrounded by blank lines | ||
| MD033: false # inline HTML | ||
| MD047: false # single-trailing-newline Files should end with a single newline character |
There was a problem hiding this comment.
Rules 32 and 47 are disabled because they didn't pass. We can enable them again and format the file if that is what we desire.
There was a problem hiding this comment.
Yes, please use the same rules for all *.md files and change the files that don't follow the rules yet.
There was a problem hiding this comment.
I'm not sure I agree that the same rules apply for specification documents and our internal project documentation in markdown files. I think we already rejected a pull request that applied the same standards to both - We need to be strict and careful with the documents that are published, I'm not sure the same applies if people are adding different content types.
There was a problem hiding this comment.
HI @ralfhandl , I am not against in what you are proposing but @lornajane is right about the rejected PR. Please check #105
There was a problem hiding this comment.
Given that the commented-out rules are trivial to observe, I'd use the same rules.
The more interesting case will be when we make the rules for new spec documents stricter and will need different rule sets for files in the versions folder, as we already do for OAS.
There was a problem hiding this comment.
@ralfhandl Ok. But what this means for the other comments that you made? Such as #115 (comment)
To be more precise, are we keeping the multiple lint configs or are we using a single one?
There was a problem hiding this comment.
I prefer keeping a single rule file and adjusting all Markdown files across all folders accordingly.
Actually we'd like to apply the same rules to all Markdown files in this repository, including the ones in the repository root. |
| MD024: false # duplicate headings | ||
| MD032: false # blanks-around-lists Lists should be surrounded by blank lines | ||
| MD033: false # inline HTML | ||
| MD047: false # single-trailing-newline Files should end with a single newline character |
There was a problem hiding this comment.
Yes, please use the same rules for all *.md files and change the files that don't follow the rules yet.
| CONFIG="" | ||
|
|
||
| while [[ $# -gt 0 ]]; do | ||
| case $1 in | ||
| --config) | ||
| CONFIG="$2" | ||
| shift # Remove --config from processing | ||
| shift # Remove the value from processing | ||
| ;; | ||
| *) | ||
| FILES+="$1 " | ||
| shift # Move to the next argument | ||
| ;; | ||
| esac | ||
| done | ||
|
|
||
| if [ -z "$CONFIG" ]; then | ||
| echo "Error: --config parameter is required." | ||
| exit 1 | ||
| fi | ||
|
|
||
| for filename in $FILES; do |
There was a problem hiding this comment.
Not necessary, same rules for all files
There was a problem hiding this comment.
Please move back to root folder
Closes: #104
Here it was decided to use different markdownlint.yaml files for
/schemasand/versionssince they have different purposes and as such, different standards.What this PR introduces:
markdownlint.yamlexist in each folder,/versionsand/schemas. Sub-folder linting seems to be supported by most plugins. See Differentiated config based on path DavidAnson/vscode-markdownlint#280format-markdown.shrequires now a--configparameter since now the config is not in a single place.package.jsonto use the same namespaces.