type-a-bin 0.1.0 → 0.1.2

package/README.md

@@ -57,6 +57,7 @@ fully typed, dependency-free library with richer features.
 - [Packages](#packages)
 - [Prerequisites](#prerequisites)
 - [Scripts](#scripts)
+- [Releasing](#releasing)
 - [How it works under the hood](#how-it-works-under-the-hood)
 - [Windows support](#windows-support)
 - [Comparison with other tools](#comparison-with-other-tools)
@@ -74,12 +75,12 @@ slow, fragile, and impossible to reproduce deterministically.
 
 There are a few common workarounds, each with drawbacks:
 
-| Approach              | Problem                                                  |
-|-----------------------|----------------------------------------------------------|
-| Stub `child_process`  | Couples tests to the module boundary; misses edge cases. |
-| `nock` / HTTP mocking | Only works for HTTP, not arbitrary binaries.             |
-| Real binaries in CI   | Slow, requires secrets, produces flaky tests.            |
-| **Type-A-Bin**        | Mocks *any* binary at the `PATH` level — transparently.  |
+| Approach | Problem |
+|----|----|
+| Stub `child_process` | Couples tests to the module boundary; misses edge cases. |
+| `nock` / HTTP mocking | Only works for HTTP, not arbitrary binaries. |
+| Real binaries in CI | Slow, requires secrets, produces flaky tests. |
+| **Type-A-Bin** | Mocks *any* binary at the `PATH` level — transparently. |
 
 Type-A-Bin works by creating a temporary executable with the same name
 as the target binary and prepending its directory to `PATH`. When your
@@ -462,10 +463,10 @@ The function is overloaded with three signatures:
 mockBin(binNameOrConfig, output): Promise<MockBinCleanup>
 ```
 
-| Parameter         | Type                      | Description                                         |
-|-------------------|---------------------------|-----------------------------------------------------|
+| Parameter | Type | Description |
+|----|----|----|
 | `binNameOrConfig` | `string \| MockBinConfig` | Binary name, or a config with `binName` + `pattern` |
-| `output`          | `string`                  | The text the mock echoes (via `bash`)               |
+| `output` | `string` | The text the mock echoes (via `bash`) |
 
 Mocks the binary so that every invocation prints `output`. The fastest
 way to stub a command that just needs to return a string.
@@ -476,11 +477,11 @@ way to stub a command that just needs to return a string.
 mockBin(binNameOrConfig, shebang, code): Promise<MockBinCleanup>
 ```
 
-| Parameter         | Type                      | Description                                         |
-|-------------------|---------------------------|-----------------------------------------------------|
+| Parameter | Type | Description |
+|----|----|----|
 | `binNameOrConfig` | `string \| MockBinConfig` | Binary name, or a config with `binName` + `pattern` |
-| `shebang`         | `string`                  | Interpreter (e.g. `"bash"`, `"node"`)               |
-| `code`            | `string`                  | The script body that runs when the mock is invoked  |
+| `shebang` | `string` | Interpreter (e.g. `"bash"`, `"node"`) |
+| `code` | `string` | The script body that runs when the mock is invoked |
 
 Gives full control. The `shebang` accepts a bare interpreter name
 (wrapped in `#!/usr/bin/env …` automatically) or a full shebang line.
@@ -491,11 +492,11 @@ Gives full control. The `shebang` accepts a bare interpreter name
 mockBin(binNameOrConfig, shebang, script): Promise<MockBinCleanup>
 ```
 
-| Parameter         | Type                      | Description                                         |
-|-------------------|---------------------------|-----------------------------------------------------|
+| Parameter | Type | Description |
+|----|----|----|
 | `binNameOrConfig` | `string \| MockBinConfig` | Binary name, or a config with `binName` + `pattern` |
-| `shebang`         | `string`                  | Interpreter used to run the file                    |
-| `script`          | `MockBinScriptFile`       | `{ file: string }` pointing at a script on disk     |
+| `shebang` | `string` | Interpreter used to run the file |
+| `script` | `MockBinScriptFile` | `{ file: string }` pointing at a script on disk |
 
 Runs a script file through the given interpreter, keeping the file’s
 original extension so extension-aware loaders (e.g. `node --import tsx`)
@@ -539,9 +540,10 @@ library lives at the root; additional packages live under `packages/`:
 
 - [Node.js](https://nodejs.org) 26 and [pnpm](https://pnpm.io) (enforced
   via `engines` in `package.json`)
-- [pandoc](https://pandoc.org) ≥ 3.1 — only needed for Markdown
-  formatting/linting (`pnpm lint:md` / `pnpm format:md`), not for using
-  the library
+- [pandoc](https://pandoc.org) ≥ 3.10 — only needed for the Markdown
+  steps of `pnpm lint` / `pnpm format` (which run through
+  [ts-canon](https://github.com/SynthLuvr/ts-canon)), not for using the
+  library
 - On Windows: [Git for Windows](https://gitforwindows.org/) — its bash
   powers bash-interpreter mocks (node-interpreter mocks need nothing
   beyond Node itself)
@@ -550,13 +552,46 @@ library lives at the root; additional packages live under `packages/`:
 
 Run from the repository root:
 
-| Script            | Description                                           |
-|-------------------|-------------------------------------------------------|
-| `pnpm build`      | Build the library (and workspace packages) to `dist/` |
-| `pnpm test`       | Build, run unit tests, then run workspace tests       |
-| `pnpm lint`       | Run all linters (Biome, oxlint, ast-grep, pandoc)     |
-| `pnpm format`     | Run all formatters with auto-fix                      |
-| `pnpm test:watch` | Run unit tests in watch mode                          |
+| Script | Description |
+|----|----|
+| `pnpm build` | Build the library (and workspace packages) to `dist/` |
+| `pnpm test` | Build, run unit tests, then run workspace tests |
+| `pnpm lint` | Run all linters via ts-canon (Biome, oxlint, ast-grep, pandoc, peer-deps, audit, jscpd) |
+| `pnpm format` | Run all formatters via ts-canon with auto-fix |
+| `pnpm test:watch` | Run unit tests in watch mode |
+
+## Releasing
+
+Releases are published to npm by the manually triggered [Release
+workflow](https://github.com/SynthLuvr/type-a-bin/actions/workflows/release.yml)
+using OIDC trusted publishing — no npm token is stored in the
+repository.
+
+One-time setup on npm (required before the workflow can publish): on
+npmjs.com, open the package **type-a-bin → Settings → Trusted
+publishing** and add a GitHub Actions publisher with repository owner
+`SynthLuvr`, repository `type-a-bin`, workflow filename `release.yml`,
+an *empty* environment, and the `npm publish` action allowed.
+
+To cut a release, run the workflow from `main` with a semver `bump` or
+an exact `version`. It builds, tests, publishes to npm with provenance,
+then lands the version bump on `main` via an automatically merged pull
+request (the `main` ruleset requires all changes to go through a PR, so
+the workflow cannot push to `main` directly), pushes the `vX.Y.Z` tag,
+and opens the GitHub release. If the version is already on npm — e.g. a
+previous run published but failed later — publish is skipped and only
+the remaining bookkeeping runs, so re-running the same version is safe.
+
+If publishing fails, the workflow annotates the run with the fix. Both
+known registry rejections are auth or provenance problems, not problems
+with the package itself:
+
+- `E404 Not Found - PUT https://registry.npmjs.org/type-a-bin` — npm
+  masks a rejected OIDC exchange as a 404: the trusted-publisher entry
+  is missing or does not match the exact values above.
+- `E422` — provenance requires `package.json` to carry `repository.url`
+  matching the GitHub repository
+  (`https://github.com/SynthLuvr/type-a-bin`).
 
 ## How it works under the hood
 
@@ -648,17 +683,17 @@ any process that is not a mock shim.
 
 ## Comparison with other tools
 
-| Feature                            | Type-A-Bin | [mock-bin](https://github.com/stevemao/mock-bin) | [mock-a-bin](https://github.com/levibostian/mock-a-bin) |
-|------------------------------------|:----------:|:------------------------------------------------:|:-------------------------------------------------------:|
-| Mocks any binary via `PATH`        |     ✅     |                        ✅                        |                           ✅                            |
-| Runtime dependencies               |     0      |                     several                      |                     several (Deno)                      |
-| TypeScript types & overloads       |     ✅     |                        ❌                        |                         partial                         |
-| Output shorthand                   |     ✅     |                        ❌                        |                           ❌                            |
-| Script-file mode (keeps extension) |     ✅     |                        ❌                        |                           ❌                            |
-| Pattern-based conditional mocking  |     ✅     |                        ❌                        |                           ❌                            |
-| `run-original` pass-through        |     ✅     |                        ❌                        |                           ✅                            |
-| Cleanup function                   |     ✅     |                        ✅                        |                           ✅                            |
-| Runtime                            |  Node.js   |                     Node.js                      |                          Deno                           |
+| Feature | Type-A-Bin | [mock-bin](https://github.com/stevemao/mock-bin) | [mock-a-bin](https://github.com/levibostian/mock-a-bin) |
+|----|:--:|:--:|:--:|
+| Mocks any binary via `PATH` | ✅ | ✅ | ✅ |
+| Runtime dependencies | 0 | several | several (Deno) |
+| TypeScript types & overloads | ✅ | ❌ | partial |
+| Output shorthand | ✅ | ❌ | ❌ |
+| Script-file mode (keeps extension) | ✅ | ❌ | ❌ |
+| Pattern-based conditional mocking | ✅ | ❌ | ❌ |
+| `run-original` pass-through | ✅ | ❌ | ✅ |
+| Cleanup function | ✅ | ✅ | ✅ |
+| Runtime | Node.js | Node.js | Deno |
 
 ## Contributing
 

package/dist/mock-bin.js

@@ -36,9 +36,8 @@ const toShebangLine = (interpreter) => interpreter.startsWith("#!") ? interprete
 const resolveScriptFile = async (shebang, { file }) => {
     const resolvedFile = path.resolve(file);
     const stats = await stat(resolvedFile).catch(() => null);
-    if (!stats?.isFile()) {
+    if (!stats?.isFile())
         throw new Error(`mockBin: script file not found: ${file}`);
-    }
     // Accept either a bare interpreter ("node --import tsx") or a full
     // shebang line ("#!/usr/bin/env node"); strip "#!" for the exec line.
     const interpreter = shebang.startsWith("#!")

package/package.json

@@ -1,8 +1,12 @@
 {
   "name": "type-a-bin",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Mock any executable binary for testing in Node.js",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/SynthLuvr/type-a-bin"
+  },
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -15,43 +19,26 @@
   "files": [
     "dist"
   ],
+  "packageManager": "pnpm@11.24.0",
   "engines": {
     "node": "==26"
   },
-  "devDependencies": {
-    "@ast-grep/cli": "^0.44.1",
-    "@ast-grep/cli-linux-x64-gnu": "^0.44.1",
-    "@biomejs/biome": "^2.5.4",
-    "@types/node": "^26.1.1",
-    "convert-to-arrow": "^1.1.4",
-    "del-cli": "^7.0.0",
-    "npm-run-all2": "^9.0.2",
-    "oxlint": "^1.74.0",
-    "oxlint-tsgolint": "^0.25.0",
-    "tsx": "^4.23.1",
-    "typescript": "^7.0.2",
-    "vitest": "^4.1.10"
-  },
   "scripts": {
-    "build:lib": "pnpm del-cli dist && pnpm tsc && pnpm del-cli dist/tests",
+    "build:lib": "del-cli dist && tsc && del-cli dist/tests",
     "build": "pnpm build:lib && pnpm -r build",
-    "format:arrows": "pnpm convert-to-arrow \"{src,packages/*/src}/**/*.{ts,tsx}\"",
-    "format:biome": "pnpm biome format --write .",
-    "format:braces": "pnpm strip-braces .",
-    "format:check": "pnpm biome check --write .",
-    "format": "npm-run-all format:arrows format:braces format:biome format:check format:md",
-    "lint:biome": "pnpm biome check .",
-    "lint:oxlint": "pnpm oxlint .",
-    "lint": "npm-run-all lint:biome lint:oxlint lint:exports lint:functions lint:file-comment lint:md lint:peer-deps",
-    "strip-braces": "pnpm exec ast-grep scan --rule .ast-grep/rules/strip-braces.yml -U",
-    "lint:exports": "pnpm exec ast-grep scan --rule .ast-grep/rules/no-inline-export.yml --error=no-inline-export --globs '!**/*.d.ts' .",
-    "lint:functions": "pnpm exec ast-grep scan --rule .ast-grep/rules/no-function-declaration.yml --error=no-function-declaration --globs '!**/*.d.ts' .",
-    "lint:file-comment": "pnpm exec ast-grep scan --rule .ast-grep/rules/no-file-comment.yml --error=no-file-comment --globs '!**/*.d.ts' .",
-    "lint:md": "tsx scripts/pandoc-md.mts --check",
-    "lint:peer-deps": "tsx scripts/peer-deps.mts",
-    "format:md": "tsx scripts/pandoc-md.mts --write",
-    "test:lib": "vitest run",
+    "format": "ts-canon format",
+    "lint": "ts-canon lint",
+    "test:lib": "vitest run --coverage",
     "test": "pnpm build:lib && pnpm test:lib && pnpm -r test",
     "test:watch": "vitest"
+  },
+  "devDependencies": {
+    "@types/node": "^26.3.0",
+    "@vitest/coverage-v8": "^4.1.11",
+    "del-cli": "^7.0.0",
+    "ts-canon": "^0.1.3",
+    "tsx": "^4.23.12",
+    "typescript": "^7.0.2",
+    "vitest": "^4.1.11"
   }
-}
+}