incur 0.3.4 → 0.3.6

package/dist/internal/configSchema.js

@@ -0,0 +1,57 @@
+import fs from 'node:fs/promises';
+import * as Cli from '../Cli.js';
+import * as Schema from '../Schema.js';
+import { importCli } from './utils.js';
+/** Returns `true` if the CLI has `config` enabled on `Cli.create()`. */
+export function hasConfig(cli) {
+    return Cli.toConfigEnabled.get(cli) === true;
+}
+/** Imports a CLI from `input` (must `export default` a `Cli`), generates the JSON Schema, and writes it to `output`. */
+export async function generate(input, output) {
+    const cli = await importCli(input);
+    await fs.writeFile(output, JSON.stringify(fromCli(cli), null, 2) + '\n');
+}
+/** Generates a JSON Schema describing the config file structure for a CLI. */
+export function fromCli(cli) {
+    const commands = Cli.toCommands.get(cli);
+    if (!commands)
+        return { type: 'object' };
+    const rootOptions = Cli.toRootOptions.get(cli);
+    const node = buildNode(commands, rootOptions);
+    const properties = (node.properties ?? {});
+    properties.$schema = { type: 'string' };
+    node.properties = properties;
+    return node;
+}
+/** Builds a JSON Schema node for a command level. */
+function buildNode(commands, options) {
+    const properties = {};
+    // Add `options` property from the options schema
+    if (options) {
+        const optSchema = Schema.toJsonSchema(options);
+        const props = optSchema.properties;
+        if (props && Object.keys(props).length > 0)
+            properties.options = { type: 'object', additionalProperties: false, properties: props };
+    }
+    // Add `commands` property with subcommand namespaces
+    const commandProps = {};
+    for (const [name, entry] of commands) {
+        if ('_group' in entry && entry._group) {
+            commandProps[name] = buildNode(entry.commands, undefined);
+        }
+        else if (!('_fetch' in entry)) {
+            const cmd = entry;
+            commandProps[name] = buildNode(new Map(), cmd.options);
+        }
+    }
+    if (Object.keys(commandProps).length > 0)
+        properties.commands = { type: 'object', additionalProperties: false, properties: commandProps };
+    const node = {
+        type: 'object',
+        additionalProperties: false,
+    };
+    if (Object.keys(properties).length > 0)
+        node.properties = properties;
+    return node;
+}
+//# sourceMappingURL=configSchema.js.map

package/dist/internal/configSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"configSchema.js","sourceRoot":"","sources":["../../src/internal/configSchema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,kBAAkB,CAAA;AAGjC,OAAO,KAAK,GAAG,MAAM,WAAW,CAAA;AAChC,OAAO,KAAK,MAAM,MAAM,cAAc,CAAA;AACtC,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAEtC,wEAAwE;AACxE,MAAM,UAAU,SAAS,CAAC,GAAY;IACpC,OAAO,GAAG,CAAC,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,IAAI,CAAA;AAC9C,CAAC;AAED,wHAAwH;AACxH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,KAAa,EAAE,MAAc;IAC1D,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,KAAK,CAAC,CAAA;IAClC,MAAM,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC,CAAA;AAC1E,CAAC;AAED,8EAA8E;AAC9E,MAAM,UAAU,OAAO,CAAC,GAAY;IAClC,MAAM,QAAQ,GAAG,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;IACxC,IAAI,CAAC,QAAQ;QAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAA;IAExC,MAAM,WAAW,GAAG,GAAG,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;IAC9C,MAAM,IAAI,GAAG,SAAS,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAA;IAC7C,MAAM,UAAU,GAAG,CAAC,IAAI,CAAC,UAAU,IAAI,EAAE,CAA4B,CAAA;IACrE,UAAU,CAAC,OAAO,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAA;IACvC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;IAC5B,OAAO,IAAI,CAAA;AACb,CAAC;AAED,qDAAqD;AACrD,SAAS,SAAS,CAChB,QAA0B,EAC1B,OAA0B;IAE1B,MAAM,UAAU,GAA4B,EAAE,CAAA;IAE9C,iDAAiD;IACjD,IAAI,OAAO,EAAE,CAAC;QACZ,MAAM,SAAS,GAAG,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,CAAA;QAC9C,MAAM,KAAK,GAAG,SAAS,CAAC,UAAiD,CAAA;QACzE,IAAI,KAAK,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,GAAG,CAAC;YACxC,UAAU,CAAC,OAAO,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,oBAAoB,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,CAAA;IAC3F,CAAC;IAED,qDAAqD;IACrD,MAAM,YAAY,GAA4B,EAAE,CAAA;IAChD,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,QAAQ,EAAE,CAAC;QACrC,IAAI,QAAQ,IAAI,KAAK,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;YACtC,YAAY,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,KAAK,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAA;QAC3D,CAAC;aAAM,IAAI,CAAC,CAAC,QAAQ,IAAI,KAAK,CAAC,EAAE,CAAC;YAChC,MAAM,GAAG,GAAG,KAAuC,CAAA;YACnD,YAAY,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,IAAI,GAAG,EAAE,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;QACxD,CAAC;IACH,CAAC;IACD,IAAI,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,MAAM,GAAG,CAAC;QACtC,UAAU,CAAC,QAAQ,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,oBAAoB,EAAE,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,CAAA;IAEjG,MAAM,IAAI,GAA4B;QACpC,IAAI,EAAE,QAAQ;QACd,oBAAoB,EAAE,KAAK;KAC5B,CAAA;IACD,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,GAAG,CAAC;QAAE,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;IACpE,OAAO,IAAI,CAAA;AACb,CAAC"}

