0.1.0 • Published 5 years ago

eslint-config-cool-typescript v0.1.0

Weekly downloads
2
License
MIT
Repository
github
Last release
5 years ago

eslint-config-cool-typescript

npm version

This package provides cool's .eslintrc as an extensible shared config. Especially for TypeScript.

Usage

Our default export contains all of our ESLint rules, including ECMAScript 6+ and React. It requires eslint, eslint-plugin-import, eslint-plugin-react, and eslint-plugin-jsx-a11y. Based on eslint-config-airbnb.

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

    npm info "eslint-config-cool-typescript@latest" peerDependencies

    If using npm 5+, use this shortcut

    npx install-peerdeps --dev eslint-config-cool-typescript

    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-cool-typescript@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-cool-typescript;
      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-cool-typescript eslint@^#.#.# eslint-plugin-jsx-a11y@^#.#.# eslint-plugin-import@^#.#.# eslint-plugin-react@^#.#.#

    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-cool-typescript

    The cli will produce and run a command like:

    npm install --save-dev eslint-config-cool-typescript eslint@^#.#.# eslint-plugin-jsx-a11y@^#.#.# eslint-plugin-import@^#.#.# eslint-plugin-react@^#.#.#
  2. Add "extends": "cool-typescript" to your .eslintrc