eslint-config-mide-ts v1.0.3

eslint-config-mide-ts

This package provides Airbnb's .eslintrc with my personal preferences as an extensible shared config.

Usage

Default export contains all of ESLint rules, including ECMAScript 6+. It requires eslint, eslint-plugin-import, typescript, @typescript-eslint/eslint-plugin and @typescript-eslint/parser.

1. Install

Install the correct versions of each package, which are listed by the command:

npm info "eslint-config-mide-ts@latest" peerDependencies

If using npm 5+, use this shortcut

npx install-peerdeps --dev eslint-config-mide-ts

If using yarn, you can also use the shortcut described above if you have npm 5+ installed on your machine, as the command will detect that you are using yarn and will act accordingly. Otherwise, run npm info "eslint-config-mide-ts@latest" peerDependencies to list the peer dependencies and versions, then run yarn add --dev <dependency>@<version> for each listed peer dependency.

If using npm < 5, Linux/OSX users can run

(
  export PKG=eslint-config-mide-ts;
  npm info "$PKG@latest" peerDependencies --json | command sed 's/[\{\},]//g ; s/: /@/g' | xargs npm install --save-dev "$PKG@latest"
)

Which produces and runs a command like:

npm install --save-dev eslint-config-mide-ts @typescript-eslint/eslint-plugin@^x.x.x @typescript-eslint/parser@^x.x.x eslint@^x.x.x eslint-plugin-import@^x.x.x typescript@^x.x.x

If using npm < 5, Windows users can either install all the peer dependencies manually, or use the install-peerdeps cli tool.

npm install -g install-peerdeps
install-peerdeps --dev eslint-config-mide-ts

The cli will produce and run a command like:

npm install --save-dev eslint-config-mide-ts @typescript-eslint/eslint-plugin@^x.x.x @typescript-eslint/parser@^x.x.x eslint@^x.x.x eslint-plugin-import@^x.x.x typescript@^x.x.x

2. Configure ESLint

You will see several dependencies were installed. Now, create (or update) a .eslintrc file with the following content:

{
  'extends': [
    'mide-ts'
  ],
  parserOptions: {
    project: './tsconfig.json',
  }
}