eslint-config-ns-ts

ATTENTION

This repository was merged with https://github.com/natterstefan/eslint-config-ns and will be developed there in the future.

Lint your typescript projects with ease, based on the popular javascript code style from Airbnb and enhanced with typescript specific rules. This config extends my other config eslint-config-ns.

Features

based on my javascript code style eslint-config-ns and the typescript-eslint/recommended settings
with prettier support, thanks to eslint-plugin-prettier
with react, react-hooks and jest support

Installation

The default export contains default Airbnb ESLint rules, and some additional rules (see assumptions). It requires some peerDependencies as well.

Install the package with

npm install eslint-config-ns-ts --save-dev

# or
yarn add eslint-config-ns-ts -D

Then install the correct versions of each peerDependency package, which are listed by the command:

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

If using npm 5+, use this shortcut:

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

# or
yarn add eslint-config-ns-ts -D --peer

Usage

Now add the config to either your package.json:

{
  "eslintConfig": {
    "extends": "eslint-config-ns-ts"
  }
}

to your .eslintrc:

{
  "extends": "eslint-config-ns-ts"
}

or .eslintrc.js:

module.exports = {
  extends: 'eslint-config-ns-ts',
}

Assumptions

This ESLint configuration comes with the same fundamental assumptions, as eslint-config-ns.

Versioning

This package DOES NOT use SemVer for versioning. Though you can think about SemVer when reading the version, except the major and minor version follows the one of eslint-config-ns. For the versions available, see the tags on this repository.

LICENCE

MIT

Maintainers

Stefan Natter

natterstefan/eslint-config-ns-ts