@cloud-copilot/cli 0.1.17 → 0.1.19

package/README.md

@@ -125,7 +125,7 @@ String or number arguments can be provided as `--name value` or `--name value1 v
 
 String or number arguments will throw an error if:
 
-- The flag is specified an no values are provided
+- The flag is specified and no values are provided
 - The argument accepts only one value and multiple values are provided
 - The argument is a number and a non-number value is provided
 
@@ -135,14 +135,12 @@ Enum arguments can be provided as `--name value1 value2`. The values must be one
 
 Enum arguments will throw an error if:
 
-- The flag is specified an no values are provided
+- The flag is specified and no values are provided
 - The argument accepts only one value and multiple values are provided
 - Any of the arguments provided are not in the list of allowed values.
 
 If the value is not one of the values provided, an error will be thrown.
 
-If a string or number argument is provided with no values an error will be thrown.
-
 ### Operands
 
 Operands are the remaining values after the arguments.

package/dist/cjs/index.d.ts

@@ -1,3 +1,4 @@
 export { parseCliArguments, printHelpContents, type AdditionalCliArguments, type Config } from './cli.js';
+export { readRelativeFile } from './readRelative.js';
 export { readStdin } from './stdin.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/cjs/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,iBAAiB,EACjB,KAAK,sBAAsB,EAC3B,KAAK,MAAM,EACZ,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,iBAAiB,EACjB,KAAK,sBAAsB,EAC3B,KAAK,MAAM,EACZ,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AACpD,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA"}

package/dist/cjs/index.js

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.readStdin = exports.printHelpContents = exports.parseCliArguments = void 0;
+exports.readStdin = exports.readRelativeFile = exports.printHelpContents = exports.parseCliArguments = void 0;
 var cli_js_1 = require("./cli.js");
 Object.defineProperty(exports, "parseCliArguments", { enumerable: true, get: function () { return cli_js_1.parseCliArguments; } });
 Object.defineProperty(exports, "printHelpContents", { enumerable: true, get: function () { return cli_js_1.printHelpContents; } });
+var readRelative_js_1 = require("./readRelative.js");
+Object.defineProperty(exports, "readRelativeFile", { enumerable: true, get: function () { return readRelative_js_1.readRelativeFile; } });
 var stdin_js_1 = require("./stdin.js");
 Object.defineProperty(exports, "readStdin", { enumerable: true, get: function () { return stdin_js_1.readStdin; } });
 //# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,mCAKiB;AAJf,2GAAA,iBAAiB,OAAA;AACjB,2GAAA,iBAAiB,OAAA;AAInB,uCAAsC;AAA7B,qGAAA,SAAS,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,mCAKiB;AAJf,2GAAA,iBAAiB,OAAA;AACjB,2GAAA,iBAAiB,OAAA;AAInB,qDAAoD;AAA3C,mHAAA,gBAAgB,OAAA;AACzB,uCAAsC;AAA7B,qGAAA,SAAS,OAAA"}

package/dist/cjs/readRelative.d.ts

@@ -0,0 +1,17 @@
+/**
+ * A relatively sane way to read a file from a relative path inside your packaged cli app. For instance to
+ * read the package.json inside your package. Works on ESM and CommonJS modules. Use __filename
+ * or import.meta.url to get the path of the file you are in and pass it to this function. Set the `levelsUp`
+ * based on how your project is packaged. For instance, if your file is packaged in `dist/cli.js` and you would use `1` if
+ * you packaged your file is in `dist/src/cli.js` and you would use `2`. Whatever you need to get to the root.
+ * Then the path parts are the path to the file you want to read, relative to the root of your project with each
+ * directory as a separate string in the array and the file name as the last string in the array. They will be
+ * joined together in a way that makes sense for the OS and module type your package is running in.
+ *
+ * @param currentFile the path to start from use `import.meta.url` or `__filename` for most cases
+ * @param levelsUp since __import.meta.url or __filename is the file you are in, you need to go up a few levels to ge to the root of your project. Use 0 for the current directory of the file you're calling from.
+ * @param pathParts the path to the file, relative to the new root
+ * @returns the contents of the file as a string
+ */
+export declare function readRelativeFile(currentFile: string, levelsUp: number, pathParts: string[]): Promise<string>;
+//# sourceMappingURL=readRelative.d.ts.map

package/dist/cjs/readRelative.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"readRelative.d.ts","sourceRoot":"","sources":["../../src/readRelative.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,gBAAgB,CACpC,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EAAE,GAClB,OAAO,CAAC,MAAM,CAAC,CAgBjB"}

package/dist/cjs/readRelative.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readRelativeFile = readRelativeFile;
+const promises_1 = require("fs/promises");
+const path_1 = require("path");
+/**
+ * A relatively sane way to read a file from a relative path inside your packaged cli app. For instance to
+ * read the package.json inside your package. Works on ESM and CommonJS modules. Use __filename
+ * or import.meta.url to get the path of the file you are in and pass it to this function. Set the `levelsUp`
+ * based on how your project is packaged. For instance, if your file is packaged in `dist/cli.js` and you would use `1` if
+ * you packaged your file is in `dist/src/cli.js` and you would use `2`. Whatever you need to get to the root.
+ * Then the path parts are the path to the file you want to read, relative to the root of your project with each
+ * directory as a separate string in the array and the file name as the last string in the array. They will be
+ * joined together in a way that makes sense for the OS and module type your package is running in.
+ *
+ * @param currentFile the path to start from use `import.meta.url` or `__filename` for most cases
+ * @param levelsUp since __import.meta.url or __filename is the file you are in, you need to go up a few levels to ge to the root of your project. Use 0 for the current directory of the file you're calling from.
+ * @param pathParts the path to the file, relative to the new root
+ * @returns the contents of the file as a string
+ */
+async function readRelativeFile(currentFile, levelsUp, pathParts) {
+    const isEsm = currentFile.startsWith('file://');
+    const backSegments = Array(levelsUp).fill('..');
+    if (isEsm) {
+        const dirPath = currentFile.slice(0, currentFile.lastIndexOf('/'));
+        const { fileURLToPath } = await Promise.resolve().then(() => require('node:url'));
+        const { join } = await Promise.resolve().then(() => require('node:path'));
+        const startPath = fileURLToPath(dirPath);
+        const fullPath = join(startPath, ...backSegments, ...pathParts);
+        return await (0, promises_1.readFile)(fullPath, 'utf8');
+    }
+    else {
+        const dirPath = currentFile.slice(0, currentFile.lastIndexOf(path_1.sep));
+        const contents = await (0, promises_1.readFile)((0, path_1.join)(dirPath, ...backSegments, ...pathParts), 'utf8');
+        return contents;
+    }
+}
+//# sourceMappingURL=readRelative.js.map

package/dist/cjs/readRelative.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"readRelative.js","sourceRoot":"","sources":["../../src/readRelative.ts"],"names":[],"mappings":";;AAkBA,4CAoBC;AAtCD,0CAAsC;AACtC,+BAAgC;AAEhC;;;;;;;;;;;;;;GAcG;AACI,KAAK,UAAU,gBAAgB,CACpC,WAAmB,EACnB,QAAgB,EAChB,SAAmB;IAEnB,MAAM,KAAK,GAAG,WAAW,CAAC,UAAU,CAAC,SAAS,CAAC,CAAA;IAC/C,MAAM,YAAY,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAE/C,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,OAAO,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAA;QAClE,MAAM,EAAE,aAAa,EAAE,GAAG,2CAAa,UAAU,EAAC,CAAA;QAClD,MAAM,EAAE,IAAI,EAAE,GAAG,2CAAa,WAAW,EAAC,CAAA;QAC1C,MAAM,SAAS,GAAG,aAAa,CAAC,OAAO,CAAC,CAAA;QACxC,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,EAAE,GAAG,YAAY,EAAE,GAAG,SAAS,CAAC,CAAA;QAC/D,OAAO,MAAM,IAAA,mBAAQ,EAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;IACzC,CAAC;SAAM,CAAC;QACN,MAAM,OAAO,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC,WAAW,CAAC,UAAG,CAAC,CAAC,CAAA;QAClE,MAAM,QAAQ,GAAG,MAAM,IAAA,mBAAQ,EAAC,IAAA,WAAI,EAAC,OAAO,EAAE,GAAG,YAAY,EAAE,GAAG,SAAS,CAAC,EAAE,MAAM,CAAC,CAAA;QACrF,OAAO,QAAQ,CAAA;IACjB,CAAC;AACH,CAAC"}

package/dist/esm/index.d.ts

@@ -1,3 +1,4 @@
 export { parseCliArguments, printHelpContents, type AdditionalCliArguments, type Config } from './cli.js';
+export { readRelativeFile } from './readRelative.js';
 export { readStdin } from './stdin.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/esm/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,iBAAiB,EACjB,KAAK,sBAAsB,EAC3B,KAAK,MAAM,EACZ,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,iBAAiB,EACjB,KAAK,sBAAsB,EAC3B,KAAK,MAAM,EACZ,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AACpD,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA"}

package/dist/esm/index.js

@@ -1,3 +1,4 @@
 export { parseCliArguments, printHelpContents } from './cli.js';
+export { readRelativeFile } from './readRelative.js';
 export { readStdin } from './stdin.js';
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,iBAAiB,EAGlB,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,iBAAiB,EAGlB,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AACpD,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA"}

package/dist/esm/readRelative.d.ts

@@ -0,0 +1,17 @@
+/**
+ * A relatively sane way to read a file from a relative path inside your packaged cli app. For instance to
+ * read the package.json inside your package. Works on ESM and CommonJS modules. Use __filename
+ * or import.meta.url to get the path of the file you are in and pass it to this function. Set the `levelsUp`
+ * based on how your project is packaged. For instance, if your file is packaged in `dist/cli.js` and you would use `1` if
+ * you packaged your file is in `dist/src/cli.js` and you would use `2`. Whatever you need to get to the root.
+ * Then the path parts are the path to the file you want to read, relative to the root of your project with each
+ * directory as a separate string in the array and the file name as the last string in the array. They will be
+ * joined together in a way that makes sense for the OS and module type your package is running in.
+ *
+ * @param currentFile the path to start from use `import.meta.url` or `__filename` for most cases
+ * @param levelsUp since __import.meta.url or __filename is the file you are in, you need to go up a few levels to ge to the root of your project. Use 0 for the current directory of the file you're calling from.
+ * @param pathParts the path to the file, relative to the new root
+ * @returns the contents of the file as a string
+ */
+export declare function readRelativeFile(currentFile: string, levelsUp: number, pathParts: string[]): Promise<string>;
+//# sourceMappingURL=readRelative.d.ts.map

package/dist/esm/readRelative.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"readRelative.d.ts","sourceRoot":"","sources":["../../src/readRelative.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,gBAAgB,CACpC,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EAAE,GAClB,OAAO,CAAC,MAAM,CAAC,CAgBjB"}

package/dist/esm/readRelative.js

@@ -0,0 +1,35 @@
+import { readFile } from 'fs/promises';
+import { join, sep } from 'path';
+/**
+ * A relatively sane way to read a file from a relative path inside your packaged cli app. For instance to
+ * read the package.json inside your package. Works on ESM and CommonJS modules. Use __filename
+ * or import.meta.url to get the path of the file you are in and pass it to this function. Set the `levelsUp`
+ * based on how your project is packaged. For instance, if your file is packaged in `dist/cli.js` and you would use `1` if
+ * you packaged your file is in `dist/src/cli.js` and you would use `2`. Whatever you need to get to the root.
+ * Then the path parts are the path to the file you want to read, relative to the root of your project with each
+ * directory as a separate string in the array and the file name as the last string in the array. They will be
+ * joined together in a way that makes sense for the OS and module type your package is running in.
+ *
+ * @param currentFile the path to start from use `import.meta.url` or `__filename` for most cases
+ * @param levelsUp since __import.meta.url or __filename is the file you are in, you need to go up a few levels to ge to the root of your project. Use 0 for the current directory of the file you're calling from.
+ * @param pathParts the path to the file, relative to the new root
+ * @returns the contents of the file as a string
+ */
+export async function readRelativeFile(currentFile, levelsUp, pathParts) {
+    const isEsm = currentFile.startsWith('file://');
+    const backSegments = Array(levelsUp).fill('..');
+    if (isEsm) {
+        const dirPath = currentFile.slice(0, currentFile.lastIndexOf('/'));
+        const { fileURLToPath } = await import('node:url');
+        const { join } = await import('node:path');
+        const startPath = fileURLToPath(dirPath);
+        const fullPath = join(startPath, ...backSegments, ...pathParts);
+        return await readFile(fullPath, 'utf8');
+    }
+    else {
+        const dirPath = currentFile.slice(0, currentFile.lastIndexOf(sep));
+        const contents = await readFile(join(dirPath, ...backSegments, ...pathParts), 'utf8');
+        return contents;
+    }
+}
+//# sourceMappingURL=readRelative.js.map

package/dist/esm/readRelative.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"readRelative.js","sourceRoot":"","sources":["../../src/readRelative.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AACtC,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,MAAM,CAAA;AAEhC;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,WAAmB,EACnB,QAAgB,EAChB,SAAmB;IAEnB,MAAM,KAAK,GAAG,WAAW,CAAC,UAAU,CAAC,SAAS,CAAC,CAAA;IAC/C,MAAM,YAAY,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAE/C,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,OAAO,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAA;QAClE,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,MAAM,CAAC,UAAU,CAAC,CAAA;QAClD,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC,CAAA;QAC1C,MAAM,SAAS,GAAG,aAAa,CAAC,OAAO,CAAC,CAAA;QACxC,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,EAAE,GAAG,YAAY,EAAE,GAAG,SAAS,CAAC,CAAA;QAC/D,OAAO,MAAM,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;IACzC,CAAC;SAAM,CAAC;QACN,MAAM,OAAO,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAA;QAClE,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,YAAY,EAAE,GAAG,SAAS,CAAC,EAAE,MAAM,CAAC,CAAA;QACrF,OAAO,QAAQ,CAAA;IACjB,CAAC;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloud-copilot/cli",
-  "version": "0.1.17",
+  "version": "0.1.19",
   "description": "A standardized library for CLI building TypeScript CLI applications",
   "repository": {
     "type": "git",