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

Add pre-commit website lints #183

Merged
merged 3 commits into from
Mar 20, 2024
Merged

Conversation

fsimonis
Copy link
Member

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

  • 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 davidscn merged commit be16562 into develop Mar 20, 2024
2 checks passed
@davidscn davidscn deleted the add-pre-commit-website-lints branch March 20, 2024 15:43
@davidscn
Copy link
Member

davidscn commented Jun 7, 2024

@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
Copy link
Member Author

fsimonis commented Jun 7, 2024

Tried locally again and it works for me ™️.

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: "```"]

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.

2 participants