Skip to content

Commit 634344a

Browse files
zploskeyokonet
authored andcommitted
docs: Readme edits for spelling and grammar (lint-staged#480)
1 parent d52e074 commit 634344a

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The latest versions of `lint-staged` require Node.js v6 or newer. (Versions of `
66

77
## Why
88

9-
Linting makes more sense when running before committing your code. By doing that you can ensure no errors are going into repository and enforce code style. But running a lint process on a whole project is slow and linting results can be irrelevant. Ultimately you only want to lint files that will be committed.
9+
Linting makes more sense when run before committing your code. By doing so you can ensure no errors go into the repository and enforce code style. But running a lint process on a whole project is slow and linting results can be irrelevant. Ultimately you only want to lint files that will be committed.
1010

1111
This project contains a script that will run arbitrary shell tasks with a list of staged files as an argument, filtered by a specified glob pattern.
1212

@@ -39,7 +39,7 @@ This project contains a script that will run arbitrary shell tasks with a list o
3939

4040
Now change a few files, `git add` some of them to your commit and try to `git commit` them.
4141

42-
And this is how it looks like in action:
42+
This is how it looks in action:
4343

4444
<p align="center">
4545
<img src="./screenshots/lint-staged-prettier.gif" alt="lint-staged with prettier example"
@@ -78,7 +78,7 @@ $ ./node_modules/.bin/lint-staged --help
7878

7979
* **`--config [path]`**: This can be used to manually specify the `lint-staged` config file location. However, if the specified file cannot be found, it will error out instead of performing the usual search. You may pass a npm package name for configuration also.
8080
* **`--debug`**: Enabling the debug mode does the following:
81-
* `lint-staged` uses the [debug](https://github.com/visionmedia/debug) module internally to log information about staged files, commands being executed, location of binaries etc. Debug logs, which are automatically enabled by passing the flag, can also be enabled by setting the environment variable `$DEBUG` to `lint-staged*`.
81+
* `lint-staged` uses the [debug](https://github.com/visionmedia/debug) module internally to log information about staged files, commands being executed, location of binaries, etc. Debug logs, which are automatically enabled by passing the flag, can also be enabled by setting the environment variable `$DEBUG` to `lint-staged*`.
8282
* Use the [`verbose` renderer](https://github.com/SamVerschueren/listr-verbose-renderer) for `listr`.
8383
* Do not pass `--silent` to npm scripts.
8484

@@ -125,7 +125,7 @@ So, considering you did `git add file1.ext file2.ext`, lint-staged will run the
125125

126126
### Advanced config format
127127

128-
To extend and customise lint-staged, avanced options are available. To use this options the format should be as the following:
128+
To extend and customise lint-staged, advanced options are available. To use these options the format should be as the following:
129129

130130
#### `package.json` example with `ignore` option:
131131

0 commit comments

Comments
 (0)