eslint-config-coremail

The ESLint config for Coremail (c)

This module exports a flat ESLint configuration that is supported since eslint 8.21.0, based on eslint-config-standard.

Note that eslint-config-standard is deprecated and no longer maintained. It's encouraged to switch to neo-standard for standard users.

This project focuses solely on ESLint config and does not provide framework tooling like neo-standard.

Quick Start

1. npm install --save-dev eslint eslint-config-coremail

2. For projects using ESM, add eslint.config.js as:

   import {configs} from 'eslint-config-coremail';
   
   export default [
       // default enables browser & node env; you can change to `configs.node` for server side projects
       configs.standard, {
           // your overrides here
       }, {
           // for legacy code compliant with old IE
           ...configs.legacy,
           files : ['path/to/legacy/codes/**'],
       },
   ]

3. For projects using CommonJS, add eslint.config.js as:

   module.exports = import('eslint-config-coremail').then(({configs}) => [
       // default enables browser & node env; you can change to `configs.node` for server side projects
       configs.standard, {
           // your overrides here
       }, {
           // for legacy code compliant with old IE
           ...configs.legacy,
           files : ['path/to/legacy/codes/**'],
       },
   ]);

Migrating from eslint-config-coremail 0.x / eslint-config-standard 17.x

1. Read this article for ESLint 9 migration
2. Migrate deprecated ESLint style rules with eslint-stylistic rules following this guide

Learn More

For more information on the full listing of rules that ESLint supports, and more, visit

• ESLint official site
• ESLint Stylistic

License

MIT. Copyright (c) Coremail.