@oclif/core 4.5.6-autocomplete.0 → 4.6.0

package/lib/help/command.js

@@ -58,7 +58,8 @@ class CommandHelp extends formatter_1.HelpFormatter {
             return;
         return args.map((a) => {
             // Add ellipsis to indicate that the argument takes multiple values if strict is false
-            const name = this.command.strict === false ? `${a.name.toUpperCase()}...` : a.name.toUpperCase();
+            let name = this.command.strict === false ? `${a.name.toUpperCase()}...` : a.name.toUpperCase();
+            name = a.required ? `${name}` : `[${name}]`;
             let description = a.description || '';
             if (a.default)
                 description = `${(0, theme_1.colorize)(this.config?.theme?.flagDefaultValue, `[default: ${a.default}]`)} ${description}`;

package/lib/help/docopts.js

@@ -165,8 +165,22 @@ class DocOpts {
             if (Array.isArray(flag.dependsOn)) {
                 this.combineElementsToFlag(elementMap, flag.name, flag.dependsOn, ' ');
             }
+            let exclusive;
             if (Array.isArray(flag.exclusive)) {
-                this.combineElementsToFlag(elementMap, flag.name, flag.exclusive, ' | ');
+                exclusive = new Set(flag.exclusive);
+            }
+            if (Array.isArray(flag.combinable)) {
+                const combinableFlags = new Set(flag.combinable);
+                exclusive ??= new Set();
+                for (const item of this.flagList) {
+                    // each flag not in the "combinable" list, is equivalent to an "exclusive" flag
+                    if (flag !== item && !combinableFlags.has(item.name)) {
+                        exclusive.add(item.name);
+                    }
+                }
+            }
+            if (exclusive !== undefined && exclusive.size > 0) {
+                this.combineElementsToFlag(elementMap, flag.name, [...exclusive], ' | ');
             }
         }
         // Since combineElementsToFlag deletes the references in this.flags when it combines

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, Completion, CompletionContext, CustomOptions, Deprecation, Flag, FlagDefinition, FlagInput, Input, OptionFlag, OutputArgs, OutputFlags, ParserOutput, } from './parser';
+export type { Arg, ArgDefinition, ArgInput, BooleanFlag, 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,6 +1,5 @@
 import { Command } from '../command';
 import { AlphabetLowercase, AlphabetUppercase } from './alphabet';
-import { Config } from './config';
 export type FlagOutput = {
     [name: string]: any;
 };
@@ -88,7 +87,7 @@ export type FlagRelationship = string | {
     when: (flags: Record<string, unknown>) => Promise<boolean>;
 };
 export type Relationship = {
-    type: 'all' | 'some' | 'none';
+    type: 'all' | 'some' | 'none' | 'only';
     flags: FlagRelationship[];
 };
 export type Deprecation = {
@@ -139,6 +138,10 @@ export type FlagProps = {
      * List of flags that cannot be used with this flag.
      */
     exclusive?: string[];
+    /**
+     * List of the only flags that can be used with this flag.
+     */
+    combinable?: string[];
     /**
      * Exactly one of these flags must be provided.
      */
@@ -224,21 +227,6 @@ 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;
@@ -463,58 +451,6 @@ 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/lib/parser/validate.js

@@ -57,6 +57,7 @@ async function validate(parse) {
                     ...(flag.relationships ? validateRelationships(name, flag) : []),
                     ...(flag.dependsOn ? [validateDependsOn(name, flag.dependsOn)] : []),
                     ...(flag.exclusive ? [validateExclusive(name, flag.exclusive)] : []),
+                    ...(flag.combinable ? [validateCombinable(name, flag.combinable)] : []),
                     ...(flag.exactlyOne ? [validateExactlyOne(name, flag.exactlyOne)] : []),
                 ];
             }
@@ -143,6 +144,29 @@ async function validate(parse) {
         }
         return { ...base, status: 'success' };
     }
+    async function validateCombinable(name, flags) {
+        const base = { name, validationFn: 'validateCombinable' };
+        const combinableFlags = new Set(flags.map((flag) => (typeof flag === 'string' ? flag : flag.name)));
+        const resolved = await resolveFlags(flags);
+        for (const flag of Object.keys(parse.output.flags)) {
+            // do not enforce exclusivity for flags that were defaulted
+            if (parse.output.metadata.flags && parse.output.metadata.flags[flag]?.setFromDefault)
+                continue;
+            if (parse.output.metadata.flags && parse.output.metadata.flags[name]?.setFromDefault)
+                continue;
+            if (flag !== name && parse.output.flags[flag] !== undefined && !combinableFlags.has(flag)) {
+                const formattedFlags = Object.keys(resolved)
+                    .map((f) => `--${f}`)
+                    .join(', ');
+                return {
+                    ...base,
+                    reason: `Only the following can be provided when using --${name}: ${formattedFlags}`,
+                    status: 'failed',
+                };
+            }
+        }
+        return { ...base, status: 'success' };
+    }
     async function validateExactlyOne(name, flags) {
         const base = { name, validationFn: 'validateExactlyOne' };
         const resolved = await resolveFlags(flags);
@@ -195,6 +219,9 @@ async function validate(parse) {
                 case 'none': {
                     return validateExclusive(name, relationship.flags);
                 }
+                case 'only': {
+                    return validateCombinable(name, relationship.flags);
+                }
                 case 'some': {
                     return validateSome(name, relationship.flags);
                 }

package/lib/util/cache-command.js

@@ -20,6 +20,7 @@ async function cacheFlags(cmdFlags, respectNoCacheDefault) {
             aliases: flag.aliases,
             char: flag.char,
             charAliases: flag.charAliases,
+            combinable: flag.combinable,
             dependsOn: flag.dependsOn,
             deprecateAliases: flag.deprecateAliases,
             deprecated: flag.deprecated,

package/package.json

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