Merge pull request #12 from js-templates/feat/add-precommit-hooks

Evgeny Zakharov · web-flow · commit fe13590a0ce5 · 2022-06-06T04:10:47.000+03:00
Add cz and pre-commit hooks
diff --git a/.cz-config.js b/.cz-config.js
@@ -0,0 +1,18 @@
+module.exports = {
+  types: [
+    { name: "🎸 feat:     A new feature", value: "feat" },
+    { name: "🐛 fix:      A bug fix", value: "fix" },
+    { name: "🕯 wip:      Work in progress", value: "wip" },
+    { name: "🤖 chore:    Build process or auxiliary tool change", value: "chore" },
+    { name: "💡 refactor: A code change that neither fixes a bug or adds a feature", value: "refactor" },
+    { name: "💄 style:    Markup, white-space, formatting, missing semi-colons...", value: "style" },
+    { name: "💍 test:     Adding missing tests", value: "test" },
+    { name: "💪 perf:     A code change that improves performance", value: "perf" },
+    { name: "✏️ docs:     Documentation only changes", value: "docs" },
+    { name: "🕹️ ci:       CI related changes", value: "ci" },
+    { name: "🔥 revert:   Revert to a commit", value: "revert" },
+  ],
+  allowCustomScopes: true,
+  skipQuestions: ["footer"],
+  allowBreakingChanges: ["feat", "fix", "revert", "refactor"],
+}
diff --git a/.czrc b/.czrc
@@ -0,0 +1,3 @@
+{
+  "path": "node_modules/cz-customizable"
+}
diff --git a/.husky/commit-msg b/.husky/commit-msg
@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+yarn commitlint --edit $1
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+yarn lint-staged
diff --git a/.lintstagedrc b/.lintstagedrc
@@ -0,0 +1,8 @@
+{
+  "*.{js,jsx,ts,tsx}": [
+    "eslint --fix"
+  ],
+  "*.{md,json}": [
+    "prettier --write"
+  ]
+}
diff --git a/README.md b/README.md
@@ -80,7 +80,7 @@ Then, the `release` workflow handles everything:
 ### Regular flow
 
 1. Create [feature branch](#conventions)
-2. Make changes in your feature branch and [commit](#conventions)
+2. Make changes in your feature branch and [commit](#conventions) using `yarn commit`
 3. Create a Pull Request from your feature branch to `main`  
    The PR is needed to test the code before pushing to release branch
 4. If your PR contains breaking changes, don't forget to put a `BREAKING CHANGES` label
@@ -92,24 +92,28 @@ Then, the `release` workflow handles everything:
 1. Assume your prerelease tag is `beta`
 2. Create `release/beta` branch
 3. Create [feature branch](#conventions)
-4. Make changes in your feature branch and [commit](#conventions)
+4. Make changes in your feature branch and [commit](#conventions) using `yarn commit`
 5. Create a Pull Request from your feature branch to `release/beta`  
    The PR is needed to test the code before pushing to release branch
 6. Create Github release with tag like `v1.0.0-beta`, pointing to `release/beta` branch  
-   For next `beta` versions use semver build syntax: `v1.0.0-beta+1`  
+   For next `beta` versions use semver build syntax: `v1.0.0-beta+1`
 7. After that, the `release` workflow will publish your package with the `beta` tag
 8. When the `beta` version is ready to become `latest` - create a Pull Request from `release/beta` to `main` branch
 9. Continue from the [Regular flow's](#regular-flow) #5 step
 
 ### Conventions
 
 **Feature branches**:
+
 - Should start with `feat/`, `fix/`, `docs/`, `refactor/`, and etc., depending on the changes you want to propose (see [pr-labeler.yml](./.github/pr-labeler.yml) for a full list of scopes)
 
 **Commits**:
+
+- Should be created using `yarn commit` command
 - Should follow the [Conventional Commits specification](https://www.conventionalcommits.org)
 
 **Pull requests**:
+
 - Should have human-readable name, for example: "Add a TODO list feature"
 - Should describe changes
 - Should have correct labels
@@ -148,4 +152,4 @@ Then, the `release` workflow handles everything:
 
 ### The last step
 
-Remove **Using Template** section from README (don't forget about Navigation links)
+Remove **Using Template** section from README (don't forget about Navigation links)
diff --git a/commitlint.config.js b/commitlint.config.js
@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ['cz'],
+}
diff --git a/package.json b/package.json
@@ -21,17 +21,30 @@
     "test": "jest",
     "test:watch": "yarn test --watchAll",
     "lint": "eslint --ext .ts,.tsx src",
-    "lint:fix": "yarn lint --fix"
+    "lint:fix": "yarn lint --fix",
+    "commit": "cz",
+    "prepare": "is-ci || husky install",
+    "postinstall": "yarn prepare",
+    "prepack": "pinst --disable",
+    "postpack": "pinst --enable"
   },
   "dependencies": {},
   "devDependencies": {
+    "@commitlint/cli": "^17.0.2",
     "@rollup/plugin-typescript": "^8.3.2",
     "@types/jest": "^27.5.1",
+    "commitizen": "^4.2.4",
+    "commitlint-config-cz": "^0.13.3",
+    "cz-customizable": "^6.3.0",
     "esbuild": "^0.14.39",
     "eslint": "^8.16.0",
-    "eslint-kit": "^5.1.4",
+    "eslint-kit": "^5.2.1",
+    "husky": "^8.0.1",
+    "is-ci": "^3.0.1",
     "jest": "^28.1.0",
     "jest-serializer-path": "^0.1.15",
+    "lint-staged": "^13.0.0",
+    "pinst": "^3.0.0",
     "rollup": "^2.73.0",
     "rollup-plugin-bundle-size": "^1.0.3",
     "rollup-plugin-dts": "^4.2.1",
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "path": "node_modules/cz-customizable"`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+module.exports = {`
	`2`	`+ extends: ['cz'],`
	`3`	`+}`