Merge pull request #59 from colinhacks/test-single-bin

colinhacks · web-flow · commit c18f12f1b01e · 2025-12-08T16:07:59.000-08:00
Add simple `"bin"` test
diff --git a/.github/workflows/publish-latest.yml b/.github/workflows/publish-latest.yml
@@ -1,15 +1,13 @@
 name: Publish --latest
 
 on:
+  workflow_dispatch: # allow manual trigger for testing
   push:
     paths:
       - 'VERSION.txt'
     branches:
       - main
 
-  # Allow manual trigger for testing
-  workflow_dispatch:
-
 jobs:
   publish:
     name: Main
diff --git a/src/main.ts b/src/main.ts
@@ -227,8 +227,11 @@ Examples:
     if (typeof rawConfig.exports === "string") {
       rawConfig.exports = { ".": rawConfig.exports };
     } else if (typeof rawConfig.exports === "undefined") {
-      log.error(`❌ Missing "exports" key in package.json#/${CONFIG_KEY}`);
-      process.exit(1);
+      // exports is optional if bin is specified
+      if (!rawConfig.bin) {
+        log.error(`❌ Missing "exports" key in package.json#/${CONFIG_KEY}`);
+        process.exit(1);
+      }
     } else if (typeof rawConfig.exports !== "object") {
       log.error(`❌ Invalid "exports" key in package.json#/${CONFIG_KEY}`);
       process.exit(1);
diff --git a/test/__snapshots__/zshy.test.ts.snap b/test/__snapshots__/zshy.test.ts.snap
@@ -327,6 +327,93 @@ exports[`zshy with different tsconfig configurations > should skip CJS build whe
 }
 `;
 
+exports[`zshy with different tsconfig configurations > should support bin without exports (should not overwrite existing exports) 1`] = `
+{
+  "exitCode": 0,
+  "stderr": "",
+  "stdout": "╔═══════════════════════════════════════════════╗
+   ║ zshy » the bundler-free TypeScript build tool ║
+   ╚═══════════════════════════════════════════════╝
+»  Starting build...
+»  Verbose mode enabled
+»  Detected package manager: <pm>
+»  Build will fail only on errors (default)
+»  Detected project root: <root>/test/bin
+»  Reading package.json from ./package.json
+»  Parsed zshy config: {
+     "bin": "./src/cli.ts"
+   }
+»  Reading tsconfig from ./tsconfig.json
+»  Determining entrypoints...
+   ╔══════════════════╤══════════════╗
+   ║ Subpath          │ Entrypoint   ║
+   ╟──────────────────┼──────────────╢
+   ║ bin:bin-only-pkg │ ./src/cli.ts ║
+   ╚══════════════════╧══════════════╝
+»  Resolved build paths:
+   ╔══════════╤═══════════════╗
+   ║ Location │ Resolved path ║
+   ╟──────────┼───────────────╢
+   ║ rootDir  │ ./src         ║
+   ║ outDir   │ ./dist        ║
+   ╚══════════╧═══════════════╝
+»  Package is an ES module (package.json#/type is "module")
+»  Cleaning up outDir...
+»  Cleaning up declarationDir...
+»  Resolved entrypoints: [
+     "./src/cli.ts"
+   ]
+»  Resolved compilerOptions: {
+     "lib": [
+       "lib.esnext.d.ts"
+     ],
+     "target": "ES2020",
+     "module": "ESNext",
+     "moduleResolution": "Bundler",
+     "moduleDetection": 2,
+     "allowJs": true,
+     "declaration": true,
+     "jsx": 4,
+     "allowImportingTsExtensions": true,
+     "rewriteRelativeImportExtensions": true,
+     "verbatimModuleSyntax": false,
+     "noEmit": false,
+     "strict": true,
+     "skipLibCheck": true,
+     "noFallthroughCasesInSwitch": true,
+     "noUncheckedIndexedAccess": true,
+     "esModuleInterop": true,
+     "forceConsistentCasingInFileNames": true,
+     "noUnusedLocals": true,
+     "noUnusedParameters": false,
+     "noPropertyAccessFromIndexSignature": false,
+     "sourceMap": true,
+     "declarationMap": true,
+     "resolveJsonModule": true,
+     "noImplicitOverride": true,
+     "noImplicitThis": true,
+     "outDir": "<root>/test/bin/dist",
+     "emitDeclarationOnly": false,
+     "composite": false
+   }
+»  Building CJS... (rewriting .ts -> .cjs/.d.cts)
+»  Enabling CJS interop transform...
+»  Building ESM...
+»  Writing files (8 total)...
+     ./dist/cli.cjs
+     ./dist/cli.cjs.map
+     ./dist/cli.d.cts
+     ./dist/cli.d.cts.map
+     ./dist/cli.d.ts
+     ./dist/cli.d.ts.map
+     ./dist/cli.js
+     ./dist/cli.js.map
+»  Updating package.json...
+»  Setting "bin": "./dist/cli.cjs"
+»  Build complete!",
+}
+`;
+
 exports[`zshy with different tsconfig configurations > should support multiple bin entries 1`] = `
 {
   "exitCode": 0,
diff --git a/test/bin/dist/cli.cjs b/test/bin/dist/cli.cjs
@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+"use strict";
+console.log("Hello from CLI!");
+//# sourceMappingURL=cli.js.map
diff --git a/test/bin/dist/cli.cjs.map b/test/bin/dist/cli.cjs.map
diff --git a/test/bin/dist/cli.d.cts b/test/bin/dist/cli.d.cts
@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+//# sourceMappingURL=cli.d.ts.map
diff --git a/test/bin/dist/cli.d.cts.map b/test/bin/dist/cli.d.cts.map
diff --git a/test/bin/dist/cli.d.ts b/test/bin/dist/cli.d.ts
@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+//# sourceMappingURL=cli.d.ts.map
diff --git a/test/bin/dist/cli.d.ts.map b/test/bin/dist/cli.d.ts.map
diff --git a/test/bin/dist/cli.js b/test/bin/dist/cli.js
diff --git a/test/bin/dist/cli.js.map b/test/bin/dist/cli.js.map
diff --git a/test/bin/package.json b/test/bin/package.json
@@ -0,0 +1,22 @@
+{
+  "name": "bin-only-pkg",
+  "version": "1.0.0",
+  "description": "Test fixture for zshy - bin only (no exports in zshy config)",
+  "type": "module",
+  "scripts": {
+    "build": "tsx ../../src/index.ts --project tsconfig.json"
+  },
+  "devDependencies": {
+    "typescript": "^5.8.3"
+  },
+  "zshy": {
+    "bin": "./src/cli.ts"
+  },
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    "./some-existing-export": "./some-path.js"
+  },
+  "bin": "./dist/cli.cjs"
+}
diff --git a/test/bin/src/cli.ts b/test/bin/src/cli.ts
@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+
+console.log("Hello from CLI!");
+
diff --git a/test/bin/tsconfig.json b/test/bin/tsconfig.json
@@ -0,0 +1,9 @@
+{
+  "extends": "../tsconfig.default.json",
+  "compilerOptions": {
+    "outDir": "./dist"
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "**/*.d.ts"]
+}
+
diff --git a/test/zshy.test.ts b/test/zshy.test.ts
@@ -181,6 +181,29 @@ describe("zshy with different tsconfig configurations", () => {
     expect(snapshot).toMatchSnapshot();
   });
 
+  it("should support bin without exports (should not overwrite existing exports)", () => {
+    const cwd = process.cwd() + "/test/bin";
+    const packageJsonPath = cwd + "/package.json";
+    
+    // Read original exports field
+    const originalPackageJson = JSON.parse(readFileSync(packageJsonPath, "utf-8"));
+    const originalExports = originalPackageJson.exports;
+
+    const snapshot = runZshyWithTsconfig("tsconfig.json", {
+      dryRun: false,
+      cwd,
+    });
+
+    // Verify exports were not modified
+    const newPackageJson = JSON.parse(readFileSync(packageJsonPath, "utf-8"));
+    expect(newPackageJson.exports).toEqual(originalExports);
+    
+    // Verify bin was updated
+    expect(newPackageJson.bin).toBe("./dist/cli.cjs");
+    
+    expect(snapshot).toMatchSnapshot();
+  });
+
   it("should support tsconfig paths aliases with at-sign", () => {
     const snapshot = runZshyWithTsconfig("tsconfig.json", {
       dryRun: false,

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+#!/usr/bin/env node`
	`2`	`+//# sourceMappingURL=cli.d.ts.map`