@beyondessential/eslint-config-ts v2.0.0

@beyondessential/eslint-config-ts

TypeScript/React.js style guide as as shareable ESLint configuration

This package defines Beyond Essential System's style guide for TypeScript/React.js projects. It extends our JavaScript/React.js style guide, with additional TypeScript-specific rules.

Installation

yarn add -D @beyondessential/eslint-config-ts

Usage

You need to extend this package in your ESLint configuration:

{
  "extends": "@beyondessential/ts"
}

⚠️ If you use a TS configuration file other than the default (tsconfig.json under the project's root), you need to specify its path:

{
  "parserOptions": {
    "project": "ts/tsconfig.dev.json"
  }
}

⚠️ If you get the following error:

Configuration for rule "@typescript-eslint/indent" is invalid

it is a known eslint-config-airbnb-typescript issue, see that link for possible solutions.

Maintenance

Please be mindful of this package's twin sibling, @beyondessential/eslint-config-ts: you may want to reflect any common rule/dependency updates in that package too.

Publishing

1. Checkout the latest code: git fetch && git checkout master
2. Commit your changes in a new branch
3. ⚠️ Don't forget to also update the package version: npm version # < patch || minor || major >
4. Create a pull request against master

After your PR is approved and merged:

git fetch && git checkout master && git pull
npm login
npm publish --access public

Style guide

This style guide is a combination of:

• The Typescript port of the Airbnb Style Guide. with some changes
• The recommended rules from @typescript-eslint/eslint-plugin, with some changes

Changes

Additions

Enforce prettier formatting

Rule: prettier/prettier: error Configuration:

{
  "arrowParens": "avoid",
  "printWidth": 100,
  "singleQuote": true,
  "trailingComma": "all"
}