Shareable Lint-Staged Config

📄 About

Package that contains shareable configuration for lint-staged — a popular tool for running linters on staged Git files.

It is designed to provide a set of ready-to-use configuration files that can be easily imported and used in your projects. This package also includes a helper module with utility functions to ease the use of lint-staged with tools like ESLint, Prettier, StyleLint and SecretLint.

→ Purpose

• Provide developers with a set of easy-to-use and shareable lint-staged configuration files. These configuration files can help developers enforce a consistent coding style and catch common errors before they are committed to source control.
• Included helper module provides utility functions for working with lint-staged and popular linting and formatting tools.
• Functions of package simplify the process of setting up lint-staged and help ensure that it is used effectively in your projects.

💿 Installation

To use this configuration, you'll need to install @staxomnid/lint-staged-config as a development dependency in your mono-repository.

# Install as dev-dependency in the root of the mono-repository
$ pnpm add -wD lint-staged @staxomnid/lint-staged-config

# Optional, to lint for secrets and sort package.json files
$ pnpm add -wD secretlint sort-package-json

This package should be installed in the root of your mono-repository, where you will create a file lint-staged.config.js. Within your monorepo, you should have a structure with directories for your apps and packages, such as:

.
├── lint-staged.config.js (root)
├── package.json (root)
├── apps
│   └── my-first-app
│       ├── lint-staged.config.js (overrides lint-staged.config.js from root folder)
│       ├── package.json
│       └── ... (other app files)
└── packages
    └── my-first-package
        ├── lint-staged.config.js (overrides lint-staged.config.js from root folder)
        ├── package.json
        └── ... (other package files)

→ Configure

1. Create lint-staged.config.js file in root of mono-repository and add lines:

   const { concatFilesForPrettier } = require('@staxomnid/lint-staged-config')
   
   const json = require('@staxomnid/lint-staged-config/json')
   const yaml = require('@staxomnid/lint-staged-config/yaml')
   const secrets = require('@staxomnid/lint-staged-config/secret')
   const md = require('@staxomnid/lint-staged-config/md')
   
   const rules = {
     ...json,
     ...yaml,
     ...secrets,
     ...md,
     '**/*.{js,jsx,cjs,mjs,ts,tsx,mts,cts}': filenames => {
       return [`prettier --write ${concatFilesForPrettier(filenames)}`]
     },
   }
   
   module.exports = rules

2. If needed, override the base lint-staged.config.js in each package or application.

   Example lint-staged.config.js in folder ./packages/eslint-config/

   const { getEslintFixCmd } = require('@staxomnid/lint-staged-config')
   
   const json = require('@staxomnid/lint-staged-config/json')
   const yaml = require('@staxomnid/lint-staged-config/yaml')
   const secret = require('@staxomnid/lint-staged-config/secret')
   const md = require('@staxomnid/lint-staged-config/md')
   const html = require('@staxomnid/lint-staged-config/html')
   
   /**
    * @typedef {Record<string, (filenames: string[]) => string | string[] | Promise<string | string[]>>} LintRule
    */
   const rules = {
     '**/*.{js,jsx,ts,tsx}': (/** @type {any} */ filenames) => {
       return getEslintFixCmd({
         cwd: __dirname,
         fix: true,
         cache: true,
         // when autofixing staged-files a good tip is to disable react-hooks/exhaustive-deps, cause
         // a change here can potentially break things without proper visibility.
         rules: ['react-hooks/exhaustive-deps: off'],
         maxWarnings: 25,
         files: filenames,
       })
     },
     ...json,
     ...secret,
     ...md,
     ...yaml,
     ...html,
   }
   
   module.exports = rules

3. Set up the pre-commit git hook to run lint-staged using Husky — popular choice for configuring git hooks

   Install husky as dev-dependency into root of monorepo

   pnpm add -wD husky is-ci

   Activate hooks:

   pnpm husky install

   Add lint-staged hook:

   npx husky add .husky/pre-commit 'pnpm lint-staged --verbose --concurrent false'

   Read more about git hooks here

4. Don't forget to commit changes to package.json and .husky to share this setup with your team!

💻 Usage

After installing @staxomni/lint-staged-config and setting up the pre-commit git hook with Husky, you can now run the following command:

git add . && git commit -am 'feat: adding lint-staged'

This will automatically trigger the checks defined in your lint-staged.config.js file for all the files that have been staged for commit. This will help you catch common errors and enforce a consistent coding style before the code is committed to source control.