Lint-Staged Config

My personal shareable lint-staged configuration.

Install

pnpm add -D lint-staged @ggascoigne/lint-staged-config

Usage

lint-staged.config.js

module.exports = require('@ggascoigne/lint-staged-config');

YML

module.exports = require('@ggascoigne/lint-staged-config/yml');

Extending

An example that includes checking for credentials, ignoring prettier on unknown extensions, yml linting, and executing tests and coverage output related to files that have been changed in the current commit only.

lint-staged.config.js

const config = require('@ggascoigne/lint-staged-config');
const ymlConfig = require('@ggascoigne/lint-staged-config/yml');

module.exports = {
  '*': ['secretlint'],
  '!(*.{md,js,jsx,ts,tsx,json,css,scss,yml,yaml})': [
    'prettier --cache --write --ignore-unknown',
  ],
  ...ymlConfig,
  ...config,
  '*.{js,jsx,ts,tsx}': [
    'pnpm test --bail --passWithNoTests --findRelatedTests --coverage',
  ],
};

Add a Husky Hook

Install husky:

pnpm add -D husky && npm set-script prepare "husky install" && pnpm prepare

Add the hook:

npx husky add .husky/pre-commit 'npx --no-install lint-staged'

License

MIT