@wang1212/eslint-config

ESLint Config

English | 简体中文

🔧 Community-recommended best practices for ESLint rule configuration.(Use with Prettier)

Usage

npm install --save-dev @wang1212/eslint-config

1. Install peerDependencies:

   npm install --save-dev eslint
   npm install --save-dev --save-exact prettier
   

2. Create a .prettierrc.yml file in the project root directory and configure the following:

   # see docs: https://prettier.io/docs/en/configuration.html
   
   # prettier config
   printWidth: 80
   tabWidth: 2
   useTabs: false
   singleQuote: true
   semi: true
   endOfLine: 'lf'
   

   This is just a recommended configuration and can be adjusted to your liking.

3. Then you need to add @wang1212/eslint-config in your .eslintrc.json:

   {
     "extends": ["@wang1212/eslint-config"]
   }
   

   The rule configuration of ESLint can be configured and covered according to your own requirements, please refer to the official documentation.

Configuration Details

• @wang1212/eslint-config (Base JavaScript configuration)

This configuration is for basic JavaScript, based on the Airbnb JavaScript Style Guide, JSDoc, SonarJS.

Development Guidelines

Git Commit Message Format

Adopt community commit format best practices:

# Before
git commit

# Now
npm run commit

This constraint relies on tools commitizen and commitlint provided by the community.

npm publish

The version management of this module adopts the specifications recommended by the community Semantic Versioning. Follow version changes and maintain a CHANGELOG.md(Learn why).

# Update version and generate changelog before publishing to npm repository
npm run release # npm run release -- --first-release
# Or, preview
npm run release -- --dry-run

# Then
npm publish # npm publish --access public

These jobs are done with the help of standard-version tool provided by the community.

License

MIT.