feat: simple-git-hooks and commitlint (pmndrs#126)

* feat: simple git hooks and commitlint * fix: add git hook for prettier and tests * fix(package): remove prettier script, add as check on commit
isaac-mason · Oct 5, 2022 · b528066 · b528066
1 parent f0b9a89
commit b528066
Show file tree

Hide file tree

Showing 7 changed files with 517 additions and 74 deletions.
diff --git a/commitlint.config.js b/commitlint.config.js
@@ -0,0 +1 @@
+module.exports = { extends: ["@commitlint/config-conventional"] };
diff --git a/demo/package.json b/demo/package.json
@@ -19,7 +19,7 @@
     "three": "^0.139.2"
   },
   "devDependencies": {
-    "@vitejs/plugin-react": "^1.3.2",
+    "@vitejs/plugin-react": "^2.1.0",
     "typescript": "^4.6.3",
     "vite": "3.0.3"
   },

diff --git a/package.json b/package.json
@@ -24,11 +24,14 @@
     "@babel/preset-react": "^7.16.7",
     "@babel/preset-typescript": "^7.16.7",
     "@changesets/cli": "^2.22.0",
+    "@commitlint/cli": "^17.1.2",
+    "@commitlint/config-conventional": "^17.1.0",
     "@manypkg/cli": "^0.19.1",
     "@preconstruct/cli": "^2.1.5",
     "buffer": "^6.0.3",
     "np": "^7.6.1",
     "prettier": "2.7.1",
+    "simple-git-hooks": "^2.8.0",
     "typescript": "^4.6.3"
   },
   "scripts": {
@@ -38,11 +41,14 @@
     "dev": "preconstruct dev",
     "watch": "preconstruct watch",
     "demo": "cd demo && yarn dev",
-    "prettier": "prettier packages/ demo/ --write",
     "release": "yarn build && changeset publish",
     "test": "vitest run",
     "test:ui": "vitest --ui"
   },
+  "simple-git-hooks": {
+    "commit-msg": "npx --no -- commitlint --edit ${1}",
+    "pre-commit": "yarn prettier packages/ demo/ --check; yarn ci"
+  },
   "private": true,
   "workspaces": [
     "packages/*",

diff --git a/packages/react-three-rapier/CONTRIBUTING.md b/packages/react-three-rapier/CONTRIBUTING.md
@@ -0,0 +1,19 @@
+# Contributing to @react-three/fiber
+
+## Issues
+
+Feel free to submit issues and enhancement requests.
+
+## Contributing code
+
+In general, follow the "fork-and-pull" Git workflow.
+
+1.  **Fork** the repo on GitHub
+2.  **Clone** the project to your own machine
+3.  **Commit** changes to your own branch  
+    This project uses `commitlint` and `conventional-commits` for commit messages.  
+    Please follow the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) format.
+4.  **Push** your work back up to your fork
+5.  Submit a **Pull request** so that we can review your changes
+
+NOTE: Be sure to merge the latest from "upstream" before making a pull request!
diff --git a/packages/react-three-rapier/package.json b/packages/react-three-rapier/package.json
@@ -14,13 +14,13 @@
     "@react-three/test-renderer": "^8.0.17",
     "@types/react-dom": "^18.0.2",
     "@types/three": "^0.139.0",
+    "@vitejs/plugin-react": "^2.1.0",
     "@vitest/ui": "^0.23.4",
     "happy-dom": "^6.0.4",
     "react": "^18.1.0",
     "react-dom": "^18.1.0",
     "three": "^0.139.2",
-    "vitest": "^0.23.4",
-    "@vitejs/plugin-react": "^2.1.0"
+    "vitest": "^0.23.4"
   },
   "peerDependencies": {
     "@react-three/fiber": "^8.0.12",

diff --git a/packages/react-three-rapier/readme.md b/packages/react-three-rapier/readme.md
@@ -9,6 +9,8 @@
 
 <p align="center">⚠️ Under heavy development. All APIs are subject to change. ⚠️</p>
 
+For contributions, please read the [contributing guide](https://github.com/pmndrs/react-three-rapier/blob/main/packages/react-three-rapier/CONTRIBUTING.md).
+
 ## Usage
 
 ```tsx
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		module.exports = { extends: ["@commitlint/config-conventional"] };
-Original file line number
+Diff line change
@@ Expand Up / @@ -9,6 +9,8 @@ @@
     <p align="center">⚠️ Under heavy development. All APIs are subject to change. ⚠️</p>
+    For contributions, please read the [contributing guide](https://github.com/pmndrs/react-three-rapier/blob/main/packages/react-three-rapier/CONTRIBUTING.md).
     ## Usage
     ```tsx
@@ Expand Down @@