We prefer to have links in rule names in release notes and changelog, and this PR will allow themarkdown-preferences/prefer-linked-words rule 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 thechangeset:version script should automatically include the link without having to include it in the changeset file.

ota-meshi added2 commits

August 3, 2025 21:29

chore: introduce@eslint/markdown and `eslint-plugin-markdown-prefe…

acfde8f

…rences`

remove unnecessary file

9a4809d

Copy link

changeset-botbot commentedAug 3, 2025•
edited
Loading

⚠️ No Changeset found

Latest commit:e062b27

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go.If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

FloEdelmann reviewed

Aug 4, 2025

View reviewed changes

Copy link

Member

FloEdelmann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Very nice improvement, thank you! 🙂

eslint.config.mjs OutdatedShow resolvedHide resolved

eslint.config.mjs

		'.nyc_output',
		'coverage',
		'node_modules',
		'.changeset/*/.md',

Copy link

Member

FloEdelmannAug 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Why are those files ignored completely?

Copy link

MemberAuthor

ota-meshiAug 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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.

Copy link

Member

FloEdelmannAug 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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.

Copy link

MemberAuthor

ota-meshiAug 5, 2025•
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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.

Copy link

Member

FloEdelmannAug 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Ah, cool!

Copy link

Member

FloEdelmannSep 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

@ota-meshi Unfortunately, that seems to not work:

After merging#2918, theRelease job failed with an ESLint error:

/home/runner/work/eslint-plugin-vue/eslint-plugin-vue/CHANGELOG.mdError:   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 1Error: The process '/usr/local/bin/npm' failed with exit code 1

And thus, the commit (and following ones) never made it to theVersion Packages PR.