Skip to content

Commit 8ec1275

Browse files
committed
wording
1 parent 21223af commit 8ec1275

File tree

2 files changed

+6
-9
lines changed

2 files changed

+6
-9
lines changed

docs/get-started.md

+5-8
Original file line numberDiff line numberDiff line change
@@ -59,25 +59,22 @@ git commit -m "Keep calm and commit"
5959
# test script will run every time you commit
6060
```
6161

62-
## A few words
62+
## A few words...
6363

6464
### Scripting
6565

66-
While most of the time, you'll just run a few `npm run` or `npx` commands in your hooks, you can also script hooks using POSIX shell for custom workflows.
66+
While most of the time, you'll just run a few `npm run` or `npx` commands in your hooks, you can also script them using POSIX shell for custom workflows.
6767

68-
For example, here's how you can lint your staged files on each commit with only two lines of shell code:
68+
For example, here's how you can lint your staged files on each commit with only two lines of shell code and no external dependency:
6969

7070
```shell
7171
# .husky/pre-commit
7272
prettier $(git diff --cached --name-only --diff-filter=ACMR | sed 's| |\\ |g') --write --ignore-unknown
7373
git update-index --again
7474
```
7575

76-
See also [lint-staged](https://github.com/lint-staged/lint-staged) if you need more.
76+
_This is a basic but workinkg example, check [lint-staged](https://github.com/lint-staged/lint-staged) if you need more._
7777

7878
### Disabling hooks
7979

80-
Husky doesn't force Git hooks and can be globally disabled if wished. They can be made opt-in as well.
81-
82-
_For manual setup and more information, see the [How To](how-to) section._
83-
80+
Husky doesn't force Git hooks. It can be globally disabled (`HUSKY=0`) or be opt-in if wanted. See the [How To](how-to) section for manual setup and more information.

index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,6 @@ export default (d = '.husky') => {
1818
w(_('.gitignore'), '*')
1919
f.copyFileSync(new URL('husky', import.meta.url), _('h'))
2020
l.forEach(h => w(_(h), `#!/usr/bin/env sh\n. "\${0%/*}/h"`, { mode: 0o755 }))
21-
w(_('husky.sh'), 'echo "husky - `#!/usr/bin/env sh` and `. "$(dirname -- "$0")/_/husky.sh"` lines in hooks are DEPRECATED and won\'t be supported in v10. You can remove these two lines safely for even simpler scripts"')
21+
w(_('husky.sh'), 'echo "husky - `#!/usr/bin/env sh` and `. "$(dirname -- "$0")/_/husky.sh"` lines in hooks are DEPRECATED and won\'t be supported in v10. You can remove these two lines for even simpler scripts"')
2222
return ''
2323
}

0 commit comments

Comments
 (0)