eslint-config-cheminfo

eslint-config-cheminfo

Shared ESLint config for cheminfo and ml.js 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 eslint

Usage

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

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

export default defineConfig(cheminfo);

You can then customise the config for your project.

Create ESLint scripts in your package.json:

{
  "scripts": {
    "eslint": "eslint src",
    "eslint-fix": "npm run eslint -- --fix"
  }
}

Exported configurations

This package exports three separate configurations:

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

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

Extensions of this config

TypeScript

https://github.com/cheminfo/eslint-config-cheminfo-typescript

React

https://github.com/cheminfo/eslint-config-cheminfo-react

TypeScript and React

To extend both the TypeScript and React configs, use the following template:

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

export default defineConfig(typescript, react);