UNPKG

1.13 kBMarkdownView Raw
1# @gjv/eslint-config-typescript
2
3[![npm version](https://badgen.net/npm/v/@gjv/eslint-config-typescript)](https://www.npmjs.com/package/@gjv/eslint-config-typescript)
4[![install size](https://badgen.net/packagephobia/install/@gjv/eslint-config-typescript)](https://packagephobia.com/result?p=%40gjv%2Feslint-config-typescript)
5[![publish size](https://badgen.net/packagephobia/publish/@gjv/eslint-config-typescript)](https://packagephobia.com/result?p=%40gjv%2Feslint-config-typescript)
6
7This package provides gjv's base Typescript .eslintrc (without React plugins) as an extensible shared config.
8
9Inspired by [Airbnb's Javascript Styleguide](https://github.com/airbnb/javascript)
10
11## Usage
12
13Our default export contains all of our ESLint rules, including ECMAScript 6+.
14
151. Install the correct versions of each peer dependency, which are listed by the command:
16
17 ```sh
18 npm info "@gjv/eslint-config-typescript" peerDependencies
19 ```
20
21 If using **npm 5+**, use this shortcut
22
23 ```sh
24 npx install-peerdeps --dev @gjv/eslint-config-typescript
25 ```
26
272. Add `"extends": "@gjv/eslint-config-typescript"` to your .eslintrc.
28
\No newline at end of file