@oclif/core 4.5.5 → 4.5.6-autocomplete.0

package/lib/interfaces/index.d.ts

@@ -7,7 +7,7 @@ export type { HelpOptions } from './help';
 export type { Hook, Hooks } from './hooks';
 export type { Logger } from './logger';
 export type { Manifest } from './manifest';
-export type { Arg, ArgDefinition, ArgInput, BooleanFlag, CustomOptions, Deprecation, Flag, FlagDefinition, FlagInput, Input, OptionFlag, OutputArgs, OutputFlags, ParserOutput, } from './parser';
+export type { Arg, ArgDefinition, ArgInput, BooleanFlag, Completion, CompletionContext, CustomOptions, Deprecation, Flag, FlagDefinition, FlagInput, Input, OptionFlag, OutputArgs, OutputFlags, ParserOutput, } from './parser';
 export type { LinkedPlugin, OclifConfiguration, PJSON, S3, S3Templates, UserPJSON, UserPlugin } from './pjson';
 export type { Options, Plugin, PluginOptions } from './plugin';
 export type { S3Manifest } from './s3-manifest';

package/lib/interfaces/parser.d.ts

@@ -1,5 +1,6 @@
 import { Command } from '../command';
 import { AlphabetLowercase, AlphabetUppercase } from './alphabet';
+import { Config } from './config';
 export type FlagOutput = {
     [name: string]: any;
 };
@@ -223,6 +224,21 @@ export type OptionFlagProps = FlagProps & {
      * Should only be used on one flag at a time.
      */
     allowStdin?: boolean | 'only';
+    /**
+     * Optional dynamic completion configuration.
+     * Provides intelligent autocomplete suggestions for flag values based on context.
+     * Requires autocomplete plugin to be installed.
+     *
+     * @example
+     * ```typescript
+     * completion: {
+     *   options: async (ctx) => {
+     *     return ['option1', 'option2', 'option3']
+     *   }
+     * }
+     * ```
+     */
+    completion?: Completion;
 };
 export type FlagParserContext = Command & {
     token: FlagToken;
@@ -447,6 +463,58 @@ export type ParserInput = {
     context: ParserContext | undefined;
     '--'?: boolean | undefined;
 };
+/**
+ * Context provided to flag completion functions
+ */
+export type CompletionContext = {
+    /**
+     * Parsed arguments from the current command line
+     */
+    args?: {
+        [name: string]: string;
+    };
+    /**
+     * Array of raw arguments
+     */
+    argv?: string[];
+    /**
+     * oclif configuration object
+     */
+    config: Config;
+    /**
+     * Parsed flags from the current command line
+     */
+    flags?: {
+        [name: string]: string;
+    };
+};
+/**
+ * Completion configuration for a flag
+ */
+export type Completion = {
+    /**
+     * Function that returns completion options based on context
+     *
+     * @param ctx - Context containing parsed args, flags, and config
+     * @returns Promise resolving to array of completion strings
+     *
+     * @example
+     * ```typescript
+     * static flags = {
+     *   'target-org': Flags.string({
+     *     description: 'Target org',
+     *     completion: {
+     *       options: async (ctx) => {
+     *         const orgs = await getAuthenticatedOrgs()
+     *         return orgs.map(o => o.alias)
+     *       }
+     *     }
+     *   })
+     * }
+     * ```
+     */
+    options(ctx: CompletionContext): Promise<string[]>;
+};
 export type ParserContext = Command & {
     token?: FlagToken | ArgToken | undefined;
 };

package/package.json

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