Prettier + Husky linting #377
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
marceljay
force-pushed
the
add-husky-linting
branch
from
7cc73a6
to
620bdd8
Compare
marceljay
force-pushed
the
add-husky-linting
branch
from
620bdd8
to
6c34fc3
Compare
For better formatting and clean commits, we want pre-commit hooks via husky. Lint-staged is added and prettier updated.
marceljay
force-pushed
the
add-husky-linting
branch
from
6c34fc3
to
5fe1fe9
Compare
Running prettier would cause a lot of errors. The ignore settings are used so that no more errors occur on existing files. This can be corrected later, by either coming up with override rules or fixing the issues one-by-one.
Lint-staged works on the git staging files. Postinstall is executed after `yarn install` setting up husky.
marceljay
force-pushed
the
add-husky-linting
branch
from
5fe1fe9
to
db6b127
Compare
This will make sure the commit linted according to conventional commits which have been adopted after discussion. See `docs/coding-standards.md`. If commits contain the string 'WIP' they will be ignored and bypass the commit linting.
marceljay
force-pushed
the
add-husky-linting
branch
from
a0cf6f2
to
37fb783
Compare
asimpk
approved these changes
Aug 16, 2023
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.
Setting the stage for pre-commit hooks.
This means that now with a yarn install, husky will be installed which is a tool to execute commands before
git commit.Along with that is installed
lint-stagedwhich makes sure only files in the staging environment are "linted" (even though ESLint isn't used yet).The PR also updates Prettier and sets rules that are somewhat basic, but because even they would cause issues, a lot of directories are excluded so far. This must be addressed soon, because effectively, prettier isn't doing much now. But at least new files or existing dirs that are not ignored have to follow the rules.
The PR also introduces checks for conventional commit linting.