pimaonline-es-lint-config

A configuration for ES Lint for Pima Online

Installation

Install the configuration and its peer dependencies in your project:

npm install --save-dev pimaonline-es-lint-config

Due to ESLint version 9 updates, it requires a local config file. You can copy this as the default config file, that applies all the default preferences to ES Lint. Name this file: eslint.config.js and place it at the root of your project.

/**
 * @type {import('eslint').Linter.Config[]}
 */
const pimaonlineConfig = require("pimaonline-es-lint-config");
module.exports = pimaonlineConfig;

Usage

Create an eslint.config.js file in the root of your project and add the following content.

Themepack

/**
 * @type {import('eslint').Linter.Config[]}
 */
const pimaonlineConfig = require("pimaonline-es-lint-config");
const globals = require("globals");

module.exports = [
	...pimaonlineConfig,
	{
		ignores: ["**/src/plugins/", "**/docs/", "**/stylelint.config.js"],
	},
	{
		// Config for Node.js utility scripts that need CommonJS
		files: [
			"eslint.config.js",
			"webpack.config.js",
			"themes.config.js",
			"stylelint.config.js",
			"stylelint/**/*.js",
			"docs/**/*.js"
		],
		languageOptions: {
			sourceType: "commonjs",
			globals: {
				...globals.node,
			},
		},
		rules: {
			// Allow require() in Node.js files
			"@typescript-eslint/no-require-imports": "off",
		},
	},
]

Other Projects

Each project will require specific edits to the config file. You can add your own rules to override the base configuration.

const pimaonlineConfig = require("pimaonline-es-lint-config");

module.exports = [
	// Apply all the rules from the shared configuration
	...pimaonlineConfig,

	// Add your own project-specific overrides
	{
		rules: {
			// for example, prefer single quotes instead of double
			"@stylistic/quotes": ["error", "single"],
		},
	},
];

Commands

npm run lint - Applies ES Linting and marks files that have issues and produces a log. npm run lint:fix - Applies the ES Lint automatic fixing function that fixes small errors.

Disable ES Lint

In some rare instances, you may want to disable ES Lint for a project. The easiest way to do this, is to add this rule in your User Settings (JSON) for VS Code.

"eslint.enable": false