input-from-file 0.1.0-alpha.0

package/LICENSE.md

@@ -0,0 +1,20 @@
+# MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,27 @@
+<h1 align="center">input-from-file</h1>
+
+<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="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>
+
+```shell
+npm i input-from-file
+```
+
+```ts
+import { inputFromFile } from "input-from-file";
+
+await take(inputFromFile, { filePath: "data.txt" });
+```
+
+## Options
+
+`inputFromFile` takes a single argument, `filePath`, of type `string`.
+
+See **[create-josh.vercel.app > Engine > Runtime > Inputs](https://create-josh.vercel.app/engine/runtime/inputs)** for more documentation on Inputs.

package/lib/index.d.ts

@@ -0,0 +1,3 @@
+export declare const inputFromFile: import("create").InputWithArgs<Promise<string | Error>, {
+    filePath: string;
+}>;

package/lib/index.js

@@ -0,0 +1,16 @@
+import { createInput } from "create";
+import { z } from "zod";
+export const inputFromFile = createInput({
+    args: {
+        filePath: z.string(),
+    },
+    async produce({ args, fs }) {
+        try {
+            return await fs.readFile(args.filePath);
+        }
+        catch (error) {
+            return error instanceof Error ? error : new Error(error);
+        }
+    },
+});
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AACrC,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,CAAC,MAAM,aAAa,GAAG,WAAW,CAAC;IACxC,IAAI,EAAE;QACL,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;KACpB;IACD,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE;QACzB,IAAI,CAAC;YACJ,OAAO,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACzC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,OAAO,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,KAAe,CAAC,CAAC;QACpE,CAAC;IACF,CAAC;CACD,CAAC,CAAC"}

package/lib/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/index.test.js

@@ -0,0 +1,43 @@
+import { testInput } from "create-testers";
+import { describe, expect, it } from "vitest";
+import { inputFromFile } from "./index.js";
+describe("inputFromFile", () => {
+    it("returns the file's text when it exists", async () => {
+        const text = "abc123";
+        const actual = await testInput(inputFromFile, {
+            args: {
+                filePath: "file.txt",
+            },
+            fs: {
+                readFile: () => Promise.resolve(text),
+            },
+        });
+        expect(actual).toBe(text);
+    });
+    it("returns an error when reading the file rejects with an error", async () => {
+        const error = new Error("Oh no!");
+        const actual = await testInput(inputFromFile, {
+            args: {
+                filePath: "file.txt",
+            },
+            fs: {
+                readFile: () => Promise.reject(error),
+            },
+        });
+        expect(actual).toEqual(error);
+    });
+    it("returns an error when reading the file rejects with a string", async () => {
+        const error = new Error("Oh no!");
+        const actual = await testInput(inputFromFile, {
+            args: {
+                filePath: "file.txt",
+            },
+            fs: {
+                // eslint-disable-next-line @typescript-eslint/prefer-promise-reject-errors
+                readFile: () => Promise.reject(error.message),
+            },
+        });
+        expect(actual).toEqual(error);
+    });
+});
+//# sourceMappingURL=index.test.js.map

package/lib/index.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.js","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAE9C,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAE3C,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;IAC9B,EAAE,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;QACvD,MAAM,IAAI,GAAG,QAAQ,CAAC;QAEtB,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,aAAa,EAAE;YAC7C,IAAI,EAAE;gBACL,QAAQ,EAAE,UAAU;aACpB;YACD,EAAE,EAAE;gBACH,QAAQ,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC;aACrC;SACD,CAAC,CAAC;QAEH,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8DAA8D,EAAE,KAAK,IAAI,EAAE;QAC7E,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC;QAClC,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,aAAa,EAAE;YAC7C,IAAI,EAAE;gBACL,QAAQ,EAAE,UAAU;aACpB;YACD,EAAE,EAAE;gBACH,QAAQ,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC;aACrC;SACD,CAAC,CAAC;QAEH,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8DAA8D,EAAE,KAAK,IAAI,EAAE;QAC7E,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC;QAClC,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,aAAa,EAAE;YAC7C,IAAI,EAAE;gBACL,QAAQ,EAAE,UAAU;aACpB;YACD,EAAE,EAAE;gBACH,2EAA2E;gBAC3E,QAAQ,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC;aAC7C;SACD,CAAC,CAAC;QAEH,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "input-from-file",
+  "version": "0.1.0-alpha.0",
+  "description": "Test utilities for composable, testable, type-safe templates. ⚗️",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/JoshuaKGoldberg/create",
+    "directory": "packages/input-from-file"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "Josh Goldberg ✨",
+    "email": "npm@joshuakgoldberg.com"
+  },
+  "type": "module",
+  "main": "./lib/index.js",
+  "files": [
+    "lib/",
+    "package.json",
+    "LICENSE.md",
+    "README.md"
+  ],
+  "dependencies": {
+    "zod": "^3.23.8"
+  },
+  "devDependencies": {
+    "create-testers": "0.1.0-alpha.0"
+  },
+  "peerDependencies": {
+    "create": "0.1.0-alpha.0"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "build": "tsc"
+  }
+}