chore: introduce @eslint/markdown and eslint-plugin-markdown-preferences
#2913
Conversation
|
| export default typegen([ | ||
| { | ||
| ignores: [ | ||
| '.nyc_output', | ||
| 'coverage', | ||
| 'node_modules', | ||
| '.changeset/**/*.md', |
There was a problem hiding this comment.
Why are those files ignored completely?
There was a problem hiding this comment.
Those markdown files are often created on GitHub, and I think it would be annoying if the created Markdown files would result in errors due to CI.
Even if there are problems with those markdown files, they will eventually be merged into the CHANGELOG and the CHANGELOG will be checked by CI, so I don't think the problems will remain.
There was a problem hiding this comment.
But the release notes on GitHub are created from exactly those Markdown files, right? I think having the links is most helpful there, so people can quickly jump into the relevant documentation pages when they see a new release.
There was a problem hiding this comment.
Links from rule names will be created automatically.
Take a look at the following PR.
ota-meshi/eslint-plugin-markdown-preferences#35
The changeset file only lists the rule name and not the link, but ESLint's autofix will automatically change the rule name to a link during the release workflow.
This will be used for changelogs and release notes.
There was a problem hiding this comment.
@ota-meshi Unfortunately, that seems to not work:
After merging #2918, the Release job failed with an ESLint error:
/home/runner/work/eslint-plugin-vue/eslint-plugin-vue/CHANGELOG.md
Error: 13:11 error The word "vue/define-macros-order" should be a link markdown-preferences/prefer-linked-words
✖ 1 problem (1 error, 0 warnings)
1 error and 0 warnings potentially fixable with the `--fix` option.
Error: Error: The process '/usr/local/bin/npm' failed with exit code 1
Error: The process '/usr/local/bin/npm' failed with exit code 1
And thus, the commit (and following ones) never made it to the Version Packages PR.
There was a problem hiding this comment.
Oh, npm run lint -- --fix won't work. Instead, we need to use npm run lint:fix.
I'll submit a PR for this.
There was a problem hiding this comment.
FloEdelmann
added
the
meta
This PR introduces
@eslint/markdownandeslint-plugin-markdown-preferencesto the repository.We prefer to have links in rule names in release notes and changelog, and this PR will allow the
markdown-preferences/prefer-linked-wordsrule to automatically detect and fix that.https://ota-meshi.github.io/eslint-plugin-markdown-preferences/rules/prefer-linked-words.html
After merging this PR, I believe the
changeset:versionscript should automatically include the link without having to include it in the changeset file.