Skip to content

Commit eff7a08

Browse files
committed
docs: v8 update
1 parent f5b5c33 commit eff7a08

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

docs/README.md

+14-14
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ You can use it to **lint your commit messages**, **run tests**, **lint code**, e
1010

1111
- Zero dependencies and lightweight (`6 kB`)
1212
- Powered by modern new Git feature (`core.hooksPath`)
13-
- Follows [npm](https://docs.npmjs.com/cli/v7/using-npm/scripts#best-practices) and [Yarn](https://yarnpkg.com/advanced/lifecycle-scripts#a-note-about-postinstall) best practices regarding autoinstall
13+
- Follows [npm](https://docs.npmjs.com/cli/v8/using-npm/scripts#best-practices) and [Yarn](https://yarnpkg.com/advanced/lifecycle-scripts#a-note-about-postinstall) best practices regarding autoinstall
1414
- User-friendly messages
1515
- Optional install
1616
- __Like husky 4, supports__
@@ -21,7 +21,7 @@ You can use it to **lint your commit messages**, **run tests**, **lint code**, e
2121

2222
# Used by
2323

24-
The new husky is used by these awesome projects:
24+
Husky is used by these awesome projects:
2525

2626
- [webpack/webpack](https://github.com/webpack/webpack)
2727
- [angular/angular](https://github.com/angular/angular)
@@ -54,7 +54,7 @@ The new husky is used by these awesome projects:
5454

5555
# Usage
5656

57-
Already using husky? See [Migrate from 4 to 7](/?id=migrate-from-v4-to-v7).
57+
Already using husky? See [Migrate from 4 to 8](/?id=migrate-from-v4-to-v8).
5858

5959
## Automatic (recommended)
6060

@@ -63,7 +63,7 @@ Already using husky? See [Migrate from 4 to 7](/?id=migrate-from-v4-to-v7).
6363
```shell
6464
npx husky-init && npm install # npm
6565
npx husky-init && yarn # Yarn 1
66-
yarn dlx husky-init --yarn2 && yarn # Yarn 2
66+
yarn dlx husky-init --yarn2 && yarn # Yarn 2+
6767
pnpm dlx husky-init && pnpm install # pnpm
6868
```
6969

@@ -112,7 +112,7 @@ You should have:
112112
}
113113
```
114114

115-
!> **Yarn 2 doesn't support `prepare` lifecycle script, so husky needs to be installed differently (this doesn't apply to Yarn 1 though). See [Yarn 2 install](/?id=yarn-2).**
115+
!> **Yarn 2+ doesn't support `prepare` lifecycle script, so husky needs to be installed differently (this doesn't apply to Yarn 1 though). See [Yarn 2+ install](/?id=yarn-2).**
116116

117117
### Create a hook
118118

@@ -290,7 +290,7 @@ Or make `prepare` script fail silently if husky is not installed:
290290

291291
### With env variables
292292

293-
You can set `HUSKY` environment variable to `0` in your CI config file, to disable all hooks.
293+
You can set `HUSKY` environment variable to `0` in your CI config file, to disable hooks installation.
294294

295295
Alternatively, most Continuous Integration Servers set a `CI` environment variable. You can use it in your hooks to detect if it's running in a CI.
296296

@@ -417,16 +417,16 @@ yarn ...
417417

418418
Environment variables:
419419

420-
- `HUSKY_SKIP_HOOKS` becomes `HUSKY`.
421-
- `HUSKY_SKIP_INSTALL` is removed.
420+
- `HUSKY_SKIP_HOOKS` is replaced by `HUSKY`.
421+
- `HUSKY_SKIP_INSTALL` is replaced by `HUSKY`.
422422
- `HUSKY_GIT_PARAMS` is removed. Instead Git parameters should be used directly in scripts (e.g. `$1`).
423423
- `PATH` for locally installed tools is not automatically set anymore. You'll need to use your package manager to run them.
424424

425-
# Migrate from v4 to v7
425+
# Migrate from v4 to v8
426426

427-
## husky-4-to-7 CLI
427+
## husky-4-to-8 CLI
428428

429-
See [husky-4-to-7](https://github.com/typicode/husky-4-to-7) CLI to quickly migrate from v4 to v7.
429+
See [husky-4-to-8](https://github.com/typicode/husky-4-to-8) CLI to quickly migrate from v4 to v8.
430430

431431
## Package scripts
432432

@@ -442,7 +442,7 @@ If you were calling `package.json` scripts using `npm` or `yarn`, **you can simp
442442
```
443443

444444
```shell
445-
# .husky/pre-commit (v7)
445+
# .husky/pre-commit (v8)
446446
# ...
447447
npm test
448448
npm run foo
@@ -462,7 +462,7 @@ If you were calling directly locally installed binaries, **you need to run them
462462
```
463463

464464
```shell
465-
# .husky/pre-commit (v7)
465+
# .husky/pre-commit (v8)
466466
# ...
467467
npx --no jest
468468
# or
@@ -483,7 +483,7 @@ Previous `HUSKY_GIT_PARAMS` environment variable is replaced by native params `$
483483
```
484484

485485
```shell
486-
# .husky/commit-msg (v7)
486+
# .husky/commit-msg (v8)
487487
# ...
488488
npx --no commitlint --edit $1
489489
# or

0 commit comments

Comments
 (0)