Skip to content

Commit 6ce2fc7

Browse files
committed
clarify app README setup notes
1 parent 88b485c commit 6ce2fc7

File tree

1 file changed

+8
-10
lines changed
  • examples/with-typescript-eslint-jest

1 file changed

+8
-10
lines changed

examples/with-typescript-eslint-jest/README.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -51,19 +51,21 @@ Deploy it to the cloud with [ZEIT Now](https://zeit.co/import?filter=next.js&utm
5151

5252
### Notes
5353

54+
#### NodeJS Version
55+
56+
This package has an .nvmrc version pinning NodeJS to 12.14.1. Feel free to remove or change it.
57+
5458
#### Setup
5559

56-
After bootstrapping your next.js app, there are several steps to enable Husky (for pre-commit and push linting) and Eslint's Prettier config which cause conflicts with the next.js monorepo.
60+
After bootstrapping your next.js app, there are several steps to enable Husky (for pre-commit and push linting) and Eslint's Prettier config. These steps must be performed manually due to conflicts with the linting and CI configuration of the next.js monorepo.
5761

58-
Eslint + Prettier:
62+
**Eslint + Prettier**
5963

6064
1. Install `eslint-config-prettier`: `yarn add -D eslint-config-prettier`
6165
2. Uncomment the `"prettier"` value from the `extends` key in `.eslintrc.json`
6266

63-
Husky:
64-
65-
1. Install `husky` and `lint-staged`: `yarn add -D husky lint-staged`
66-
2. Add the following values to your `package.json` (or tweak your own):
67+
**Husky**
68+
Opt into husky commit hooks by adding the following values to your `package.json` (or tweak your own):
6769

6870
```json
6971
"husky": {
@@ -80,10 +82,6 @@ Husky:
8082
}
8183
```
8284

83-
#### NodeJS Version
84-
85-
This package has an .nvmrc version pinning NodeJS to 12.14.1. Feel free to remove or change it.
86-
8785
#### Bypassing git hooks
8886

8987
This app uses git hooks (via `husky`) on commit and push. You can temporarily bypass them (to ignore a typechecking error, for example) using the `--no-verify` flag, for example `git commit -am 'WIP: show user data on profile page' --no-verify`.

0 commit comments

Comments
 (0)