English | 中文

Tired of manually configuring ESLint, Prettier, Commitlint, and other tools? This toolkit helps you set them up with a single command! It integrates the following commonly used tools with ready-to-use configurations:

• ESLint: Checks code quality and catches potential errors
• Prettier (optional): Enforces consistent code style
• czg + commitlint: Standardizes Git commit messages with conventional commit format
• lint-staged: Runs checks only on staged files for better performance
• husky: Uses Git hooks to automatically run checks before commits

You can either use the wizard-based automatic setup or manually configure each tool according to your project’s needs.

Run the following command in your project root, and all tools will be installed and configured automatically:

pnpm dlx @zanelab/lint-cli

⚠️ Note: The wizard uses default settings to generate config files. If your project has special requirements, you can manually adjust them afterwards.

If you prefer finer control, follow these steps to install and configure each tool individually.

Our @zanelab/eslint-config is based on the powerful @antfu/eslint-config and adds some practical rules.

pnpm add -D eslint @zanelab/eslint-config eslint-plugin-format

Create an eslint.config.js file in your project root:

For ES modules ("type": "module")

import { zanelab } from '@zanelab/eslint-config'
export default zanelab()

For CommonJS ("type": "commonjs")

const { zanelab } = require('@zanelab/eslint-config')
module.exports = zanelab()

• czg: Generates commit messages interactively following the Conventional Commits spec
• commitlint: Validates commit messages against the spec

pnpm add -D @commitlint/cli czg @zanelab/cz-config

Create a commitlint.config.js file:

ES modules

import { config } from '@zanelab/cz-config/commitlint'
export default config

CommonJS

module.exports = require('@zanelab/cz-config')

Works with husky to run checks only on files that are staged for commit, making it faster.

pnpm add -D lint-staged @zanelab/lint-staged

Create a lint-staged.config.js file:

ES modules

import config from '@zanelab/lint-staged'
export default config

CommonJS

module.exports = require('@zanelab/lint-staged')

Used to run scripts automatically before Git operations (like commit, push).

1. Follow the husky official documentation to install and initialize husky.
2. Copy the hook scripts from @zanelab/husky-config into your .husky/ directory. For example, you might run lint-staged in the pre-commit hook and commitlint in the commit-msg hook.

We recommend using ESLint's formatting capabilities (following the philosophy of @antfu/eslint-config), so Prettier is optional. If you're used to Prettier, you can install it separately.

pnpm add -D prettier @zanelab/prettier-config

Create a prettier.config.js file:

ES modules

import config from '@zanelab/prettier-config'
export default config

CommonJS

module.exports = require('@zanelab/prettier-config')

This toolkit's concepts and configurations draw inspiration from the following excellent projects:

• @c4605/toolconfs
• @antfu/eslint-config
• @fantasticit/code-lint

Thanks to the authors of these projects for providing such convenient configuration solutions!