@shlroland/lint-config

setting lint config will be easy and fast

a collection of

• eslint
• cz(czg) + commitlint
• lint-staged
• husky
• prettier

Usage

Wizard Setup

execute the following command in your terminal, the lint tools will be installed and configured automatically.

pnpm dlx @shlroland/lint-cli

parameters

• None : no parameters means default lint tools will be installed and configured automatically.
  • -I: select lint tools interactively instead of using default settings automatically.
• install : only install lint tools.
  • -I: install lint tools interactively.
• config : only config lint tools.
  • -I: config lint tools interactively.
  • -f: skip all prompts and override the existing configuration.

Important

Wizard Setup only install default lint tools and configure them according to the default settings. After executing the completion command, adjustments may need to be made according to project requirements

Manual Setup

eslint

@shlroland/eslint-config is based on @antfu/eslint-config and extends some rules.

install

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

config

create eslint.config.js

// for "type": "module"
import { shlroland } from '@shlroland/eslint-config'
export default shlroland()

// for "type": "commonjs"
const { shlroland } = require('@shlroland/eslint-config')
module.exports = shlroland()

cz(czg) + commitlint

use czg to generate commit messages. And use commitlint to lint commit messages.

install

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

config

create commitlint.config.js

// for "type": "module"
import { config } from '@shlroland/cz-config/commitlint'
export default config

// for "type": "commonjs"
module.exports = require('@shlroland/cz-config')

lint-staged

install

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

config

create lint-staged.config.js

// for "type": "module"
import config from '@shlroland/lint-staged'
export default config

// for "type": "commonjs"
module.exports = require('@shlroland/lint-staged')

husky

config

follow the husky official documentation to config. And copy the husky config from @shlroland/husky-config to your project.

prettier(not recommended)

it is not recommended use prettier to format code, since following the philosophy of @antfu/eslint-config.

install

pnpm add -D prettier @shlroland/prettier-config

config

create prettier.config.js

// for "type": "module"
import config from '@shlroland/prettier-config'
export default config

// for "type": "commonjs"
module.exports = require('@shlroland/prettier-config')

Inspired by

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