diff options
| author | Valentin Popov <info@valentineus.link> | 2020-03-26 20:44:40 +0300 |
|---|---|---|
| committer | Valentin Popov <info@valentineus.link> | 2020-03-26 20:44:40 +0300 |
| commit | a03e6513cbc252daff5874bd028cb470690c5bc8 (patch) | |
| tree | e95a105c8af8fd5e5a3d14c5397c22a393e2526f | |
| parent | 78586ee73c94168978b4567c8692fd3172e7400d (diff) | |
| download | eslint-config-a03e6513cbc252daff5874bd028cb470690c5bc8.tar.xz eslint-config-a03e6513cbc252daff5874bd028cb470690c5bc8.zip | |
feat(project): Updated "README.md"
Signed-off-by: Valentin Popov <info@valentineus.link>
| -rw-r--r-- | README.md | 55 |
1 files changed, 55 insertions, 0 deletions
@@ -1 +1,56 @@ # Personal ESLint configuration + +## Configurations + +* `javascript` +* `typescript` +* `vue-javascript` +* `vue-typescript` + +## Example + +* Install dependencies: + +```shell script +npm install --save-dev @typescript-eslint/eslint-plugin @typescript-eslint/parser \ + @valentineus/eslint-config eslint eslint-plugin-eslint-comments \ + eslint-plugin-import eslint-plugin-security eslint-plugin-sonarjs \ + eslint-plugin-unicorn eslint-plugin-vue + +# or +yarn add --dev @typescript-eslint/eslint-plugin @typescript-eslint/parser \ + @valentineus/eslint-config eslint eslint-plugin-eslint-comments \ + eslint-plugin-import eslint-plugin-security eslint-plugin-sonarjs \ + eslint-plugin-unicorn eslint-plugin-vue +``` + +* Create config file: + +```json +{ + "env": { + "browser": true, + "es6": true + }, + "extends": [ + "@valentineus/eslint-config/vue-typescript" + ], + "globals": { + "Atomics": "readonly", + "SharedArrayBuffer": "readonly" + }, + "parserOptions": { + "createDefaultProgram": true, + "ecmaVersion": 2020, + "project": "tsconfig.json", + "sourceType": "module", + "tsconfigRootDir": "." + }, + "rules": {} +} +``` + +## License + +[Apache-2.0](LICENSE.txt). +Copyright (c) [Valentin Popov](mailto:info@valentineus.link). |