README.md

@tiny-codes/code-style-all-in-one

All-in-one code style solution

⬇️    Introduction | Installation | Usage   ⬇️

Introduction

Provides popular ESLint, Prettier, Stylelint configurations, and a guide to set up Husky and Commitlint for a project. It is recommended to use this configuration for all projects to maintain a consistent code style.

It's assumed that your project is enabled with typescript by default, if not, you can build your own configuration by combining some presets. For example, ['@tiny-codes/code-style-all-in-one/eslint/config/recommended', '@tiny-codes/code-style-all-in-one/eslint/config/typescript', @tiny-codes/code-style-all-in-one/eslint/config/prettier], please node that @tiny-codes/code-style-all-in-one/eslint/config/prettier should be the last one.

Installation

npm install -D @tiny-codes/code-style-all-in-one

Note that some packages (e.g. stylelint-scss) are shipped as optionalDependencies, so if you do not need them, you can install with --no-optional flag.

npm install -D @tiny-codes/code-style-all-in-one --no-optional

Usage

Eslint configuration

Create a .eslintrc.js file in the project root directory with the following configuration:

.eslintrc.js

module.exports = {
  extends: ['@tiny-codes/code-style-all-in-one/eslint/config/recommended'],
};

Presets

• For React projects, it is recommended to use the @tiny-codes/code-style-all-in-one/eslint/config/react-recommended or @tiny-codes/code-style-all-in-one/eslint/config/react-all preset
• For Vue projects, it is recommended to use the @tiny-codes/code-style-all-in-one/eslint/config/vue-recommended, @tiny-codes/code-style-all-in-one/eslint/config/vue-typescript or @tiny-codes/code-style-all-in-one/eslint/config/vue-all preset
• For Next.js projects, it is recommended to use the @tiny-codes/code-style-all-in-one/eslint/config/next-recommended or @tiny-codes/code-style-all-in-one/eslint/config/next-all preset
• Here are some basic presets that you can also combine the presets to create your own configuration, please note again that @tiny-codes/code-style-all-in-one/eslint/config/prettier should be the last one
  • @tiny-codes/code-style-all-in-one/eslint/config/base: base configuration
  • @tiny-codes/code-style-all-in-one/eslint/config/recommended: recommended configuration
  • @tiny-codes/code-style-all-in-one/eslint/config/typescript: typescript configuration
  • @tiny-codes/code-style-all-in-one/eslint/config/prettier: prettier configuration

Stylelint configuration

Create a .stylelintrc.js file in the project root directory.

.stylelintrc.js

module.exports = require('@tiny-codes/code-style-all-in-one/stylelint/config');

If you are using less, you should use another configuration.

.stylelintrc.js

module.exports = require('@tiny-codes/code-style-all-in-one/stylelint/config/less');

Or ff you are using scss, you should use scss configuration.

.stylelintrc.js

module.exports = require('@tiny-codes/code-style-all-in-one/stylelint/config/scss');

Prettier configuration

Create a .prettierrc.js file in the project root directory.

.prettierrc.js

module.exports = require('@tiny-codes/code-style-all-in-one/prettier/config');

Husky configuration

Initialize the husky:

npx husky init

Add the following two files to the .husky directory:

.husky/pre-commit

#!/usr/bin/env sh
. "node_modules/@tiny-codes/code-style-all-in-one/husky/hooks/pre-commit"

.husky/commit-msg

#!/usr/bin/env sh
. "node_modules/@tiny-codes/code-style-all-in-one/husky/hooks/commit-msg"

Lint-staged configuration

Create a lint-staged.config.js file in the project root directory with the following configuration:

lint-staged.config.js

module.exports = require('@tiny-codes/code-style-all-in-one/lint-staged/config');

Commitlint configuration

Create a .commitlintrc.js file in the project root directory with the following configuration:

.commitlintrc.js

const config = require('@tiny-codes/code-style-all-in-one/commitlint/config');
module.exports = config;

Auto generate changelog

Add the following configuration to the package.json:

"scripts": {
  "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0"
},

You can change the file name and other parameters as you want.

Note that when committing code, you need to follow the Conventional Commits specification so that your commits can be included in the changelog. Additionally, before executing this command, you need to tag a new version in the git repository to generate the changelog for the new version.

If you want to handle automated version bumping, tagging and CHANGELOG generation, just like npm version, you can add the following configuration to the package.json:

"scripts": {
  "release": "commit-and-tag-version"
},

Now you can run npm run release to do them all.

You can also add the following configuration to the package.json to generate changelog automatically before each commit:

"husky": {
  "hooks": {
    "prepare-commit-msg": "exec < /dev/tty && npm run changelog"
  }
},