|
1 | 1 | # eslint-config-vue-tc |
2 | | -ESLint shareable config for Vue projects |
| 2 | + |
| 3 | +> ESLint [shareable config](http://eslint.org/docs/developer-guide/shareable-configs.html) for Vue projects |
| 4 | +
|
| 5 | +[](https://github.com/tclindner/eslint-config-vue-tc/blob/master/LICENSE) |
| 6 | +[](https://www.npmjs.com/package/eslint-config-vue-tc) |
| 7 | +[](https://circleci.com/gh/tclindner/eslint-config-vue-tc) |
| 8 | +[](https://david-dm.org/tclindner/eslint-config-vue-tc) |
| 9 | +[](https://david-dm.org/tclindner/eslint-config-vue-tc#info=devDependencies) |
| 10 | + |
| 11 | +## What is eslint-config-vue-tc? |
| 12 | + |
| 13 | +Shared configuration for ESLint. Follow the instructions below to easily include this configuration in another project without having to duplicate the file! |
| 14 | + |
| 15 | +# How do I install it? |
| 16 | + |
| 17 | +First thing first, let's make sure you have the necessary pre-requisites. |
| 18 | + |
| 19 | +### System Dependencies |
| 20 | + |
| 21 | +#### Node |
| 22 | + |
| 23 | +* [Node.js](https://nodejs.org/) - v8.0.0+ |
| 24 | +* [npm](http://npmjs.com) - v6.0.0+ |
| 25 | + |
| 26 | +### Command |
| 27 | + |
| 28 | +```bash |
| 29 | +npx install-peerdeps --dev eslint-config-vue-tc |
| 30 | +``` |
| 31 | + |
| 32 | +> eslint and eslint-plugin-vue are peer dependencies and must be installed. |
| 33 | +
|
| 34 | +**This module works best when paired with [`eslint-config-tc`](https://github.com/tclindner/eslint-config-tc). Please follow it's install instructions.** |
| 35 | + |
| 36 | +## Usage |
| 37 | + |
| 38 | +Add the following to your `.eslintrc.json` file: |
| 39 | + |
| 40 | +```json |
| 41 | +{ |
| 42 | + "extends": "eslint-config-vue-tc" |
| 43 | +} |
| 44 | +``` |
| 45 | + |
| 46 | +If you need to override a rule, your `.eslintrc.json` file should look like the example below. All shared rules will be used, but `vue/require-direct-export` will be turned off. |
| 47 | + |
| 48 | +```json |
| 49 | +{ |
| 50 | + "extends": "eslint-config-vue-tc", |
| 51 | + "rules": { |
| 52 | + "vue/require-direct-export": "off" |
| 53 | + } |
| 54 | +} |
| 55 | +``` |
| 56 | + |
| 57 | +## Related |
| 58 | + |
| 59 | +- [eslint-config-tc](https://github.com/tclindner/eslint-config-tc) - ESLint shareable config for JavaScript projects |
| 60 | + |
| 61 | +## Contributing |
| 62 | + |
| 63 | +Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information. |
| 64 | + |
| 65 | +## Change Log |
| 66 | + |
| 67 | +Please see the [CHANGELOG.md](CHANGELOG.md) for more information. |
| 68 | + |
| 69 | +## License |
| 70 | + |
| 71 | +Copyright (c) 2019 Thomas Lindner. Licensed under the MIT license. |
0 commit comments