eslint-config-standard-with-typescript
    TypeScript icon, indicating that this package has built-in type declarations

    22.0.0 • Public • Published

    Build Status JavaScript Style Guide npm

    An ESLint shareable config for TypeScript that is based on eslint-config-standard and has TypeScript specific rules from @typescript-eslint/eslint-plugin.

    Peer dependencies

    This package specifies the following peerDependencies:

    Yes, this is a large number of peerDependencies. This is due to a known limitation in ESLint.

    @typescript-eslint dependencies

    This package has @typescript-eslint/parser in dependencies.
    And it has @typescript-eslint/eslint-plugin in peerDependencies.
    Both are specified as ranges. It's probably safest for the installed versions of these packages to be the same. This can be achieved by:

    1. Pin (exact version) the @typescript-eslint/eslint-plugin in package.json.
    2. Have a package-lock.json which locks the version of the @typescript-eslint/parser sub-dependency.

    And both pin/lock to the same version.

    npm@<7

    npm@<7 does not automatically install peerDependencies, so if that's what you're using, install them manually. Here is an example, but use it only for reference, because your decisions regarding version ranges and range specifiers may vary.

    npm install --save-dev \
      typescript@\* \
      eslint@^8.0.1 \
      eslint-plugin-promise@^6.0.0 \
      eslint-plugin-import@^2.25.2 \
      eslint-plugin-n@^15.0.0 \
      @typescript-eslint/eslint-plugin@^5.0.0 \
      eslint-config-standard-with-typescript@latest
    

    Example config

    Here is an example .eslintrc.js:

    module.exports = {
      extends: 'standard-with-typescript',
      parserOptions: {
        project: './tsconfig.json'
      }
    }

    Note: Please read some important instructions regarding the project option here.

    There are some more parserOptions you may care about.

    Example command line usage:

    $ npx eslint .
    

    Install

    npm i eslint-config-standard-with-typescript

    DownloadsWeekly Downloads

    130,282

    Version

    22.0.0

    License

    MIT

    Unpacked Size

    13.4 kB

    Total Files

    6

    Last publish

    Collaborators

    • jhiesey
    • bret
    • feross
    • flet
    • linusu
    • mafintosh
    • jprichardson
    • watson
    • raynos
    • toddbluhm
    • voxpelli
    • mightyiam