Merge pull request #7 from forumone/husky-setup

Husky setup

Author: mdrayer

.github/workflows/checks.yml

@@ -3,36 +3,6 @@ name: Code checks
 on: [pull_request]
 
 jobs:
-  prettier:
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [16.x]
-
-    steps:
-      - name: Checkout commit
-        uses: actions/checkout@v2
-
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2
-        with:
-          node-version: ${{ matrix.node-version }}
-
-      - name: Cache NPM
-        uses: actions/cache@v2
-        with:
-          path: ~/.npm
-          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-node-
-
-      - name: Install packages
-        run: npm ci
-
-      - name: Run Prettier
-        run: npm run prettier
-
   lint:
     runs-on: ubuntu-latest
 

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm test

README.md

@@ -92,6 +92,18 @@ npm run tsc
 
 Runs `tsc --noEmit`, which will compile the TypeScript code without emitting files. This acts as a TS error check in your CLI. This is useful to catch TS errors that you might miss during development. For more information, see the [TypeScript Compiler (tsc) documentation](https://www.typescriptlang.org/docs/handbook/compiler-options.html).
 
+## Husky
+
+This project uses [Husky](https://typicode.github.io/husky/#/) to check code on git commits. By default, it is setup to use the `npm test` script which runs `lint` and `tsc` (TypeScript) checks against the codebase. This check occurs on `git commit` attempts. This helps developers catch errors _before_ pushing branches and creating PRs, quickening the overall dev worklow.
+
+To bypass this check, you can use the `--no-verify` flag with your commit:
+
+```bash
+git commit -m "This will not get checked by Husky." --no-verify
+```
+
+Note that bypassing the Husky check is frowned upon.
+
 ## Notes
 
 * Code for the app is currently configured to go into the `pages` directory (for [Next.js pages](https://nextjs.org/docs/basic-features/pages)) and `source` for theming, components, providers, helpers, etc.

package-lock.json

@@ -10,7 +10,9 @@
     "lint": "next lint",
     "prettier": "prettier --check pages/ source/",
     "prettier:write": "prettier --write pages/ source/",
-    "tsc": "tsc --noEmit"
+    "tsc": "tsc --noEmit",
+    "test": "npm run lint && npm run tsc",
+    "prepare": "husky install"
   },
   "dependencies": {
     "@emotion/css": "^11.9.0",
@@ -32,6 +34,7 @@
     "eslint-config-next": "^12.1.5",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-prettier": "^4.0.0",
+    "husky": "^7.0.4",
     "prettier": "^2.6.2",
     "prettier-plugin-organize-imports": "^2.3.4",
     "typescript": "^4.6.3"