feat: add inputFromScript, and make SystemRunner use execa's reject: …

…false (#74) * feat: add inputFromScript, and make SystemRunner use execa's reject: false * pnpm dedupe
JoshuaKGoldberg · Dec 19, 2024 · 9405d14 · 9405d14
1 parent 62b2a1d
commit 9405d14
Show file tree

Hide file tree

Showing 15 changed files with 143 additions and 12 deletions.
diff --git a/packages/create/src/system/createSystemRunner.ts b/packages/create/src/system/createSystemRunner.ts
@@ -1,7 +1,9 @@
 import { execa, parseCommandString } from "execa";
 
-export function createSystemRunner(directory: string) {
-	const executor = execa({ cwd: directory });
+import { SystemRunner } from "../types/system.js";
+
+export function createSystemRunner(directory: string): SystemRunner {
+	const executor = execa({ cwd: directory, reject: false });
 
 	return (command: string) => executor`${parseCommandString(command)}`;
 }
diff --git a/packages/create/src/types/system.ts b/packages/create/src/types/system.ts
@@ -1,4 +1,4 @@
-import { Result } from "execa";
+import { ExecaError, Result } from "execa";
 import { Octokit } from "octokit";
 
 import { TakeContext } from "./context.js";
@@ -31,7 +31,7 @@ export interface SystemFetchers {
 	octokit: Octokit;
 }
 
-export type SystemRunner = (command: string) => Promise<Result>;
+export type SystemRunner = (command: string) => Promise<ExecaError | Result>;
 
 export interface WritingFileSystem extends InputFileSystem {
 	writeDirectory: FileSystemWriteDirectory;

diff --git a/packages/input-from-file-json/README.md b/packages/input-from-file-json/README.md
@@ -3,9 +3,8 @@
 <p align="center"><code>create</code> input that reads a file as JSON.</p>
 
 <p align="center">
-	<a href="https://github.com/JoshuaKGoldberg/input-from-file-json/blob/main/.github/CODE_OF_CONDUCT.md" target="_blank"><img alt="🤝 Code of Conduct: Kept" src="https://img.shields.io/badge/%F0%9F%A4%9D_code_of_conduct-kept-21bb42" /></a>
-	<a href="https://codecov.io/gh/JoshuaKGoldberg/input-from-file-json" target="_blank"><img alt="🧪 Coverage" src="https://img.shields.io/codecov/c/github/JoshuaKGoldberg/input-from-file-json?label=%F0%9F%A7%AA%20coverage" /></a>
-	<a href="https://github.com/JoshuaKGoldberg/input-from-file-json/blob/main/LICENSE.md" target="_blank"><img alt="📝 License: MIT" src="https://img.shields.io/badge/%F0%9F%93%9D_license-MIT-21bb42.svg"></a>
+	<a href="https://github.com/JoshuaKGoldberg/create/blob/main/.github/CODE_OF_CONDUCT.md" target="_blank"><img alt="🤝 Code of Conduct: Kept" src="https://img.shields.io/badge/%F0%9F%A4%9D_code_of_conduct-kept-21bb42" /></a>
+	<a href="https://github.com/JoshuaKGoldberg/create/blob/main/LICENSE.md" target="_blank"><img alt="📝 License: MIT" src="https://img.shields.io/badge/%F0%9F%93%9D_license-MIT-21bb42.svg"></a>
 	<a href="http://npmjs.com/package/input-from-file-json"><img alt="📦 npm version" src="https://img.shields.io/npm/v/input-from-file-json?color=21bb42&label=%F0%9F%93%A6%20npm" /></a>
 	<img alt="💪 TypeScript: Strict" src="https://img.shields.io/badge/%F0%9F%92%AA_typescript-strict-21bb42.svg" />
 </p>

diff --git a/packages/input-from-file-json/package.json b/packages/input-from-file-json/package.json
@@ -1,7 +1,7 @@
 {
 	"name": "input-from-file-json",
 	"version": "0.1.0-alpha.2",
-	"description": "Test utilities for composable, testable, type-safe templates. ⚗️",
+	"description": "create input that reads a file as JSON.",
 	"repository": {
 		"type": "git",
 		"url": "https://github.com/JoshuaKGoldberg/create",

diff --git a/packages/input-from-file/README.md b/packages/input-from-file/README.md
@@ -3,9 +3,8 @@
 <p align="center"><code>create</code> input that reads a file as JSON.</p>
 
 <p align="center">
-	<a href="https://github.com/JoshuaKGoldberg/input-from-file/blob/main/.github/CODE_OF_CONDUCT.md" target="_blank"><img alt="🤝 Code of Conduct: Kept" src="https://img.shields.io/badge/%F0%9F%A4%9D_code_of_conduct-kept-21bb42" /></a>
-	<a href="https://codecov.io/gh/JoshuaKGoldberg/input-from-file" target="_blank"><img alt="🧪 Coverage" src="https://img.shields.io/codecov/c/github/JoshuaKGoldberg/input-from-file?label=%F0%9F%A7%AA%20coverage" /></a>
-	<a href="https://github.com/JoshuaKGoldberg/input-from-file/blob/main/LICENSE.md" target="_blank"><img alt="📝 License: MIT" src="https://img.shields.io/badge/%F0%9F%93%9D_license-MIT-21bb42.svg"></a>
+	<a href="https://github.com/JoshuaKGoldberg/create/blob/main/.github/CODE_OF_CONDUCT.md" target="_blank"><img alt="🤝 Code of Conduct: Kept" src="https://img.shields.io/badge/%F0%9F%A4%9D_code_of_conduct-kept-21bb42" /></a>
+	<a href="https://github.com/JoshuaKGoldberg/create/blob/main/LICENSE.md" target="_blank"><img alt="📝 License: MIT" src="https://img.shields.io/badge/%F0%9F%93%9D_license-MIT-21bb42.svg"></a>
 	<a href="http://npmjs.com/package/input-from-file"><img alt="📦 npm version" src="https://img.shields.io/npm/v/input-from-file?color=21bb42&label=%F0%9F%93%A6%20npm" /></a>
 	<img alt="💪 TypeScript: Strict" src="https://img.shields.io/badge/%F0%9F%92%AA_typescript-strict-21bb42.svg" />
 </p>

diff --git a/packages/input-from-file/package.json b/packages/input-from-file/package.json
@@ -1,7 +1,7 @@
 {
 	"name": "input-from-file",
 	"version": "0.1.0-alpha.2",
-	"description": "Test utilities for composable, testable, type-safe templates. ⚗️",
+	"description": "create input that reads a file as text.",
 	"repository": {
 		"type": "git",
 		"url": "https://github.com/JoshuaKGoldberg/create",

diff --git a/packages/input-from-script/README.md b/packages/input-from-script/README.md
@@ -0,0 +1,31 @@
+<h1 align="center">input-from-script</h1>
+
+<p align="center"><code>create</code> input that runs a script.</p>
+
+<p align="center">
+	<a href="https://github.com/JoshuaKGoldberg/create/blob/main/.github/CODE_OF_CONDUCT.md" target="_blank"><img alt="🤝 Code of Conduct: Kept" src="https://img.shields.io/badge/%F0%9F%A4%9D_code_of_conduct-kept-21bb42" /></a>
+	<a href="https://github.com/JoshuaKGoldberg/create/blob/main/LICENSE.md" target="_blank"><img alt="📝 License: MIT" src="https://img.shields.io/badge/%F0%9F%93%9D_license-MIT-21bb42.svg"></a>
+	<a href="http://npmjs.com/package/input-from-script"><img alt="📦 npm version" src="https://img.shields.io/npm/v/input-from-script?color=21bb42&label=%F0%9F%93%A6%20npm" /></a>
+	<img alt="💪 TypeScript: Strict" src="https://img.shields.io/badge/%F0%9F%92%AA_typescript-strict-21bb42.svg" />
+</p>
+
+```shell
+npm i input-from-script
+```
+
+```ts
+import { inputFromScript } from "input-from-script";
+
+await take(inputFromScript, { command: "npm whoami" });
+```
+
+## Options
+
+`inputFromScript` takes a single argument, `command`, of type `string`.
+
+It runs the `command` with [`execa`](https://www.npmjs.com/package/execa) and returns either:
+
+- `Error`: If an error was caught running the script
+- `Result`: The type from `execa`, including the `stdout` property
+
+See **[create-josh.vercel.app > Engine > Runtime > Inputs](https://create-josh.vercel.app/engine/runtime/inputs)** for more documentation on Inputs.
diff --git a/packages/input-from-script/package.json b/packages/input-from-script/package.json
@@ -0,0 +1,38 @@
+{
+	"name": "input-from-script",
+	"version": "0.1.0-alpha.2",
+	"description": "create input that runs a script.",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/JoshuaKGoldberg/create",
+		"directory": "packages/input-from-script"
+	},
+	"license": "MIT",
+	"author": {
+		"name": "Josh Goldberg ✨",
+		"email": "npm@joshuakgoldberg.com"
+	},
+	"type": "module",
+	"main": "./lib/index.js",
+	"files": [
+		"lib/",
+		"package.json",
+		"LICENSE.md",
+		"README.md"
+	],
+	"scripts": {
+		"build": "tsc"
+	},
+	"dependencies": {
+		"zod": "^3.24.1"
+	},
+	"devDependencies": {
+		"create-testers": "workspace:*"
+	},
+	"peerDependencies": {
+		"create": "workspace:*"
+	},
+	"engines": {
+		"node": ">=18"
+	}
+}
diff --git a/packages/input-from-script/src/index.test.ts b/packages/input-from-script/src/index.test.ts
@@ -0,0 +1,20 @@
+import { testInput } from "create-testers";
+import { describe, expect, it, vi } from "vitest";
+
+import { inputFromScript } from "./index.js";
+
+describe("inputFromScript", () => {
+	it("returns the result from running the command", async () => {
+		const command = "echo 123";
+		const expected = { stdout: "123" };
+		const runner = vi.fn().mockResolvedValue(expected);
+
+		const actual = await testInput(inputFromScript, {
+			args: { command },
+			runner,
+		});
+
+		expect(actual).toBe(expected);
+		expect(runner).toHaveBeenCalledWith(command);
+	});
+});
diff --git a/packages/input-from-script/src/index.ts b/packages/input-from-script/src/index.ts
@@ -0,0 +1,11 @@
+import { createInput } from "create";
+import { z } from "zod";
+
+export const inputFromScript = createInput({
+	args: {
+		command: z.string(),
+	},
+	async produce({ args, runner }) {
+		return await runner(args.command);
+	},
+});
diff --git a/packages/input-from-script/tsconfig.json b/packages/input-from-script/tsconfig.json
@@ -0,0 +1,8 @@
+{
+	"compilerOptions": {
+		"outDir": "lib",
+		"rootDir": "src"
+	},
+	"extends": "../../tsconfig.base.json",
+	"include": ["src"]
+}
diff --git a/packages/input-from-script/vitest.config.ts b/packages/input-from-script/vitest.config.ts
@@ -0,0 +1,8 @@
+import { defineProject } from "vitest/config";
+
+export default defineProject({
+	test: {
+		clearMocks: true,
+		exclude: ["lib", "node_modules"],
+	},
+});
diff --git a/packages/site/src/content/docs/engine/runtime/inputs.md b/packages/site/src/content/docs/engine/runtime/inputs.md
@@ -140,6 +140,7 @@ export const inputNpmUsername = createInput({
 
 - [`input-from-file`](https://www.npmjs.com/package/input-from-file): Reads a file's contents as text
 - [`input-from-file-json`](https://www.npmjs.com/package/input-from-file-json): Parse's a file's text contexts with `JSON.parse`
+- [`input-from-script`](https://www.npmjs.com/package/input-from-script): Runs a script command
 
 See those individual packages for their documentation.
 

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/tsconfig.build.json b/tsconfig.build.json
@@ -10,6 +10,7 @@
 		{ "path": "./packages/create-testers" },
 		{ "path": "./packages/input-from-file" },
 		{ "path": "./packages/input-from-file-json" },
+		{ "path": "./packages/input-from-script" },
 		{ "path": "./packages/site" }
 	]
 }