From bddc9a6c503f32d89f2b783c5cfa23d09b9e2410 Mon Sep 17 00:00:00 2001 From: Wade Baglin Date: Mon, 20 Jun 2022 16:34:05 +1000 Subject: [PATCH] chore: add githook to lint commit message before commit --- .husky/commit-msg | 4 ++++ package-lock.json | 22 ++++++++++++++++++++++ package.json | 8 +++++--- 3 files changed, 31 insertions(+), 3 deletions(-) create mode 100644 .husky/commit-msg diff --git a/.husky/commit-msg b/.husky/commit-msg new file mode 100644 index 0000000..35ed753 --- /dev/null +++ b/.husky/commit-msg @@ -0,0 +1,4 @@ +#!/usr/bin/env sh +. "$(dirname -- "$0")/_/husky.sh" + +npm run commitlint diff --git a/package-lock.json b/package-lock.json index 3e39c42..fbf55ef 100644 --- a/package-lock.json +++ b/package-lock.json @@ -20,6 +20,7 @@ "eslint-config-prettier": "^8.5.0", "eslint-plugin-node": "^11.1.0", "eslint-plugin-prettier": "^4.0.0", + "husky": "^8.0.1", "jest": "^28.1.1", "prettier": "^2.7.0", "semantic-release": "^19.0.3", @@ -4038,6 +4039,21 @@ "node": ">=10.17.0" } }, + "node_modules/husky": { + "version": "8.0.1", + "resolved": "https://registry.npmjs.org/husky/-/husky-8.0.1.tgz", + "integrity": "sha512-xs7/chUH/CKdOCs7Zy0Aev9e/dKOMZf3K1Az1nar3tzlv0jfqnYtu235bstsWTmXOR0EfINrPa97yy4Lz6RiKw==", + "dev": true, + "bin": { + "husky": "lib/bin.js" + }, + "engines": { + "node": ">=14" + }, + "funding": { + "url": "https://github.com/sponsors/typicode" + } + }, "node_modules/ignore": { "version": "5.2.0", "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.2.0.tgz", @@ -13527,6 +13543,12 @@ "integrity": "sha512-B4FFZ6q/T2jhhksgkbEW3HBvWIfDW85snkQgawt07S7J5QXTk6BkNV+0yAeZrM5QpMAdYlocGoljn0sJ/WQkFw==", "dev": true }, + "husky": { + "version": "8.0.1", + "resolved": "https://registry.npmjs.org/husky/-/husky-8.0.1.tgz", + "integrity": "sha512-xs7/chUH/CKdOCs7Zy0Aev9e/dKOMZf3K1Az1nar3tzlv0jfqnYtu235bstsWTmXOR0EfINrPa97yy4Lz6RiKw==", + "dev": true + }, "ignore": { "version": "5.2.0", "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.2.0.tgz", diff --git a/package.json b/package.json index f4e4355..f261d91 100644 --- a/package.json +++ b/package.json @@ -27,7 +27,8 @@ "lint": "eslint ./src/ --ext .ts", "lint:fix": "eslint ./src/ --ext .ts --fix", "commitlint": "commitlint --edit -o", - "generate-doc": "typedoc src/" + "generate-doc": "typedoc src/", + "prepare": "husky install" }, "repository": { "type": "git", @@ -38,17 +39,18 @@ }, "peeprDependencies": {}, "devDependencies": { + "@commitlint/cli": "^17.0.2", + "@commitlint/config-conventional": "^17.0.2", "@types/jest": "^28.1.1", "@types/node": "^17.0.42", "@typescript-eslint/eslint-plugin": "^5.28.0", "@typescript-eslint/parser": "^5.28.0", - "@commitlint/cli": "^17.0.2", - "@commitlint/config-conventional": "^17.0.2", "conventional-changelog-conventionalcommits": "^5.0.0", "eslint": "^8.17.0", "eslint-config-prettier": "^8.5.0", "eslint-plugin-node": "^11.1.0", "eslint-plugin-prettier": "^4.0.0", + "husky": "^8.0.1", "jest": "^28.1.1", "prettier": "^2.7.0", "semantic-release": "^19.0.3",