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
Add markdown linting #3990
Add markdown linting #3990
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This setup only runs in CI. I think we should be able to run locally too. I think remark
might offer a better toolchain but I'm ok with anything I can run locally as well.
(In Node.js TSC we use https://github.com/nodejs/TSC/blob/main/package.json#L7)
Co-authored-by: Frazer Smith <frazer.dev@outlook.com>
Co-authored-by: Frazer Smith <frazer.dev@outlook.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
Co-authored-by: Frazer Smith <frazer.dev@outlook.com>
Had to remove it as a Required workflow from the |
It's a really basic implementation. It should really be implemented as "do markdown changes exist? yes: run check, no: return green". |
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
This PR adds a workflow that will check the line length within Markdown documents in this project. It's possible we could migrate this to the common workflows repo, but I'm not clear if that is possible given how the tools in this workflow work. Anyone is welcome to do their own testing and move it if they determine it viable.
See https://github.com/stupid-org/md-lint/pull/1/files for an example of what a failed check looks like.
Checklist
npm run test
andnpm run benchmark
and the Code of conduct