Enforce eslint and prettier rules with a pre-commit hook #10
Conversation
This file contains hidden or 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
samholmes
requested changes
Aug 13, 2024
| @@ -8,7 +8,8 @@ | |||
| "build": "next build", | |||
| "start": "next start", | |||
| "lint": "next lint", | |||
| "format": "prettier --write ." | |||
| "format": "prettier --write .", | |||
There was a problem hiding this comment.
I prefer to use the prettier ESLint plugin for formatting so that way eslint --fix applies the linting fixes in addition to the formatting errors all in one go. A dev can use an eslint IDE integration to get auto formatting and linting fixes on file save.
Comment on lines
+3
to
+14
| const communityDescription = ` | ||
| We're a community of developers of all skill levels, dedicated to fostering a fun and | ||
| educational environment. Hosted by Sam Holmes and a team of passionate organizers, our | ||
| monthly meetups offer an opportunity to network, learn, and showcase your projects. At | ||
| each event, you'll enjoy complimentary food and drinks during our networking lunch, | ||
| followed by a series of engaging presentations on various developer and engineering | ||
| topics. After the talks, we break into groups for casual networking, project showcases, | ||
| and coding help. Whether you're a seasoned developer or just starting out, there's | ||
| something for everyone. Be sure to bring your laptop if you'd like to share your latest | ||
| project or give a presentation. We look forward to meeting you and seeing what you're | ||
| excited about! | ||
| ` |
There was a problem hiding this comment.
I think I resolved this same issue in my PR, but instead of factoring out the string, I kept it inline. That'd be preferable since this consts is single-use.
.eslintrc.json
Outdated
Comment on lines
3
to
5
| "rules": { | ||
| "@next/next/no-img-element": "off" | ||
| } |
There was a problem hiding this comment.
This is useful to remove the warnings.
Comment on lines
+5
to
+10
| "import/no-anonymous-default-export": [ | ||
| "warn", | ||
| { | ||
| "allowObject": true | ||
| } | ||
| ] |
There was a problem hiding this comment.
I'm unsure what this fixes.
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.
Dsecription
Adds a pre-commit hook using husky that auto-fixes eslint errors and prettifies staged files in case a contributer does not have their IDE configured to run those actions on save.
When Commits Fail
This may occasionally cause a commit to fail when the eslint problem is not auto-fixable.
Usually this is because of an important web standard violation, such as a missing
altdescription on an<img />tag. In these cases, simply clean up the problem, add the change to staging, and re-commit.If the error is more involved or less useful, consider turning off the associated eslint rule in
.eslintrc.json, like so:If you absolutely need to make a commit, linting be damned, you can add the
--no-verifyoption to yourgit commitcommand. Because this is possible, linting enforcement can possibly be moved to CI once a deployment pipeline has been established.Other Changes
This also cleans up some eslint errors/warnings concerning missing alt tags and unescaped html entities.