@niondigital/eslint-config-base

Shared ESLint config as base by nion digital.

Enforced rules

On top of eslint:recommended and typescript-eslint recommended, this config enforces:

• Size backstops: max-lines (400, error), max-lines-per-function (80), complexity (12). Test files (*.{test,spec}.*, __tests__/, __mocks__/) are exempt from all three.
• No console: use a logging facade instead. Override per file via additionalRules / additionalConfig for legitimate CLI tooling.

Installation

1. Install package as a dev dependency:

npx install-peerdeps --dev @niondigital/eslint-config-base

2. Create eslint.config.mjs at the root and add the following code:

import getConfig from '@niondigital/eslint-config-base';

export default getConfig();

3. Add the following script in package.json:

{
  // ...
  "scripts": {
    // ...
    "eslint": "eslint --fix \"src/**/*.ts\""
  }
}

4. (Optional) You can customize the config by passing an object:

export default getConfig({
	// Files to be ignored
	ignores: [],
	// Additional ESLint rules
	additionalRules: {},
	// Additional ESLint config
	additionalConfig: [],
});