eslint-config

Description

Base set of

• eslint
• typescript-eslint
• @stylistic/eslint-plugin
• eslint-plugin-import-x

linting rules.

• eslint-config
  • Description
  • Configs
    • Minimal
    • Recommended
  • Utils
    • Define-Config
    • Internal Package Import
• Links

Configs

Import config package on their own via import { configs } from '@diamir/eslint-config'

• configs.base ... basic eslint rules like eqeqeq, no-eval, no-shadow
• configs.typescript ... import order and typescript rules like @typescript-eslint/naming-convention
• configs.style ... stylistic rules like @stylistic/quotes, @stylistic/semi

and use them like

// eslint.config.mjs
import { globalIgnores } from 'eslint/config'
import { configs, utils } from '@diamir/eslint-config'

export default utils.defineConfig(
  globalIgnores(['dist/**']),
  configs.base,
  configs.typescript
)

Minimal

Predefined config for base + TypeScript, including global ignores for dist and migration folder.

// eslint.config.mjs
import { minimal } from '@diamir/eslint-config'

export default minimal

Recommended

Predefined config for base + typescript + stylistic, including global ignores for dist and migration folder.

// eslint.config.mjs
import { recommended } from '@diamir/eslint-config'

export default recommended

Utils

Imported via import { utils } from '@diamir/eslint-config'

Define-Config

Re-Export of typescript-eslint config helper.

import { utils } from '@diamir/eslint-config'

export default utils.defineConfigs(
  // eslint configs go here
)

Internal Package Import

If using libs with an internal scope (as in tsconfig paths) you can use internalPackageImport() to define a regex that identifies those packages to correctly order the imports.

// eslint.config.mjs
import { recommended, utils } from '@diamir/eslint-config'

export default defineConfig(
  utils.internalPackageImport('^@scope/'),
  recommended
)

Links

• Diamir
• eslint