eslint-config-hughx-ts

Provides hughx’s TypeScript conventions as .eslintrc shared configs.
Emphasizes readability and ease of writing.

---

ℹ️ For plain JavaScript support, use eslint-config-hughx instead.

Installation

npm versions 7 and above

1npm install -D eslint-config-hughx-ts

yarn and older npm

You will have to install peerDependencies manually:

1# npm install -D
2yarn add -D \
3  @hughx/tsconfig \
4  @typescript-eslint/eslint-plugin \
5  @typescript-eslint/parser \
6  eslint \
7  eslint-config-airbnb-typescript \
8  eslint-config-hughx \
9  eslint-config-hughx-ts \
10  eslint-import-resolver-typescript \
11  eslint-plugin-import \
12  typedoc \
13  typescript

React projects

1# npm install -D
2yarn add -D \
3  @hughx/tsconfig \
4  @types/react \
5  @typescript-eslint/eslint-plugin \
6  @typescript-eslint/parser \
7  eslint \
8  eslint-config-airbnb-base \
9  eslint-config-airbnb-typescript \
10  eslint-config-hughx \
11  eslint-config-hughx-ts \
12  eslint-import-resolver-typescript \
13  eslint-plugin-import \
14  eslint-plugin-jsx-a11y \
15  eslint-plugin-react \
16  eslint-plugin-react-hooks \
17  typedoc \
18  typescript

Node projects

1# npm install -D
2yarn add -D \
3  @hughx/tsconfig \
4  @types/node \
5  @typescript-eslint/eslint-plugin \
6  @typescript-eslint/parser \
7  eslint \
8  eslint-config-airbnb-base \
9  eslint-config-airbnb-typescript \
10  eslint-config-hughx \
11  eslint-config-hughx-ts \
12  eslint-import-resolver-typescript \
13  eslint-plugin-import \
14  typedoc \
15  typescript

Usage

Extend hughx-ts in your project’s .eslintrc.js or equivalent:

1module.exports = {
2  "extends": [
3    "hughx-ts",
4  ],
5  // …
6}

Eslint-config-hughx-ts defaults to the latest version of JavaScript/ECMAScript at the time of release. If your transpiler isn’t set up for this (or you don’t use one), then you should override both env.es* and parserOptions.ecmaVersion, e.g.

1// Downgrading from ES2021 to ES6
2module.exports = {
3  "extends": [
4    "hughx-ts",
5  ],
6  "env": {
7    "es2021": false,
8    "es6": true
9  },
10  "parserOptions": {
11    "ecmaVersion": 6
12  }
13};

Then, create a tsconfig.json in your root and extend @hughx/tsconfig:

1{
2  "extends": "@hughx/tsconfig"
3}

Environment-specific Configs

You can extend from one of the following to bring in sensible defaults for different use cases:

React

.eslintrc

hughx-ts/react

tsconfig.json

@hughx/tsconfig/react.json

Node

.eslintrc

hughx-ts/node

tsconfig.json

@hughx/tsconfig/node.json

Web Components

.eslintrc

hughx-ts/web-components

tsconfig.json

@hughx/tsconfig/web-components.json