Sharable eslint configuration

eslint:

ESLint is a tool for identifying and reporting on patterns found in ECMAScript/JavaScript code.

• Github
• NPM Package
• Package Documentation

Usage

Meant for usage in conjunction with prettier, eslint & husky.

For additional information, see docs for

• @jeffsays/prettier

Installation

npm install --save-dev @jeffsays/lint-staged @jeffsays/prettier eslint lint-staged prettier

pnpm add --save-dev @jeffsays/lint-staged @jeffsays/prettier eslint lint-staged prettier

yarn add --dev @jeffsays/lint-staged @jeffsays/prettier eslint lint-staged prettier

Configuration

lint-staged.config.mjs:

/**
 * @file  - Shared configuration for eslint.
 * @ref  -  https://www.npmjs.com/package/eslint
 * @ref  -  https://github.com/eslint/eslint
 * @packageDocumentation  -  https://eslint.org/docs/latest/
 */

import { defineConfig } from "eslint/config";
import baseConfig from "@jeffsays/eslint";

/**
 * @type  {import("eslint").Config}
 */
export default defineConfig([baseConfig]);

/**
 * @file  - Shared configuration for eslint.
 * @author  -  Jeff Beck.
 * @ref  -  https://www.npmjs.com/package/eslint
 * @ref  -  https://github.com/eslint/eslint
 * @packageDocumentation  -  https://eslint.org/docs/latest/
 */

import { defineConfig } from "eslint/config";
import baseConfig from "@jeffsays/eslint";

/**
 * @type  {import("eslint").Config}
 */
export default defineConfig([
  baseConfig,
  {
    files: ["**/*.y?(a)ml"],
    rules: {
      "some-rule": off,
    },
  },
]);