-
Notifications
You must be signed in to change notification settings - Fork 54
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
Implement markdown and yaml linting, prepare eslint infrastructure #322
Implement markdown and yaml linting, prepare eslint infrastructure #322
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.
I love the idea of linting the code, but I'm not sure this approach is best for a JavaScript project?
We don't use shell, or go, or yaml.
And we should be linting the JS/TS with the eslint
package (and prettier
if we want to be extra robust). There's also a markdownlint-cli npm package we can use if we want to lint markdown.
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.
call me old fashioned but i have concerns about this tooling being part of my workflow.
there are so many lighter solutions inside the JS ecosystem that do not require docker to run :/
Yup, I get it. It was the easiest lift without investing too much time (as in like 5mins). This isn't required for someone to open a PR as it will check in the GH action but uses the same mechanism for both. If this is too much for the project to add, you can close this PR. |
This doesn't tackle any JS linting. |
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.
I hope you don't mind, but I didn't wanna just discard this entirely.
I pushed a commit to shift the runners into the JS ecosystem, and preserved the rules you configured. 💜
Doesn't matter. It's your work and code. |
This enables some linting/checks for Markdown, GH Action, YAML, and Shell Linting.
This introduces GitHub actions to check those things and allows users to check locally before submitting a PR. Running locally requires
docker
, but the user doesn't necessarily need to install or check manually before submitting a PR. To download all dependencies (iemake check
= run all lints, checks), they can runmake ensure-deps
to download all dependencies, tools, and etc.Addresses the following issues: #286 #285 #284
The updates to the Markdown are from the issues raised by the mdlint check.
If you don't feel this adds value to the project, feel free to close this PR and the issues as well.