dollar-shell 1.1.12 → 1.1.14

package/AGENTS.md

@@ -19,7 +19,8 @@ The wiki is a git submodule in `wiki/`.
 - **Test (Node):** `npm test` (runs `tape6 --flags FO`)
 - **Test (Bun):** `npm run test:bun`
 - **Test (Deno):** `npm run test:deno`
-- **TypeScript check:** `npm run ts-check` (`tsc --noEmit`)
+- **TypeScript check:** `npm run ts-check` (`tsc --noEmit`, validates the `.d.ts` sidecars)
+- **JavaScript check:** `npm run js-check` (`tsc --project tsconfig.check.json`, lints the `.js` sources for unused vars / undeclared refs)
 - **TypeScript tests:** `npm run ts-test` (run `.ts` test files with tape6)
 - **Lint:** `npm run lint` (Prettier check)
 - **Lint fix:** `npm run lint:fix` (Prettier write)
@@ -28,9 +29,10 @@ The wiki is a git submodule in `wiki/`.
 
 ```
 dollar-shell/
-├── package.json      # Package config
-├── tsconfig.json     # TypeScript config (noEmit check only)
-├── src/              # Source code
+├── package.json          # Package config
+├── tsconfig.json         # Strict TS config — checks the .d.ts sidecars
+├── tsconfig.check.json   # Lint config — checkJs on .js sources, with @types/{node,bun,deno} for cross-runtime globals
+├── src/                  # Source code
 │   ├── index.js      # Main entry point, wires everything together
 │   ├── index.d.ts    # TypeScript declarations for the full public API
 │   ├── bq-spawn.js   # Template tag factory for spawn-based functions ($, $$)
@@ -90,8 +92,8 @@ await $verbose`ls -l .`;
 
 ## Key conventions
 
-- Do not add dependencies — the library is intentionally zero-dependency.
+- Do not add runtime dependencies — the library is intentionally zero-dependency. DevDeps for tooling (`@types/node`, `@types/bun`, `@types/deno`, `prettier`, `tape-six`, `typescript`) are fine.
 - All public API is exported from `src/index.js` and typed in `src/index.d.ts`. Keep them in sync.
-- Wiki documentation lives in the `wiki/` submodule — update it alongside code changes.
+- Wiki documentation lives in the `wiki/` submodule — update it alongside code changes. Cross-runtime behavior asymmetries (e.g. BYOB readers — only Deno supports them) are documented at `wiki/Cross-runtime-notes.md`.
 - Tests are in `tests/` (automated, tape-six) and `tests/manual/` (manual verification scripts).
 - TypeScript typing tests (`.ts`) are in `tests/` and checked by `npm run ts-check`. They can also be run as tests via `npm run ts-test`.

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2005-2024 Eugene Lazutkin
+Copyright 2005-2026 Eugene Lazutkin
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 

package/README.md

@@ -237,6 +237,8 @@ BSD-3-Clause
 
 ## Release History
 
+- 1.1.14 _Fixed Bun stdin abort path, added js-check, Bun + Deno wired into CI._
+- 1.1.13 _Updated dev dependencies._
 - 1.1.12 _Consolidated TypeScript tests into `tests/`, removed `ts-check/`, added CJS test, improved test coverage and documentation._
 - 1.1.11 _Updated dev dependencies._
 - 1.1.10 _Fixed a bug with options chaining for attached functions, fixed Bun spawn on invalid commands, Windows-compatible tests, updated dev dependencies._
@@ -256,3 +258,5 @@ BSD-3-Clause
 - 1.0.2 _Technical release: fixed references in the package file._
 - 1.0.1 _Technical release: more tests, better documentation._
 - 1.0.0 _The initial release._
+
+The full release notes are in the wiki: [Release notes](https://github.com/uhop/dollar-shell/wiki/Release-notes).

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "dollar-shell",
-  "description": "Run shell commands and use them in stream pipelines with ease in Node, Deno, Bun. Template tag API, web streams, TypeScript typings, zero dependencies.",
-  "version": "1.1.12",
+  "description": "Run OS and shell commands using template tag functions. Same API in Node, Deno, and Bun. Web streams, TypeScript typings, zero dependencies.",
+  "version": "1.1.14",
   "type": "module",
   "main": "./src/index.js",
   "types": "./src/index.d.ts",
@@ -20,6 +20,7 @@
     "test:seq:bun": "bun run `tape6-seq --self` --flags FO",
     "test:seq:deno": "deno run -A `tape6-seq --self` --flags FO",
     "ts-check": "tsc --noEmit",
+    "js-check": "tsc --project tsconfig.check.json",
     "ts-test": "tape6 --flags FO 'tests/test-*.*ts'",
     "ts-test:bun": "tape6-bun --flags FO 'tests/test-*.*ts'",
     "ts-test:deno": "tape6-deno --flags FO 'tests/test-*.*ts'",
@@ -49,7 +50,7 @@
   "keywords": [
     "shell",
     "spawn",
-    "$",
+    "subprocess",
     "dollar",
     "stream",
     "process",
@@ -60,7 +61,6 @@
     "pipeline",
     "typescript",
     "esm",
-    "es-modules",
     "cross-runtime",
     "zero-dependency",
     "nodejs",
@@ -74,9 +74,12 @@
   },
   "license": "BSD-3-Clause",
   "devDependencies": {
-    "prettier": "^3.8.1",
-    "tape-six": "^1.7.11",
-    "typescript": "^5.9.3"
+    "@types/bun": "^1.3.13",
+    "@types/deno": "^2.5.0",
+    "@types/node": "^25.6.0",
+    "prettier": "^3.8.3",
+    "tape-six": "^1.9.0",
+    "typescript": "^6.0.3"
   },
   "tape6": {
     "tests": [

package/src/index.js

@@ -51,9 +51,10 @@ const throughProcess = bqSpawn((command, options) => {
   return sp.asDuplex;
 });
 
-$.from = fromProcess;
-$.to = toProcess;
-$.through = $.io = throughProcess;
+const $any = /** @type {any} */ ($);
+$any.from = fromProcess;
+$any.to = toProcess;
+$any.through = $any.io = throughProcess;
 
 // define shell functions
 
@@ -101,8 +102,9 @@ const throughShell = bqShell(shellEscape, (command, options) => {
   return sp.asDuplex;
 });
 
-$sh.from = fromShell;
-$sh.to = toShell;
-$sh.through = $sh.io = throughShell;
+const $shAny = /** @type {any} */ ($sh);
+$shAny.from = fromShell;
+$shAny.to = toShell;
+$shAny.through = $shAny.io = throughShell;
 
 export default $;

package/src/spawn/bun.js

@@ -1,3 +1,24 @@
+/**
+ * Adapt Bun's `FileSink` to a Web Streams `UnderlyingSink`. `FileSink` exposes
+ * `write`/`end` (close + flush) but no `close`/`abort` matching the spec, so
+ * `new WritableStream(fileSink)` would only work because of an undocumented
+ * runtime `.close` alias. This adapter sticks to the documented `.end` API.
+ *
+ * @param {import('bun').FileSink} sink
+ * @returns {UnderlyingSink}
+ */
+const makeStdinSink = sink => ({
+  async write(/** @type {any} */ chunk) {
+    await sink.write(chunk);
+  },
+  async close() {
+    await sink.end();
+  },
+  async abort(reason) {
+    await sink.end(reason instanceof Error ? reason : new Error(String(reason)));
+  }
+});
+
 const sanitize = (value, defaultValue = 'ignore') => {
   switch (value) {
     case 'pipe':
@@ -47,7 +68,11 @@ class Subprocess {
       return code;
     });
 
-    this.stdin = this.childProcess.stdin ? new WritableStream(this.childProcess.stdin) : null;
+    const stdinSink = this.childProcess.stdin;
+    this.stdin =
+      stdinSink && typeof stdinSink !== 'number'
+        ? new WritableStream(makeStdinSink(stdinSink))
+        : null;
     this.stdout = this.childProcess.stdout || null;
     this.stderr = this.childProcess.stderr || null;
   }

package/src/spawn/node.js

@@ -27,6 +27,7 @@ class Subprocess {
     this.killed = false;
     this.finished = false;
 
+    /** @type {import('node:child_process').SpawnOptions} */
     const spawnOptions = {stdio: ['ignore', 'ignore', 'ignore']};
     if (options.windowsVerbatimArguments) spawnOptions.windowsVerbatimArguments = true;
     options.cwd && (spawnOptions.cwd = options.cwd);

package/src/utils.js

@@ -14,7 +14,8 @@ if (typeof Deno !== 'undefined') {
 }
 export {getEnv, isWindows, isAndroid};
 
-export const verifyStrings = strings => Array.isArray(strings) && Array.isArray(strings.raw);
+export const verifyStrings = strings =>
+  Array.isArray(strings) && Array.isArray(/** @type {any} */ (strings).raw);
 
 export const toBase64 = s => {
   // const buf = new TextEncoder().encode(s),