README.md

eslint-config-cheminfo-typescript

Shared ESLint config for TypeScript projects.

Important

Configs now require using the ESLint Flat Config format. See the migration guide for more information.

Installation

npm i -D eslint-config-cheminfo-typescript eslint

Usage

Create a eslint.config.mjs file with the following contents:

import { defineConfig } from 'eslint/config';
import cheminfo from 'eslint-config-cheminfo-typescript';

export default defineConfig(cheminfo);

You can then customise the config for your project.

Exported configurations

This package exports three separate configurations:

• eslint-config-cheminfo-typescript/base: The base config with most rules. At least this config should be used in all TypeScript projects.
• eslint-config-cheminfo-typescript/jsdoc: Rules from the jsdoc plugin to help improve the documentation of our libraries.
• eslint-config-cheminfo-typescript/unicorn: Additional opinionated rules selected from the unicorn plugin.
• eslint-config-cheminfo-typescript/vitest: Rules from the Vitest plugin.

The default export from eslint-config-cheminfo-typescript combines all of them.

References

This config extends our eslint-config-cheminfo JavaScript config.