@oclif/core 4.11.13 → 4.12.0

package/lib/args.d.ts

@@ -36,3 +36,21 @@ export declare const file: ArgDefinition<string, {
 export declare const url: ArgDefinition<URL, Record<string, unknown>>;
 declare const stringArg: ArgDefinition<string, Record<string, unknown>>;
 export { stringArg as string };
+type ReadonlyElementOf<T extends ReadonlyArray<unknown>> = T[number];
+/**
+ * Create an arg that infers the type from the provided options.
+ *
+ * The provided `options` must be a readonly array in order for type inference to work.
+ *
+ * @example
+ * export default class MyCommand extends Command {
+ *   static args = {
+ *     stage: Args.option({
+ *       options: ['production', 'staging', 'development'] as const,
+ *     })(),
+ *   }
+ * }
+ */
+export declare function option<T extends readonly string[]>(defaults: Omit<Partial<Arg<ReadonlyElementOf<T>>>, 'default' | 'multiple' | 'required'> & {
+    options: T;
+}): ArgDefinition<(typeof defaults.options)[number]>;

package/lib/args.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.string = exports.url = exports.file = exports.directory = exports.integer = exports.boolean = void 0;
 exports.custom = custom;
+exports.option = option;
 const node_url_1 = require("node:url");
 const fs_1 = require("./util/fs");
 const util_1 = require("./util/util");
@@ -59,3 +60,26 @@ exports.url = custom({
 });
 const stringArg = custom({});
 exports.string = stringArg;
+/**
+ * Create an arg that infers the type from the provided options.
+ *
+ * The provided `options` must be a readonly array in order for type inference to work.
+ *
+ * @example
+ * export default class MyCommand extends Command {
+ *   static args = {
+ *     stage: Args.option({
+ *       options: ['production', 'staging', 'development'] as const,
+ *     })(),
+ *   }
+ * }
+ */
+function option(defaults) {
+    return (options = {}) => ({
+        parse: async (i, _context, _opts) => i,
+        ...defaults,
+        ...options,
+        input: [],
+        type: 'option',
+    });
+}

package/lib/interfaces/parser.d.ts

@@ -198,7 +198,7 @@ export type ArgProps = {
      * All args after a variadic arg must be required.
      */
     multiple?: boolean;
-    options?: string[];
+    options?: readonly string[];
     ignoreStdin?: boolean;
     /**
      * If true, the value returned by defaultHelp will not be cached in the oclif.manifest.json.
@@ -244,7 +244,7 @@ export type ArgParserContext = Command & {
 };
 export type ArgParser<T, P = CustomOptions> = (input: string, context: ArgParserContext, opts: P & Arg<T, P>) => Promise<T>;
 export type Arg<T, P = CustomOptions> = ArgProps & {
-    options?: T[];
+    options?: readonly T[];
     defaultHelp?: ArgDefaultHelp<T>;
     input: string[];
     default?: ArgDefault<T | undefined>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/core",
   "description": "base library for oclif CLIs",
-  "version": "4.11.13",
+  "version": "4.12.0",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/core/issues",
   "dependencies": {