ESLint Config for Stew Eucen

Overview

ESLint shareable config for Stew Eucen

This package is only for Flat Config.

Installing

Please add the following line to your .npmrc file.

@steweucen:registry=https://npm.pkg.github.com

Install this package alongside ESLint v9.4.0 or greater:

npm install --save-dev \
  eslint \
  @steweucen/eslint-config

Composition

This package includes some ESLint configurations.

| configuration | contains | | :-- | :-- | | core | ESLint standard rules without stylistic plugin rules | | stylistic | ESLint stylistic plugin rules | | jest | ESLint Jest plugin rules | | jsdoc | ESLint JSDoc plugin rules | | openreachtech | ESLint Open Reach Tech inc. plugin rules |

(1) Core Rules as is

When you want to use only core rules as is, please setup your eslint.config.js as follows:

// eslint.config.js
'use strict'

const coreConfiguration = require('@steweucen/eslint-config/configurations/core')

module.exports = [
  // Configuration of core rules
  {
    ...coreConfiguration,

    rules: {
      ...coreConfiguration.rules,
    },
  },
]

(2) Core Rules with Some Overriding Rules

When you want to use core rules with some overriding rules, please setup your eslint.config.js as follows:

// eslint.config.js
'use strict'

const coreConfiguration = require('@steweucen/eslint-config/configurations/core')
const disableCoreStylisticConfiguration = require('@steweucen/eslint-config/configurations/disableCoreStylistic')

module.exports = [
  // Configuration of core rules
  {
    ...coreConfiguration,

    rules: {
      ...coreConfiguration.rules,
      ...disableCoreStylisticConfiguration.rules, // Not required after v10.

      'id-length': [
        'error',
        {
          min: 1, // <--- 👀 overriding (default value: 2)
          max: Infinity,
          properties: 'always',
          exceptions: [],
          exceptionPatterns: [],
        },
      ],
    },
  },
]

(3) Core and Some Plugins Rules

When you want to use core and some plugins rules, please setup your eslint.config.js as follows:

// eslint.config.js
'use strict'

const coreConfiguration = require('@steweucen/eslint-config/configurations/core')
const stylisticConfiguration = require('@steweucen/eslint-config/configurations/plugins/stylistic')
const jestConfiguration = require('@steweucen/eslint-config/configurations/plugins/jest')
const jsdocConfiguration = require('@steweucen/eslint-config/configurations/plugins/jsdoc')
const openreachtechConfiguration = require('./configurations/plugins/openreachtech')

module.exports = [
  // Configuration of core rules
  {
    ...coreConfiguration,

    rules: {
      ...coreConfiguration.rules,
    },
  },

  // Configuration of stylistic rules
  {
    ...stylisticConfiguration,

    rules: {
      ...stylisticConfiguration.rules,
    },
  },

  // Configuration of Jest rules
  {
    ...jestConfiguration,

    rules: {
      ...jestConfiguration.rules,
    },
  },

  // Configuration of JSDoc rules
  {
    ...jsdocConfiguration,

    rules: {
      ...jsdocConfiguration.rules,
    },
  },

  // Configuration of OpenreachTech rules
  {
    ...openreachtechConfiguration,

    rules: {
      ...openreachtechConfiguration.rules,
    },
  },
]

(4) All Rules as is

When you want to use our ESLint rules as is, please setup your eslint.config.js as follows:

// eslint.config.js
'use strict'

const allConfigurations = require('@steweucen/eslint-config')

module.exports = [
  ...allConfigurations,
]

License

This project is released under the MIT License.

See → LICENSE

Copyright

© 2024 Stew Eucen