An ESLint configuration by Putro

This ESLint setup should let any new (or existing) projects adhere to best practices within TypeScript and write fewer bugs as a result! The default version is quite strict, so an existing project might opt for using the base version, see more under Usage.

The latest version (v3 and up) is using the new flat configuration from eslint and eslint v9. If you are not ready for this change, please stick with 2.6.1 or below.

Installation

To install this package run the following command in the terminal in the root directory of your application.

pnpm install -D @putstack/eslint-config-typescript

OR

npm install --save-dev @putstack/eslint-config-typescript

OR

yarn add -D @putstack/eslint-config-typescript

Usage

Ensure that your ESLint configuration is setup to utilize TypeScript's type checking API by following this guide. Note that if you're using this in a monorepo, you SHOULD keep "project":"true" despite that the guide says otherwise in my experience.

Add this to your config by editing your eslint.config.js file or equivalent.

import putstack from '@putstack/eslint-config-typescript';

export default [...putstack.configs.recommended];

If the default is too strict on an existing project, you can also use the base configuration to exclude some of the more strict rules. To see what is dincluded in which package, please view this section.

import putstack from '@putstack/eslint-config-typescript';

export default [...putstack.configs.base];

Example

This project uses the configuration on itself, as seen in the root eslint.config.js file.

ESLint rules

ESLint PLugins and Configurations

This is a list of the plugins and configurations that are extended from.

Base

Plugins

• eslint-plugin-depend - An ESLint plugin for suggesting optimisations in choice of dependency, native equivalents, etc.
• eslint-plugin-perfectionist - ESLint plugin for sorting various data such as objects, imports, types, enums, JSX props, etc.
• eslint-plugin-progress - Report progress when running ESLint. Useful for large projects with thousands of files, so it's obvious that something is running!
• eslint-plugin-sonarjs - Code smell, bug detection, cognitive complexity and more.
• typescript-eslint - A large amount of TypeScript related ESLint rules, using the recommended type checking rules.

Configurations

• eslint
  • recommended - The set of rules which are recommended for all projects by the ESLint team, indicated by the ✅ on the rule list.
• eslint-plugin-depend
  • recommended - Using the recommended setup to catch dependency issues.
• eslint-plugin-perfectionist
  • recommended-natural - Using the recommended setup to sort imports and other data naturally. Natural sort compares strings containing a mixture of letters and numbers, just as a human would do when sorting. For example: item-1, item-2, item-10.
• eslint-plugin-sonarjs
  • recommended - Using sonarjs recommended setup to catch general code smells.
• typescript-eslint
  • recommended-type-checked - To see a full list of the rules, click here.
  • stylistic-type-checked - To see a full list of the rules, click here.

Recommended

Recommended extends the base setup further to add additional rules, therefore it also includes all the rules above.

Plugins

• eslint-plugin-unicorn - This plugin provides more than 100 powerful ESLint rules of which many are auto-fixable making it easy to fix any issues that arise!

Configurations

• eslint-plugin-unicorn
  • recommended - Using the recommended configuration to catch common issues and enforce best practices.