chore: bundle package with tsc

commaai · Jan 18, 2025 · 84c1ace · 84c1ace
1 parent fcddad7
commit 84c1ace
Show file tree

Hide file tree

Showing 5 changed files with 49 additions and 5 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,8 @@
 # Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore
 
+# Build artifacts
+dist/
+
 # Logs
 
 logs

diff --git a/README.md b/README.md
@@ -1 +1,17 @@
 # qdl.js
+
+**Test**
+
+Run tests in watch mode
+
+```sh
+bun test --watch
+```
+
+**Build**
+
+Bundles JS and generates type declarations
+
+```sh
+bun run build
+```
diff --git a/bun.lockb b/bun.lockb
diff --git a/package.json b/package.json
@@ -3,14 +3,30 @@
   "version": "0.1.0",
   "license": "MIT",
   "type": "module",
+  "main": "dist/qdl.js",
+  "types": "dist/qdl.d.ts",
   "exports": {
-    ".": "./src/qdl.js",
-    "./utils": "./src/utils.js"
+    ".": {
+      "types": "./dist/qdl.d.ts",
+      "import": "./dist/qdl.js"
+    },
+    "./utils": {
+      "types": "./dist/utils.d.ts",
+      "import": "./dist/utils.js"
+    }
+  },
+  "scripts": {
+    "build": "rm -rf dist && tsc",
+    "postinstall": "bun run build"
   },
   "devDependencies": {
+    "@types/bun": "latest",
     "@types/w3c-web-usb": "^1.0.10"
   },
   "dependencies": {
     "crc-32": "^1.2.2"
+  },
+  "peerDependencies": {
+    "typescript": "^5.0.0"
   }
 }
diff --git a/jsconfig.json → tsconfig.json b/jsconfig.json → tsconfig.json
@@ -10,9 +10,16 @@
 
     // Bundler mode
     "moduleResolution": "bundler",
-    "allowImportingTsExtensions": true,
     "verbatimModuleSyntax": true,
-    "noEmit": true,
+
+    // Compilation
+    "outDir": "dist",
+    "declaration": true,
+    "sourceMap": true,
+    "incremental": true,
+    "tsBuildInfoFile": "node_modules/.tsbuildinfo",
+    // TODO: enable after disabling allowJs
+    // "isolatedDeclarations": true,
 
     // Best practices
     "strict": true,
@@ -21,5 +28,7 @@
     "noUnusedLocals": true,
     "noUnusedParameters": true,
     "noPropertyAccessFromIndexSignature": true
-  }
+  },
+  "include": ["src/*.js"],
+  "exclude": ["src/*.spec.js", "dist", "node_modules"],
 }