chore: update Biome config and add package.json fields

laserware · Jan 7, 2025 · cea6da5 · cea6da5
1 parent 6192549
commit cea6da5
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 16 deletions.
diff --git a/biome.jsonc b/biome.jsonc
@@ -13,9 +13,7 @@
     "enabled": true,
     "indentStyle": "space",
     "lineWidth": 80,
-    // We use Prettier to format test files because we can't override the line
-    // width based on directory/extension:
-    "ignore": ["**/*.test.ts"]
+    "ignore": ["./package.json"]
   },
   "organizeImports": {
     "enabled": true
@@ -41,5 +39,21 @@
     "formatter": {
       "quoteStyle": "double"
     }
-  }
+  },
+  "overrides": [
+    {
+      "include": ["src/**/*.test.ts"],
+      "formatter": {
+        "lineWidth": 100
+      },
+      "linter": {
+        "rules": {
+          "recommended": true,
+          "style": {
+            "noNonNullAssertion": "off"
+          }
+        }
+      }
+    }
+  ]
 }
diff --git a/package.json b/package.json
@@ -2,12 +2,13 @@
   "name": "@laserware/keytar",
   "version": "3.0.2",
   "description": "Handle keyboard and mouse events in the browser.",
-  "author": "Mike Rourke <mike.w.rourke@gmail.com>",
+  "author": "Mike Rourke <mike.w.rourke@gmail.com> (https://mikerourke.dev/)",
   "license": "MIT",
   "repository": {
     "url": "git+https://github.com/laserware/keytar.git",
     "type": "git"
   },
+  "homepage": "https://laserware.github.io/keytar/",
   "type": "module",
   "browser": "dist/index.mjs",
   "main": "dist/index.mjs",
@@ -39,7 +40,6 @@
     "docs:generate": "typedoc  --options typedoc.json",
     "docs:serve": "mkdir -p ./site && cd ./site && bunx vite",
     "format": "biome check --formatter-enabled=true --linter-enabled=false --organize-imports-enabled=true --write src",
-    "format:tests": "bunx prettier \"src/**/*.test.ts\" --write --print-width 100",
     "lint": "biome lint src",
     "test": "bun test",
     "typecheck": "tsc --noEmit"

diff --git a/src/__tests__/isChordPressed.test.ts b/src/__tests__/isChordPressed.test.ts
@@ -6,7 +6,7 @@ import { Key, Modifier, MouseButton, MouseEventButton } from "../types.ts";
 
 describe("the isChordPressed function", () => {
   describe("returns true if requirements are met for keyboard events", () => {
-    // prettier-ignore
+    // biome-ignore format:
     it.each([
       {
         event: new KeyboardEvent("keydown", { key: "B", altKey: false, ctrlKey: false, metaKey: false, shiftKey: false }),
@@ -46,7 +46,7 @@ describe("the isChordPressed function", () => {
   });
 
   describe("returns false if requirements are not met for keyboard events", () => {
-    // prettier-ignore
+    // biome-ignore format:
     it.each([
       {
         event: new KeyboardEvent("keydown", { key: "B", altKey: true, ctrlKey: false, metaKey: false, shiftKey: false }),
@@ -81,7 +81,7 @@ describe("the isChordPressed function", () => {
   });
 
   describe("when the Command key is specified", () => {
-    // prettier-ignore
+    // biome-ignore format:
     it.each([
       // Command modifier:
       {
@@ -173,7 +173,7 @@ describe("the isChordPressed function", () => {
   });
 
   it("returns true if only modifiers are specified with no key", () => {
-    // prettier-ignore
+    // biome-ignore format:
     const event = new KeyboardEvent("keydown", { altKey: true, ctrlKey: true, metaKey: false, shiftKey: true });
 
     const result = isChordPressed(event, Modifier.Ctrl | Modifier.Alt | Modifier.Shift);
@@ -182,7 +182,7 @@ describe("the isChordPressed function", () => {
   });
 
   it("returns true if mouse buttons are specified and are clicked", () => {
-    // prettier-ignore
+    // biome-ignore format:
     const event = new MouseEvent("mousedown", { altKey: true, ctrlKey: false, metaKey: false, shiftKey: false, buttons: MouseEventButton.Left });
 
     const result = isChordPressed(event, Modifier.Alt | MouseButton.Left);
@@ -192,7 +192,7 @@ describe("the isChordPressed function", () => {
 
   describe("when checking for CmdOrCtrl", () => {
     it("clears the Cmd key on macOS", () => {
-      // prettier-ignore
+      // biome-ignore format:
       const event = new KeyboardEvent("keydown", { altKey: false, ctrlKey: true, metaKey: true, shiftKey: false });
 
       const result = isChordPressed(event, Modifier.CmdOrCtrl | Modifier.Ctrl);
@@ -205,7 +205,7 @@ describe("the isChordPressed function", () => {
         isPlatform: (platform: string) => platform !== "mac",
       }));
 
-      // prettier-ignore
+      // biome-ignore format:
       const event = new KeyboardEvent("keydown", { altKey: false, ctrlKey: true, metaKey: false, shiftKey: false });
 
       const result = isChordPressed(event, Modifier.CmdOrCtrl);
@@ -215,7 +215,7 @@ describe("the isChordPressed function", () => {
   });
 
   it("handles Shift and Shift + Tab", () => {
-    // prettier-ignore
+    // biome-ignore format:
     const event = new KeyboardEvent("keydown", { key: "Tab", altKey: false, ctrlKey: false, metaKey: false, shiftKey: true });
 
     const result = isChordPressed(event, Key.Tab, Modifier.Shift | Key.Tab);
@@ -224,7 +224,7 @@ describe("the isChordPressed function", () => {
   });
 
   describe("returns true if requirements are met for mouse events", () => {
-    // prettier-ignore
+    // biome-ignore format:
     it.each([
       {
         event: new MouseEvent("keydown", { buttons: MouseEventButton.Left, altKey: false, ctrlKey: false, metaKey: false, shiftKey: false }),

diff --git a/tsconfig.json b/tsconfig.json
@@ -15,9 +15,10 @@
     "sourceMap": false,
     "strict": true,
     "strictNullChecks": true,
+    "stripInternal": true,
     "target": "ESNext",
     "verbatimModuleSyntax": true
   },
-  "include": ["src"],
+  "include": ["src", "./test.setup.ts", "./tsup.config.ts"],
   "exclude": ["dist", "node_modules"]
 }
diff --git a/typedoc.json b/typedoc.json
@@ -1,4 +1,5 @@
 {
+  "$schema": "https://typedoc.org/schema.json",
   "cleanOutputDir": true,
   "entryPoints": ["./src/index.ts"],
   "exclude": ["**/**test.ts"],