-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #45 from guenaydin/adjustInstallationInstruction
add a missing option to add this package as a devDependencies
- Loading branch information
Showing
1 changed file
with
11 additions
and
11 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -25,7 +25,7 @@ This tool only needs your editorconfig to check all files. | |
Installation via npm/yarn is recommended: | ||
|
||
``` | ||
yarn add editorconfig-checker | ||
yarn add --dev editorconfig-checker | ||
./node_modules/.bin/editorconfig-checker | ||
npm install --save-dev editorconfig-checker | ||
|
@@ -40,7 +40,7 @@ Otherwise you could clone the repository and execute the script manually. | |
``` | ||
git clone [email protected]:editorconfig-checker/editorconfig-checker.javascript.git | ||
&& cd editorconfig-checker.javascript | ||
&& make setup | ||
&& make setup | ||
&& ./editorconfig-checker.javascript/dist/index | ||
``` | ||
|
||
|
@@ -57,15 +57,15 @@ Then you could create a script in your `package.json` like this: | |
|
||
To check multiple directories you could use it like this: | ||
|
||
```json | ||
```json | ||
"scripts": { | ||
"lint:editorconfig": "editorconfig-checker src someOhterDir anohterDir" | ||
} | ||
``` | ||
|
||
You could also use a glob to check your files: | ||
|
||
```json | ||
```json | ||
"scripts": { | ||
"lint:editorconfig": "editorconfig-checker ./src/{editorconfig,logger}/**/*" | ||
} | ||
|
@@ -84,7 +84,7 @@ because the special characters(e.g. `|`, `*`, `.` or whatever) will be interpret | |
Some examples: | ||
```sh | ||
# will filter all files with json extension | ||
editorconfig-checker --exclude-pattern './**/*.json' | ||
editorconfig-checker --exclude-pattern './**/*.json' | ||
editorconfig-checker --exclude-regexp '\\.json$' | ||
|
||
# will filter all files which has TestFiles in their name and json as extension | ||
|
@@ -93,14 +93,14 @@ editorconfig-checker --exclude-regexp 'TestFiles|\\.json$' | |
|
||
# will don't use default excludes and filter all files which has TestFiles in their name | ||
editorconfig-checker -i -d --exclude-pattern './**/*TestFiles*/*' | ||
editorconfig-checker --ignore-defaults --dotfiles --exclude-regexp 'TestFiles' | ||
editorconfig-checker --ignore-defaults --dotfiles --exclude-regexp 'TestFiles' | ||
``` | ||
|
||
If you just want to filter for one string you don't have to worry and if you want to filter for more strings you could also pass the `--exclude-regexp|--exclude-pattern` option more than once like this: | ||
|
||
```sh | ||
./node_modules/.bin/editorconfig-checker --exclude-regexp node_modules --exclude-regexp myBinary --exclude-regexp someGeneratedFile --exclude-regexp myPicture | ||
./node_modules/.bin/editorconfig-checker --exclude-pattern './node_modules/**' --exclude-pattern './myBinary' --exclude-pattern './dist/someGeneratedFile' --exclude-pattern './pictures/myPicture' | ||
./node_modules/.bin/editorconfig-checker --exclude-regexp node_modules --exclude-regexp myBinary --exclude-regexp someGeneratedFile --exclude-regexp myPicture | ||
./node_modules/.bin/editorconfig-checker --exclude-pattern './node_modules/**' --exclude-pattern './myBinary' --exclude-pattern './dist/someGeneratedFile' --exclude-pattern './pictures/myPicture' | ||
``` | ||
|
||
If you installed it manually you would have to do something like this: | ||
|
@@ -131,7 +131,7 @@ available options: | |
will print all files which are checked to stdout | ||
``` | ||
|
||
### Disabling single lines | ||
### Disabling single lines | ||
|
||
It is possible to disable single lines with placing a comment - or theoretically | ||
any other string which includes `editorconfig-disable-line` on that line. | ||
|
@@ -198,7 +198,7 @@ checked. | |
|
||
## Support | ||
|
||
If you have any questions or just want to chat join #editorconfig-checker on | ||
If you have any questions or just want to chat join #editorconfig-checker on | ||
freenode(IRC). | ||
If you don't have an IRC-client set up you can use the | ||
If you don't have an IRC-client set up you can use the | ||
[freenode webchat](https://webchat.freenode.net/?channels=editorconfig-checker). |