Add pre-commit website lints

precice / aste

Artificial Solver Testing Environment

GNU General Public License v3.0

10 stars 11 forks source link

Add pre-commit website lints #183

Closed fsimonis closed 3 months ago

fsimonis commented 4 months ago

Main changes of this PR

This PR adds lints for the website integration via pre-commit. The image name check is a safeguard for possible future images. The mardown lint is a port of the existing workflow.

Author's checklist

[x] I used the pre-commit hook and used pre-commit run --all to apply all available hooks.
[ ] I added a test to cover the proposed changes in our test suite.

davidscn commented 1 month ago

@fsimonis does pre-commit run --all indeed work for you. The pre-commit added here doesn't work for me, but it could be an issue with my local markdown pre-commit.

fsimonis commented 1 month ago

Tried locally again and it works for me :tm:.

run --all doesn't pick up untracked files though. So make sure to git add them first.

Removing a bash from a code fence in the readme results in:

$ pre-commit run -va markdownlint
markdownlint.............................................................Failed
- hook id: markdownlint
- duration: 0.12s
- exit code: 1

docs/README.md:320 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]