package/dist/internal/helpers.d.ts

@@ -0,0 +1,5 @@
+/** Checks whether a value is a plain object record. */
+export declare function isRecord(value: unknown): value is Record<string, unknown>;
+/** Converts a camelCase string to kebab-case. */
+export declare function toKebab(value: string): string;
+//# sourceMappingURL=helpers.d.ts.map

package/dist/internal/helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../src/internal/helpers.ts"],"names":[],"mappings":"AAAA,uDAAuD;AACvD,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAEzE;AAED,iDAAiD;AACjD,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAE7C"}

package/dist/internal/helpers.js

@@ -0,0 +1,9 @@
+/** Checks whether a value is a plain object record. */
+export function isRecord(value) {
+    return typeof value === 'object' && value !== null && !Array.isArray(value);
+}
+/** Converts a camelCase string to kebab-case. */
+export function toKebab(value) {
+    return value.replace(/[A-Z]/g, (c) => `-${c.toLowerCase()}`);
+}
+//# sourceMappingURL=helpers.js.map

package/dist/internal/helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../src/internal/helpers.ts"],"names":[],"mappings":"AAAA,uDAAuD;AACvD,MAAM,UAAU,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;AAC7E,CAAC;AAED,iDAAiD;AACjD,MAAM,UAAU,OAAO,CAAC,KAAa;IACnC,OAAO,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAA;AAC9D,CAAC"}

package/examples/npm/.npmrc.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "./config.schema.json",
+  "commands": {
+    "install": {
+      "options": {
+        "saveExact": true
+      }
+    },
+    "publish": {
+      "options": {
+        "access": "public",
+        "tag": "latest"
+      }
+    },
+    "outdated": {
+      "options": {
+        "long": true
+      }
+    }
+  }
+}

package/examples/npm/config.schema.json

@@ -0,0 +1,137 @@
+{
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "$schema": {
+      "type": "string"
+    },
+    "commands": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "install": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "options": {
+              "type": "object",
+              "additionalProperties": false,
+              "properties": {
+                "saveDev": {
+                  "description": "Save as dev dependency",
+                  "type": "boolean"
+                },
+                "saveExact": {
+                  "description": "Save exact version",
+                  "type": "boolean"
+                },
+                "global": {
+                  "description": "Install globally",
+                  "type": "boolean"
+                }
+              }
+            }
+          }
+        },
+        "info": {
+          "type": "object",
+          "additionalProperties": false
+        },
+        "init": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "options": {
+              "type": "object",
+              "additionalProperties": false,
+              "properties": {
+                "yes": {
+                  "type": "boolean",
+                  "description": "Skip prompts and use defaults"
+                },
+                "scope": {
+                  "description": "Package scope",
+                  "type": "string"
+                }
+              }
+            }
+          }
+        },
+        "publish": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "options": {
+              "type": "object",
+              "additionalProperties": false,
+              "properties": {
+                "tag": {
+                  "default": "latest",
+                  "description": "Distribution tag",
+                  "type": "string"
+                },
+                "access": {
+                  "default": "public",
+                  "description": "Package access level",
+                  "type": "string",
+                  "enum": [
+                    "public",
+                    "restricted"
+                  ]
+                },
+                "dryRun": {
+                  "type": "boolean",
+                  "description": "Report what would be published"
+                },
+                "otp": {
+                  "description": "One-time password for 2FA",
+                  "type": "string"
+                }
+              }
+            }
+          }
+        },
+        "run": {
+          "type": "object",
+          "additionalProperties": false
+        },
+        "uninstall": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "options": {
+              "type": "object",
+              "additionalProperties": false,
+              "properties": {
+                "global": {
+                  "type": "boolean",
+                  "description": "Remove global package"
+                }
+              }
+            }
+          }
+        },
+        "outdated": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "options": {
+              "type": "object",
+              "additionalProperties": false,
+              "properties": {
+                "global": {
+                  "type": "boolean",
+                  "description": "Check global packages"
+                },
+                "long": {
+                  "type": "boolean",
+                  "description": "Show extended information"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/package.json

@@ -16,7 +16,7 @@
   "[!start-pkg]": "",
   "name": "incur",
   "type": "module",
-  "version": "0.3.4",
+  "version": "0.3.6",
   "license": "MIT",
   "repository": {
     "type": "git",

package/src/Cli.test-d.ts

@@ -289,3 +289,42 @@ test('run() context exposes format metadata', () => {
     },
   })
 })
+
+test('create() accepts config-file defaults options', () => {
+  Cli.create('test', {
+    config: {},
+  })
+
+  Cli.create('test', {
+    config: { flag: 'config' },
+  })
+
+  Cli.create('test', {
+    config: { files: ['.myrc.json', '~/.config/my/config.json'] },
+  })
+
+  Cli.create('test', {
+    config: {
+      flag: 'config',
+      files: ['config.toml'],
+      loader: async (path) => {
+        if (!path) return undefined
+        return { key: 'value' }
+      },
+    },
+  })
+
+  Cli.create('test', {
+    config: { loader: async () => ({ key: 'value' }) },
+  })
+
+  Cli.create('test', {
+    // @ts-expect-error — flag must be a string
+    config: { flag: true },
+  })
+
+  Cli.create('test', {
+    // @ts-expect-error — files must be string[]
+    config: { files: [42] },
+  })
+})