update

Author: AmirSa12

src/cac.ts

@@ -7,7 +7,7 @@ import { Completion } from './index';
 import {
   CompletionConfig,
   noopHandler,
-  requireDashDashSeparator,
+  assertDoubleDashes,
 } from './shared';
 
 const execPath = process.execPath;
@@ -89,23 +89,25 @@ export default async function tab(
         break;
       }
       default: {
-        if (!requireDashDashSeparator(instance.name)) {
-          return;
-        }
+        try {
+          assertDoubleDashes(instance.name);
 
-        const args: string[] = extra['--'] || [];
-        instance.showHelpOnExit = false;
+          const args: string[] = extra['--'] || [];
+          instance.showHelpOnExit = false;
 
-        // Parse current command context
-        instance.unsetMatchedCommand();
-        instance.parse([execPath, processArgs[0], ...args], {
-          run: false,
-        });
+          // Parse current command context
+          instance.unsetMatchedCommand();
+          instance.parse([execPath, processArgs[0], ...args], {
+            run: false,
+          });
 
-        // const matchedCommand = instance.matchedCommand?.name || '';
-        // const potentialCommand = args.join(' ')
-        // console.log(potentialCommand)
-        return completion.parse(args);
+          // const matchedCommand = instance.matchedCommand?.name || '';
+          // const potentialCommand = args.join(' ')
+          // console.log(potentialCommand)
+          return completion.parse(args);
+        } catch (error) {
+          return;
+        }
       }
     }
   });

src/citty.ts

@@ -14,7 +14,7 @@ import { generateFigSpec } from './fig';
 import {
   CompletionConfig,
   noopHandler,
-  requireDashDashSeparator,
+  assertDoubleDashes,
 } from './shared';
 
 function quoteIfNeeded(path: string) {
@@ -191,19 +191,21 @@ export default async function tab<TArgs extends ArgsDef>(
           break;
         }
         default: {
-          if (!requireDashDashSeparator(name)) {
+          try {
+            assertDoubleDashes(name);
+
+            const extra = ctx.rawArgs.slice(ctx.rawArgs.indexOf('--') + 1);
+            // const args = (await resolve(instance.args))!;
+            // const parsed = parseArgs(extra, args);
+            // TODO: this is not ideal at all
+            // const matchedCommand = parsed._.join(' ').trim(); //TODO: this was passed to parse line 170
+            // TODO: `command lint i` does not work because `lint` and `i` are potential commands
+            // instead the potential command should only be `lint`
+            // and `i` is the to be completed part
+            return completion.parse(extra);
+          } catch (error) {
             return;
           }
-
-          const extra = ctx.rawArgs.slice(ctx.rawArgs.indexOf('--') + 1);
-          // const args = (await resolve(instance.args))!;
-          // const parsed = parseArgs(extra, args);
-          // TODO: this is not ideal at all
-          // const matchedCommand = parsed._.join(' ').trim(); //TODO: this was passed to parse line 170
-          // TODO: `command lint i` does not work because `lint` and `i` are potential commands
-          // instead the potential command should only be `lint`
-          // and `i` is the to be completed part
-          return completion.parse(extra);
         }
       }
     },

src/commander.ts

@@ -4,7 +4,7 @@ import * as fish from './fish';
 import * as powershell from './powershell';
 import type { Command as CommanderCommand } from 'commander';
 import { Completion } from './';
-import { requireDashDashSeparator } from './shared';
+import { assertDoubleDashes } from './shared';
 
 const execPath = process.execPath;
 const processArgs = process.argv.slice(1);
@@ -80,12 +80,14 @@ export default function tab(instance: CommanderCommand): Completion {
           break;
         }
         default: {
-          if (!requireDashDashSeparator(programName)) {
+          try {
+            assertDoubleDashes(programName);
+
+            // Parse current command context for autocompletion
+            return completion.parse(extra);
+          } catch (error) {
             return;
           }
-
-          // Parse current command context for autocompletion
-          return completion.parse(extra);
         }
       }
     });

src/shared.ts

@@ -17,13 +17,11 @@ export interface CompletionConfig {
   >;
 }
 
-export function requireDashDashSeparator(programName: string): boolean {
+export function assertDoubleDashes(programName: string = 'cli'): void {
   const dashDashIndex = process.argv.indexOf('--');
-  const wasDashDashProvided = dashDashIndex !== -1;
 
-  if (!wasDashDashProvided) {
-    console.error('Error: You need to use -- to separate completion arguments');
+  if (dashDashIndex === -1) {
+    const errorMessage = `Error: You need to use -- to separate completion arguments.\nExample: ${programName} complete -- <args>`;
+    console.error(errorMessage);
   }
-
-  return wasDashDashProvided;
 }