positionals wip

Author: Aslemammad

demo.citty.ts

@@ -24,7 +24,9 @@ const devCommand = defineCommand({
         host: { type: "string", description: "Specify hostname" },
         port: { type: "string", description: "Specify port" },
     },
-    run({ args }) { },
+    run(ctx) { 
+        console.log('dev', ctx)
+    },
 });
 
 devCommand.subCommands = {
@@ -37,13 +39,39 @@ devCommand.subCommands = {
     })
 }
 
+const lintCommand = defineCommand({
+    meta: {
+        name: "lint",
+        description: "Lint project",
+    },
+    args: {
+        files: { type: "positional", description: "Files to lint" },
+    },
+    run(ctx) { 
+        console.log('lint', ctx.cmd.args)
+    },
+});
+
 main.subCommands = {
-    dev: devCommand
+    dev: devCommand,
+    lint: lintCommand
+
 } as Record<string, CommandDef<any>>;
 
 const completion = await tab(main)
 
 for (const command of completion.commands.values()) {
+    console.log(command)
+
+    if (command.name === 'lint') {
+        console.log('lint')
+        command.handler = () => {
+            return [
+                { value: "main.ts", description: "Main file" },
+                { value: "index.ts", description: "Index file" },
+            ]
+        }
+    }
 
     for (const [o, config] of command.options.entries()) {
         if (o === "--port") {

src/citty.ts

@@ -4,7 +4,7 @@ import * as bash from "./bash";
 import * as fish from "./fish";
 import * as powershell from "./powershell";
 import { Completion } from ".";
-import type { ArgsDef, CommandDef, PositionalArgDef } from "citty";
+import type { ArgsDef, CommandDef, PositionalArgDef, SubCommandsDef } from "citty";
 
 function quoteIfNeeded(path) {
   return path.includes(" ") ? `'${path}'` : path;
@@ -17,32 +17,40 @@ const quotedProcessArgs = processArgs.map(quoteIfNeeded);
 const quotedProcessExecArgs = process.execArgv.map(quoteIfNeeded);
 const x = `${quotedExecPath} ${quotedProcessExecArgs.join(" ")} ${quotedProcessArgs[0]}`;
 
-async function handleSubCommands(
+function isConfigPositional<T extends ArgsDef>(config: CommandDef<T>) {
+  return config.args && Object.values(config.args).some(arg => arg.type === 'positional')
+}
+
+async function handleSubCommands<T extends ArgsDef = ArgsDef>(
   completion: Completion,
-  subCommands: Record<string, any>,
+  subCommands: SubCommandsDef,
   parentCmd?: string
 ) {
   for (const [cmd, resolvableConfig] of Object.entries(subCommands)) {
     const config = await resolve(resolvableConfig);
     const meta = await resolve(config.meta);
+    const subCommands = await resolve(config.subCommands)
 
     if (!meta || typeof meta?.description !== "string") {
       throw new Error("Invalid meta or missing description.");
     }
-
-    const name = completion.addCommand(cmd, meta.description, async (previousArgs, toComplete, endsWithSpace) => {
+    const isPositional = isConfigPositional(config)
+    const name = completion.addCommand(cmd, meta.description, isPositional ? [false] : [], async (previousArgs, toComplete, endsWithSpace) => {
       return []
     }, parentCmd);
 
     // Handle nested subcommands recursively
-    if (config.subCommands) {
-      await handleSubCommands(completion, config.subCommands, name);
+    if (subCommands) {
+      await handleSubCommands(completion, subCommands, name);
     }
 
     // Handle arguments
     if (config.args) {
       for (const [argName, argConfig] of Object.entries(config.args)) {
         const conf = argConfig as ArgDef;
+        if (conf.type === 'positional') {
+          continue
+        }
         completion.addOption(
           name,
           `--${argName}`,
@@ -75,7 +83,8 @@ export default async function tab<T extends ArgsDef = ArgsDef>(instance: Command
   }
 
   const root = ''
-  completion.addCommand(root, meta?.description ?? "", async (previousArgs, toComplete, endsWithSpace) => {
+  const isPositional = isConfigPositional(instance)
+  completion.addCommand(root, meta?.description ?? "", isPositional ? [false] : [], async (previousArgs, toComplete, endsWithSpace) => {
     return []
   });
 

src/index.ts

@@ -75,6 +75,7 @@ type Option = {
 }
 
 type Command = {
+    name: string;
     description: string;
     handler: Handler;
     options: Map<string, Option>;
@@ -84,9 +85,12 @@ type Command = {
 export class Completion {
     commands = new Map<string, Command>();
 
-    addCommand(name: string, description: string, handler: Handler, parent?: string) {
+    // vite <entry> <another> [...files]
+    // args: [false, false, true], only the last argument can be variadic
+    addCommand(name: string, description: string, args: boolean[], handler: Handler, parent?: string) {
         const key = parent ? `${parent} ${name}` : name;
         this.commands.set(key, {
+            name: key,
             description,
             handler,
             options: new Map(),
@@ -95,6 +99,7 @@ export class Completion {
         return key;
     }
 
+    // --port
     addOption(command: string, option: string, description: string, handler: Handler) {
         const cmd = this.commands.get(command);
         if (!cmd) {
@@ -215,7 +220,6 @@ export class Completion {
                     }
                 }
             }
-            completions.push({ value: 'dhere1', description: '' })
 
             directive = ShellCompDirective.ShellCompDirectiveNoFileComp;
         }
@@ -227,7 +231,8 @@ export class Completion {
         // TODO: prettier (plus check in ci)
         // TODO: ci type check
 
-        // TODO: positionals (tomorrow night)
+        // TODO: positionals (tomorrow night), this is nearly there! 
+        
         // TODO: cac (tomorrow night)
         // TODO: check behaviour of the tests (tomorrow night)