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 a linter/formatter #5

Open
Ethan-Arrowood opened this issue Sep 13, 2023 · 1 comment
Open

Add a linter/formatter #5

Ethan-Arrowood opened this issue Sep 13, 2023 · 1 comment

Comments

@Ethan-Arrowood
Copy link
Collaborator

Let's get some automated consistency from the beginning. I'd like to add a markdown linter that has a reasonable set of rules. I don't want to bikeshed config options so preference for something equivalent to Prettier that makes the decision for us.

The linter/formatter should run on commit (lets use husky + lint-staged).

There should be a GitHub Action that runs the linter/formatter and blocks the PR from being merged until it is passing.

@ljharb
Copy link
Member

ljharb commented Sep 13, 2023

Please do not use husky; git hooks are bypassable, slow, and tools like husky can cause security issues by installing the hooks in the wrong repo. Markdown linting can be configured through eslint, and then preexisting editor integrations can handle it.

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

No branches or pull requests

2 participants