Package detail

@comandeer/eslint-config

Comandeer3.4kMIT0.17.0

Shareable ESLint configuration

eslint, eslintconfig

readme

@comandeer/eslint-config

Build Status npm (scoped)

Super opinionated ESLint configuration.

Installation

npm install @comandeer/eslint-config --save-dev

Usage

Put it inside your eslint.config.js file:

import { eslintConfig } from '@comandeer/eslint-config';

export default eslintConfig();

Optionally, you could also include formatting rules:

import { eslintConfig } from '@comandeer/eslint-config';
import { formattingConfig } from '@comandeer/eslint-config/formatting';

export default [
    ...eslintConfig(),
    ...formattingConfig()
];

Options

Both exports accepts the same set of options as an options object:

eslintConfig( {
    tsProject: [ './packages/*/tsconfig.json' ]
} );

Available options

Name Value type Default value Description
tsProject Array<string> [ './tsconfig.json' ] Paths to all TS config files in the project that should be used for linting.
allowDefaultExports Array<string> [] Glob patterns for files that are allowed to contain default exports. Default exports are always allowed in config files (`/.config.{js,mjs,ts,mts}`)*

License

See LICENSE file for details.