Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: use markdownlint-cli2 directly for linting Markdown #608

Merged
merged 1 commit into from
Aug 1, 2024

Conversation

dsanders11
Copy link
Member

electron-markdownlint will be removed in v3 of @electron/lint-roller, and using markdownlint-cli2 allows our custom rules to be used by the markdownlint VS Code extension.

This also flips on some of the custom rules we turned on for e/e regarding the MDX 3 transition, to ensure going forward that the blog posts don't have any syntax trouble. Required updating some of the blog posts to fix newlines in link text - nothing was broken since the Docusaurus bug that avoids only affects relative links, but the custom rule is generic so it catches all cases.

@dsanders11 dsanders11 requested review from a team as code owners August 1, 2024 19:27
@MarshallOfSound MarshallOfSound temporarily deployed to electronjsorg-new-pr-608 August 1, 2024 19:28 Inactive
@dsanders11
Copy link
Member Author

Blog link check failure is from touching old blog posts.

Copy link
Member

@erickzhao erickzhao left a comment

Choose a reason for hiding this comment

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

@dsanders11
Copy link
Member Author

To clarify, we're going to migrate https://github.com/electron/lint-roller/blob/e392deea117053b81f962423e0a0033cfbb9754f/bin/markdownlint-cli-wrapper.ts to markdownlint-cli2 as well?

That file will be removed in v3, this is migrating ahead of time. That file was only necessary as an easy way to inject the custom rules instead of forcing users of electron-markdownlint to use a CLI option to add them. markdownlint-cli2 supports the customRules field in the config file itself. I can actually probably push that up into the default config now (haven't looked at it yet).

@dsanders11 dsanders11 merged commit f6192d5 into main Aug 1, 2024
4 of 5 checks passed
@dsanders11 dsanders11 deleted the chore/use-markdownlint-cli2 branch August 1, 2024 21:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants