feat: use lefthook for precommit hook

Add a precommit that helps keep code in check as we work

PR: #2

.lefthook.toml

@@ -0,0 +1,16 @@
+skip_output = ['meta', 'execution', 'empty_summary']
+
+[pre-commit]
+parallel = true
+
+[pre-commit.commands.biome]
+glob = "*.{json,ts}"
+run = "node_modules/.bin/biome check --no-errors-on-unmatched --files-ignore-unknown=true {staged_files}"
+
+[pre-commit.commands.test]
+glob = "*.ts"
+run = "bun test"
+
+[pre-commit.commands.typos]
+glob = "*.{md,mdoc,mdx}"
+run = "typos {staged_files}"

CONTRIBUTING.md

@@ -39,6 +39,8 @@ are more sensitive, emailed to <[email protected]>.
 
 To install Topsort.js as a contributor, you need to have Bun installed on your machine. Follow the instructions on the [Bun website](https://bun.sh/) to install it.
 
+You will also need [typos][https://github.com/crate-ci/typos] for validating documentation. Install it through your package manager (on MacOS: `brew install typos-cli`)
+
 Clone the repository and install the dependencies:
 
 ```sh
@@ -120,4 +122,4 @@ The SDK uses following configuration files:
 `tsup.config.ts`: Configuration for the TSUP bundler.
 
 ## License
-This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.

biome.json

@@ -4,8 +4,7 @@
     "enabled": true
   },
   "files": {
-    "ignoreUnknown": true,
-    "ignore": ["dist/**"]
+    "ignoreUnknown": true
   },
   "json": {
     "formatter": {

package.json

@@ -24,14 +24,15 @@
     "README.md"
   ],
   "scripts": {
-    "build": "rm -rf dist && bun run tsup",
-    "test": "bun test",
+    "build": "tsup",
     "format": "biome check",
-    "format:fix": "biome check --write"
+    "format:fix": "biome check --write",
+    "prepare": "lefthook install"
   },
   "devDependencies": {
     "@biomejs/biome": "1.8.3",
     "@types/bun": "1.1.6",
+    "lefthook": "1.7.2",
     "msw": "2.3.1",
     "tsup": "8.1.0",
     "typescript": "5.5.3"