Utilities & Globs

@eienjs/eslint-config exports utility functions and standard file glob constants that you can reuse in your own eslint.config.js.

Utility Functions

combine(...configs)

Resolves and flattens an arbitrary mix of single config objects, arrays of config objects, or promises into a flat Promise<TypedFlatConfigItem[]>.

import { combine } from '@eienjs/eslint-config';
import { ignores, javascript } from '@eienjs/eslint-config/configs';

export default combine(
  ignores(),
  javascript(),
  {
    rules: {
      'no-console': 'off',
    },
  },
);

toArray(value)

Wraps a single value into an array if it is not already an array (T | T[] => T[]).

interopDefault(modulePromise)

Awaits a dynamic import() or module value and unwraps its .default export if present.

isInEditorEnv()

Returns true when ESLint is running inside a supported code editor (VS Code, JetBrains IDE, Vim, Neovim, or Zed) and not inside CI, Git hooks, or lint-staged.

isInGitHooksOrLintStaged()

Returns true when running inside Git hooks (GIT_PARAMS, VSCODE_GIT_COMMAND) or lint-staged.

isPackageInScope(name)

Checks whether a package is installed and resolvable relative to @eienjs/eslint-config.

ensurePackages(packages)

Checks whether optional packages are installed and prompts the user to install any missing ones in interactive terminals.

parserPlain

A minimal pass-through ESLint parser that produces an empty AST program, used for formatting non-JavaScript files (such as .css, .html, .xml, and .md) with eslint-plugin-format.

Glob Constants

Import glob patterns directly from @eienjs/eslint-config to target specific file types in your custom config blocks:

import { eienjs, GLOB_SRC, GLOB_TESTS } from '@eienjs/eslint-config';

export default eienjs().append({
  files: [GLOB_SRC],
  ignores: GLOB_TESTS,
  rules: {
    'no-console': 'error',
  },
});