Skip to content

Commit 4ffbb28

Browse files
committedJan 2, 2018
updated linting docs.
1 parent 16aed01 commit 4ffbb28

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed
 

‎docs/linter.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22

33
This boilerplate uses [ESLint](https://eslint.org/) as the linter, and uses the [Standard](https://github.com/feross/standard/blob/master/RULES.md) preset with some small customizations.
44

5+
## eslint-plugin-vue
6+
7+
We always add [eslint-plugin-vue](https://github.com/vuejs/eslint-plugin-vue) as well, which comes with a whole bunch of helpful rules to write consistent Vue components - it can also lint templates!
8+
9+
You can find an overview of all the available rules on [github](https://github.com/vuejs/eslint-plugin-vue#gear-configs). We chose to add the `essential` configs, but we recommend to switch to the bigger `strongly-recommended` or `recommended` rulesets once you are familiar with them.
10+
11+
## Customizing
12+
513
If you are not happy with the default linting rules, you have several options:
614

715
1. Overwrite individual rules in `.eslintrc.js`. For example, you can add the following rule to enforce semicolons instead of omitting them:
@@ -23,5 +31,5 @@ You can run the following command to let eslint fix any errors it finds (if it c
2331
npm run lint -- --fix
2432
```
2533

26-
*(The `--` in the middle is necessary to ensure the `--fix` option is passdd to `eslint`, not to `npm`)*
34+
*(The `--` in the middle is necessary to ensure the `--fix` option is passdd to `eslint`, not to `npm`. It can be omitted whne using yarn)*
2735

0 commit comments

Comments
 (0)
Please sign in to comment.