@avi2dg/checks 0.1.0 → 0.2.0

package/README.md

@@ -50,7 +50,7 @@ cp node_modules/@avi2dg/checks/bunfig.toml bunfig.toml
 `package.json` gains three scripts:
 
 ```json
-"lint": "oxlint --type-aware && ./node_modules/@avi2dg/checks/scripts/lint-coverage.sh && bun ./node_modules/@avi2dg/checks/scripts/test-layout.ts && bun ./node_modules/@avi2dg/checks/scripts/commit-identity.ts HEAD",
+"lint": "oxlint --type-aware && checks-lint-coverage && checks-test-layout && checks-commit-identity HEAD",
 "typecheck": "tsc --noEmit && effect-tsgo diagnostics --project tsconfig.json --format text --strict",
 "test": "bun test --randomize"
 ```
@@ -69,9 +69,8 @@ The registry version is pinned by the consumer's lockfile; bump
 
 ## Test layout
 
-`bun ./node_modules/@avi2dg/checks/scripts/test-layout.ts` fails unless the
-repo holds this shape, and names the file and the path to move it to when
-it does not:
+`checks-test-layout` fails unless the repo holds this shape, and names the
+file and the path to move it to when it does not:
 
 - Every test file is `tests/**/*.test.ts` or `.tsx`. A `*.test.ts`, `*.spec.ts` or
   `*_test.ts` under `src/`, `test/`, `__tests__/` or the repo root fails.
@@ -192,8 +191,8 @@ commit-identity check below is the enforcement.
 one carries an identity other than the repository owner's:
 
 ```sh
-bun ./node_modules/@avi2dg/checks/scripts/commit-identity.ts <base-ref> <head-ref>
-bun ./node_modules/@avi2dg/checks/scripts/commit-identity.ts <ref>
+bun run checks-commit-identity <base-ref> <head-ref>
+bun run checks-commit-identity <ref>
 ```
 
 With one argument it checks that commit alone, which is the form the
@@ -235,8 +234,8 @@ leaves stale once the base branch advances after the pull request opens.
 when an added line carries a banned comment:
 
 ```sh
-bun ./node_modules/@avi2dg/checks/scripts/comment-gate.ts <base-ref> <head-ref>
-bun ./node_modules/@avi2dg/checks/scripts/comment-gate.ts <ref>
+bun run checks-comment-gate <base-ref> <head-ref>
+bun run checks-comment-gate <ref>
 ```
 
 With two arguments it diffs the base against the head. With one it diffs
@@ -268,7 +267,7 @@ jobs:
 at each recent commit, so a repository can measure its own history:
 
 ```sh
-bun ./node_modules/@avi2dg/checks/scripts/backtest.ts [commit-count]
+bun run checks-backtest [commit-count]
 ```
 
 It walks the last `commit-count` first-parent commits, 60 by default,
@@ -308,9 +307,12 @@ of reach, so the figures are authored code.
   consumer's copy is compared key by key against the installed one
   instead. `[test] pathIgnorePatterns` is a real bunfig key, and an empty
   `--path-ignore-patterns` flag overrides the file's own list.
-- The layout check ships as `.ts` and is invoked with `bun`, which needs
-  no build step and no `dist/` entry, unlike the oxlint plugin that node
-  loads.
+- Each runnable script ships a `checks-` bin entry, so consumer
+  `package.json` scripts call the short name, which the package manager
+  puts on `PATH` only there; a shell runs it through `bun run`, which
+  never falls back to the registry the way `bunx` does. The `.ts` checks
+  keep a `bun` shebang, which needs no build step and no `dist/`
+  entry, unlike the oxlint plugin that node loads.
 - `bun` counts as a built-in module. Nothing installed resolves it except
   `@types/bun`, which would otherwise make every runtime `bun` import look
   like a dev-only dependency.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@avi2dg/checks",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Deterministic checks shared across the captain's TypeScript repos",
   "license": "MIT",
   "repository": {
@@ -39,6 +39,13 @@
     "./tsconfig.effect.json": "./tsconfig.effect.json",
     "./dist/index.js": "./dist/index.js"
   },
+  "bin": {
+    "checks-lint-coverage": "scripts/lint-coverage.sh",
+    "checks-test-layout": "scripts/test-layout.ts",
+    "checks-commit-identity": "scripts/commit-identity.ts",
+    "checks-comment-gate": "scripts/comment-gate.ts",
+    "checks-backtest": "scripts/backtest.ts"
+  },
   "scripts": {
     "build": "bun build effect-channel/index.ts --outdir dist --target node --format esm",
     "lint": "oxlint --type-aware && ./scripts/lint-coverage.sh && bun scripts/test-layout.ts && bun scripts/commit-identity.ts HEAD && bun scripts/comment-gate.ts HEAD && depcruise --config .dependency-cruiser.cjs effect-channel scripts tests commitlint.config.js dependency-cruiser.config.js .dependency-cruiser.cjs",

package/scripts/test-layout.ts

@@ -40,6 +40,7 @@ const BANNED_GLOBAL_CALLS: readonly string[] = ["fetch"];
 
 export const REQUIRED_TEST_SCRIPT = "bun test --randomize";
 export const LAYOUT_CHECK_MARK = "scripts/test-layout.ts";
+export const LAYOUT_CHECK_BIN = "checks-test-layout";
 
 function isRecord(value: unknown): value is Record<string, unknown> {
   return typeof value === "object" && value !== null;
@@ -215,11 +216,11 @@ export function scriptViolations(manifest: unknown): readonly Violation[] {
       message: `scripts.test must be exactly "${REQUIRED_TEST_SCRIPT}", found ${JSON.stringify(test ?? null)}`,
     });
   }
-  if (typeof lint !== "string" || !lint.includes(LAYOUT_CHECK_MARK)) {
+  if (typeof lint !== "string" || (!lint.includes(LAYOUT_CHECK_MARK) && !lint.includes(LAYOUT_CHECK_BIN))) {
     violations.push({
       file,
       line: undefined,
-      message: `scripts.lint must run the layout check: add "bun ./node_modules/@avi2dg/checks/${LAYOUT_CHECK_MARK}"`,
+      message: `scripts.lint must run the layout check: add "${LAYOUT_CHECK_BIN}"`,
     });
   }
   return violations;