Configure husky (#877)

Signed-off-by: Christophe Bedard <[email protected]>

.eslintrc.json

@@ -20,11 +20,5 @@
 	},
 	"plugins": ["@typescript-eslint"],
 	"rules": {},
-        "ignorePatterns": [
-            "dist",
-            "coverage",
-            "*.md",
-            "*.yml",
-            "*.yaml"
-        ]
+	"ignorePatterns": ["dist", "coverage", "*.md", "*.yml", "*.yaml"]
 }

.husky/.gitignore

@@ -0,0 +1 @@
+_

.husky/pre-commit

@@ -0,0 +1 @@
+npx lint-staged

.lintstagedrc.js

@@ -1,7 +1,7 @@
 module.exports = {
 	"*": [
-		"eslint --cache --fix --ignore-path .eslintignore",
-		"prettier --write --ignore-path .eslintignore --ignore-unknown",
+		"eslint --cache --fix --config .eslintrc.json",
+		"prettier --write --config .prettierrc --ignore-path .prettierignore --ignore-unknown",
 		// Note: doing the build here ensures we omit unstaged changes
 		() => "npm run build",
 		() => "git add dist/index.js",

.prettierignore

@@ -0,0 +1,5 @@
+dist
+coverage
+*.md
+*.yml
+*.yaml

DEVELOPING.md

@@ -6,11 +6,23 @@ Install [Node.js](https://nodejs.org/en/download/).
 
 We are currently using Node.js v20.
 
-## Build and test
+## Install dependencies
 
-```
-# install dependencies
+```sh
 npm install
+```
+
+## Setup git hooks
+
+This will setup git hooks to run linters, generate build artifacts, and run tests when committing (pre-commit).
+
+```sh
+npm run prepare
+```
+
+## Build and test
+
+```sh
 # autoformat sources to meet enforced linter style
 npm run fixup
 # generate build artifacts

package.json

@@ -4,9 +4,11 @@
 	"description": "GitHub Action compiling and testing a ROS 2 package",
 	"main": "lib/main.js",
 	"scripts": {
+		"prepare": "husky",
 		"build": "ncc build src/run.ts -o dist",
 		"fixup": "eslint . --fix",
 		"lint": "eslint .",
+		"prettier": "prettier --write .",
 		"test": "tsc --noEmit && jest --coverage"
 	},
 	"repository": {