eslint-config-ns-ts

Lint your TypeScript projects with ease. eslint-config-ns-ts extends my existing JavaScript config eslint-config-ns.

Contents

• eslint-config-ns-ts
  • Contents
  • Related Configs
  • Features
  • Installation
  • Usage
    • Prettier Config
  • Assumptions
  • LICENCE
  • Maintainers

Related Configs

• JavaScript: eslint-config-ns-base
• JavaScript React: eslint-config-ns
• TypeScript: eslint-config-ns-ts-base
• TypeScript React: eslint-config-ns-ts

Features

• based on the the popular javascript code style from Airbnb
• with react, react-hooks, jest, and prettier support
• with TypeScript support
  • e.g. with support for baseUrl and paths

The config is built upon Airbnb's ESLint rules with additional rules and optimizations (see assumptions).

Installation

Install the package with

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

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

eslint-config-ns-ts requires you to take care of it's peerDependencies. Install the correct version of each peerDependencies package, which are listed with the following 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 eslint-config-ns-ts 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',
}

Prettier Config

This is how you can use or extend the eslint-config-ns-ts prettier config in your app:

// prettier.config.js
module.exports = require('eslint-config-ns-ts/prettier.config')

Assumptions

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

Even though I made some assumptions, you can easily overwrite, extend and unset rules and any other setting in your custom eslint config.

LICENCE

MIT

Maintainers

Stefan Natter