Introduce lint job in CI #277
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit adds a lint job to the CI pipeline. It uses an up to date Markdown linter https://github.com/DavidAnson/markdownlint-cli2. I looked for an alternative from the Python ecosystem (to stay more consistent with this project), but the only result was an outdated and unmaintained project. It would be possible to add a `make format` command as was suggested in the original GitHub issue, but this would require Node.js to be available in the dev environment, so I thought setting up CI only would be good enough for now. Note: it should be as easy as adding the following to the Makefile: ``` format: npx markdownlint-cli2-fix "**/*.md" ``` Closes openfisca#267
Switch CLI package since markdownlint-cli2-fix is not available over NPM
There is no native Markdown alternative for abbreviations
Unify `python` language code to `py`
Most frequently used in the existing documentation base
Triggered a linting error
MattiSG
approved these changes
Nov 3, 2022
There was a problem hiding this comment.
Thank you very much @RobinCsl! I handled all detected Markdown errors and added a bit of documentation in the README on how to use the commands make lint and make format.
Thank you for having implemented two separate jobs in CI, this really adds to the readability of the feedback 👍 I will proceed with making the lint job mandatory as well 🙂
Thanks for the hint! I tried to implement it this way but had to switch to |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Introduce lint job in CI
This commit adds a lint job to the CI pipeline. It uses an up
to date Markdown linter https://github.com/DavidAnson/markdownlint-cli2.
I looked for an alternative from the Python ecosystem (to stay
more consistent with this project), but the only result was an
outdated and unmaintained project.
It would be possible to add a
make formatcommand as wassuggested in the original GitHub issue, but this would require
Node.js to be available in the dev environment, so I thought
setting up CI only would be good enough for now.
Note: it should be as easy as adding the following to the Makefile:
Closes #267