ts-suppress 0.2.0 → 0.3.0

package/README.md

@@ -4,67 +4,69 @@ Incremental TypeScript strictness adoption via bulk error suppression.
 
 Instead of scattering `@ts-ignore` or `@ts-expect-error` comments throughout your codebase, `ts-suppress` captures all TypeScript errors into a single `.ts-suppressions.json` file. This lets you enable stricter compiler options immediately and fix errors at your own pace.
 
-## How It Works
-
-Each suppression is a fingerprint of a TypeScript error, consisting of:
-
-- **file** — relative path to the source file
-- **code** — TypeScript error code (e.g. `2322`)
-- **hash** — hex hash of the diagnostic message text
-- **scope** — dot-separated scope chain (e.g. `MyClass.myMethod`)
-
-The `check` command diffs the current diagnostics against the suppression file and reports:
-
-- **Unsuppressed errors** — new errors not yet in the suppression file
-- **Stale suppressions** — entries that no longer match any current error (i.e. errors that have been fixed)
-
 ## Install
 
 ```bash
-bun add -d ts-suppress
+npm install -D ts-suppress
 ```
 
-## Usage
-
-### `init`
-
-Create an empty `.ts-suppressions.json`:
-
 ```bash
-bunx ts-suppress init
+pnpm add -D ts-suppress
 ```
 
-### `suppress`
-
-Snapshot all current TypeScript errors into `.ts-suppressions.json`:
+```bash
+yarn add -D ts-suppress
+```
 
 ```bash
-bunx ts-suppress suppress
+bun add -d ts-suppress
 ```
 
-### `check`
+> **Note:** TypeScript >= 5.9.3 is a peer dependency.
 
-Verify that all errors are suppressed and no suppressions are stale. Exits non-zero on failure — useful in CI:
+## Usage
 
 ```bash
-bunx ts-suppress check
-```
+# Create an empty .ts-suppressions.json
+npx ts-suppress init
 
-### `update`
+# Snapshot all current TypeScript errors
+npx ts-suppress suppress
 
-Add new suppressions and remove stale ones in a single pass:
+# Verify all errors are suppressed and no suppressions are stale (useful in CI)
+npx ts-suppress check
 
-```bash
-bunx ts-suppress update
+# Add new suppressions and remove stale ones in a single pass
+npx ts-suppress update
 ```
 
-Also available as `bunx ts-suppress fix`.
-
 ## Typical Workflow
 
 1. Enable a stricter TypeScript option (e.g. `"strict": true`)
-2. Run `bunx ts-suppress suppress` to baseline all existing errors
+2. Run `npx ts-suppress suppress` to baseline all existing errors
 3. Commit `.ts-suppressions.json`
-4. Add `bunx ts-suppress check` to CI
+4. Add `npx ts-suppress check` to CI
 5. Fix errors over time — `check` will flag stale suppressions as you go
-6. Run `bunx ts-suppress update` to sync the suppression file after fixing errors
+6. Run `npx ts-suppress update` to sync the suppression file after fixing errors
+
+## How It Works
+
+Each suppression is a fingerprint of a TypeScript error, consisting of:
+
+- **file** — relative path to the source file
+- **code** — TypeScript error code (e.g. `2322`)
+- **hash** — hex hash of the diagnostic message text
+- **scope** — dot-separated scope chain (e.g. `MyClass.myMethod`)
+
+The `check` command diffs the current diagnostics against the suppression file and reports:
+
+- **Unsuppressed errors** — new errors not yet in the suppression file
+- **Stale suppressions** — entries that no longer match any current error (i.e. errors that have been fixed)
+
+## Acknowledgements
+
+Inspired by ideas from [ts-bulk-suppress](https://github.com/tiktok/ts-bulk-suppress) by TikTok, specifically the approach of capturing TypeScript errors into an external suppression file rather than using inline ignore comments.
+
+## License
+
+MIT

package/dist/cli.js

@@ -1,4 +1,5 @@
-import { parse } from "@bomb.sh/args";
+#!/usr/bin/env node
+import mri from "mri";
 import { createProject } from "./project.js";
 import { runCheck } from "./commands/check.js";
 import { runInit } from "./commands/init.js";
@@ -16,7 +17,7 @@ function printHelp() {
     const lines = commands.map(([name, desc]) => `  ${name.padEnd(longest + 4)}${desc}`);
     console.log(`ts-suppress v${VERSION}\nIncremental TypeScript strictness adoption via bulk error suppression\n\nCommands:\n${lines.join("\n")}\n\nRun ts-suppress <command> --help for details.`);
 }
-const args = parse(process.argv.slice(2), {
+const args = mri(process.argv.slice(2), {
     boolean: ["help", "version"],
     alias: { h: "help", v: "version" },
 });

package/dist/scope.js

@@ -1,4 +1,3 @@
-// src/scope.ts
 import { Node } from "ts-morph";
 /**
  * Build a dot-separated scope path by walking up the AST from a node.

package/dist/test-helpers.js

@@ -0,0 +1,15 @@
+import { Project, ScriptTarget } from "ts-morph";
+export function createInMemoryProject(files) {
+    const project = new Project({
+        useInMemoryFileSystem: true,
+        compilerOptions: {
+            strict: true,
+            target: ScriptTarget.ESNext,
+            lib: ["lib.esnext.full.d.ts"],
+        },
+    });
+    for (const [name, content] of Object.entries(files)) {
+        project.createSourceFile(name, content);
+    }
+    return project;
+}

package/dist/types.js

@@ -1,2 +1 @@
-// src/types.ts
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-suppress",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Incremental TypeScript strictness adoption via bulk error suppression",
   "keywords": [
     "migration",
@@ -31,24 +31,11 @@
     "!skills/_artifacts"
   ],
   "type": "module",
-  "scripts": {
-    "build": "tsc -p tsconfig.build.json",
-    "test": "bun test",
-    "prepublishOnly": "bun run build",
-    "fmt": "oxfmt",
-    "fmt:check": "oxfmt --check",
-    "knip": "knip",
-    "lint": "oxlint",
-    "lint:fix": "oxlint --fix",
-    "prepare": "husky",
-    "typecheck": "tsc --noEmit"
-  },
   "dependencies": {
-    "@bomb.sh/args": "^0.3.1",
+    "mri": "^1.2.0",
     "ts-morph": "^27.0.2"
   },
   "devDependencies": {
-    "@types/bun": "latest",
     "@types/node": "^24",
     "husky": "^9.1.7",
     "knip": "^5.87.0",
@@ -56,13 +43,21 @@
     "oxfmt": "^0.41.0",
     "oxlint": "^1.56.0",
     "oxlint-tsgolint": "^0.17.0",
-    "typescript": "^5.9.3"
+    "tsx": "^4.19.4",
+    "typescript": "^5.9.3",
+    "vitest": "^3.2.1"
   },
   "peerDependencies": {
     "typescript": "^5.9.3"
   },
-  "lint-staged": {
-    "*.{js,jsx,ts,tsx,mjs,cjs}": "bun run lint",
-    "*": "oxfmt --no-error-on-unmatched-pattern"
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "test": "vitest run",
+    "fmt": "oxfmt",
+    "fmt:check": "oxfmt --check",
+    "knip": "knip",
+    "lint": "oxlint",
+    "lint:fix": "oxlint --fix",
+    "typecheck": "tsc --noEmit"
   }
-}
+}