@herp-inc/eslint-config

ESLint shareable config for general TypeScript environments

Installation

Note that the following packages are peer dependencies of this library, which need to be installed separately.

Package	Version
@typescript-eslint/eslint-plugin	8
@typescript-eslint/parser	8
eslint	^8.56.0 || 9
eslint-config-prettier	*
eslint-plugin-import	^2.30.0

Using npm

$ npm install --save-dev @herp-inc/eslint-config

Using yarn

$ yarn add --dev @herp-inc/eslint-config

Usage

Add @herp-inc to the extends section of your ESLint configuration.

{
  "extends": ["@herp-inc"],
  "parser": "@typescript-eslint/parser",
  "parserOptions": {
    "project": "./tsconfig.json",
    "sourceType": "module"
  }
}

Flat config support (experimental)

[!WARNING] This feature is still experimental, and thus may encounter breaking changes even in a minor version.

Make sure that the following packages are installed as peer dependencies.

Package	Version
@eslint/js	^8.56.0 || 9
eslint	^8.56.0 || 9
eslint-config-prettier	9
eslint-plugin-import	^2.30.0
typescript-eslint	8

import config from '@herp-inc/eslint-config/flat';

export default [
  ...config,
  // Add your additional configurations here
];