Sharable lint-staged configuration

lint-staged:

Run tasks like formatters and linters against staged git files and don't let 💩 slip into your code base!

• Github
• NPM Package

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 \
  lint-staged

pnpm add --save-dev \
  @jeffsays/lint-staged \
  lint-staged

yarn add --dev \
  @jeffsays/lint-staged \
  lint-staged

Configuration

lint-staged.config.mjs:

javascript

/**
 * @file - Shared configuration for lint-staged.
 * @author - Jeff Beck.
 * @ref - https://www.npmjs.com/package/lint-staged
 * @ref - https://github.com/lint-staged/lint-staged
 * @packageDocumentation - https://github.com/lint-staged/lint-staged?tab=readme-ov-file#configuration
 */

/**
 * @type  {import("lint-staged").Configuration}
 */
export { asyncConfig as default } from "@jeffsays/lint-staged";

typescript

/**
 * @file - Shared configuration for lint-staged.
 * @author - Jeff Beck.
 * @ref - https://www.npmjs.com/package/lint-staged
 * @ref - https://github.com/lint-staged/lint-staged
 * @packageDocumentation - https://github.com/lint-staged/lint-staged?tab=readme-ov-file#configuration
 */

export { asyncConfig as default } from "@jeffsays/lint-staged";

javascript

/**
 * @file - Shared configuration for lint-staged.
 * @author - Jeff Beck.
 * @ref - https://www.npmjs.com/package/lint-staged
 * @ref - https://github.com/lint-staged/lint-staged
 * @packageDocumentation - https://github.com/lint-staged/lint-staged?tab=readme-ov-file#configuration
 */

import { asyncConfig } from "@jeffsays/lint-staged";

/**
 * @type  {import("lint-staged").Configuration}
 */
const config: Configuration = {
  ...asyncConfig,
  // extend as-needed
};

export default config;

typescript

/**
 * @file - Shared configuration for lint-staged.
 * @author - Jeff Beck.
 * @ref - https://www.npmjs.com/package/lint-staged
 * @ref - https://github.com/lint-staged/lint-staged
 * @packageDocumentation - https://github.com/lint-staged/lint-staged?tab=readme-ov-file#configuration
 */

import { asyncConfig } from "@jeffsays/lint-staged";
import type { Configuration } from "lint-staged";

const config: Configuration = {
  ...asyncConfig,
  // extend as-needed
};

export default config;