politty 0.0.1 → 0.1.1

package/dist/completion/index.d.cts

@@ -0,0 +1,153 @@
+import { d as Command, n as ResolvedFieldMeta, s as AnyCommand } from "../schema-extractor-D-Eo7I77.cjs";
+import { z } from "zod";
+
+//#region src/completion/types.d.ts
+
+/**
+ * Supported shell types for completion
+ */
+type ShellType = "bash" | "zsh" | "fish";
+/**
+ * Options for completion generation
+ */
+interface CompletionOptions {
+  /** The shell type to generate completion for */
+  shell: ShellType;
+  /** The command name as it will be invoked */
+  programName: string;
+  /** Include subcommand completions (default: true) */
+  includeSubcommands?: boolean;
+  /** Include description in completions where supported (default: true) */
+  includeDescriptions?: boolean;
+}
+/**
+ * Information about a completable option
+ */
+interface CompletableOption {
+  /** Long option name (e.g., "verbose") */
+  name: string;
+  /** CLI name (kebab-case, e.g., "dry-run") */
+  cliName: string;
+  /** Short alias (e.g., "v") */
+  alias?: string | undefined;
+  /** Description for completion */
+  description?: string | undefined;
+  /** Whether this option takes a value */
+  takesValue: boolean;
+  /** Type of value expected */
+  valueType: "string" | "number" | "boolean" | "array" | "unknown";
+  /** Whether the option is required */
+  required: boolean;
+}
+/**
+ * Information about a subcommand for completion
+ */
+interface CompletableSubcommand {
+  /** Subcommand name */
+  name: string;
+  /** Subcommand description */
+  description?: string | undefined;
+  /** Nested subcommands */
+  subcommands: CompletableSubcommand[];
+  /** Options for this subcommand */
+  options: CompletableOption[];
+}
+/**
+ * Extracted completion data from a command
+ */
+interface CompletionData {
+  /** The root command */
+  command: CompletableSubcommand;
+  /** Program name */
+  programName: string;
+  /** Global options (available to all subcommands) */
+  globalOptions: CompletableOption[];
+}
+/**
+ * Result of completion generation
+ */
+interface CompletionResult {
+  /** The generated completion script */
+  script: string;
+  /** The shell type this script is for */
+  shell: ShellType;
+  /** Instructions for installing the completion */
+  installInstructions: string;
+}
+/**
+ * Generator function type for shell completions
+ */
+type CompletionGenerator = (command: AnyCommand, options: CompletionOptions) => CompletionResult;
+//#endregion
+//#region src/completion/extractor.d.ts
+/**
+ * Extract positional arguments from a command
+ */
+declare function extractPositionals(command: AnyCommand): ResolvedFieldMeta[];
+/**
+ * Extract completion data from a command tree
+ */
+declare function extractCompletionData(command: AnyCommand, programName: string): CompletionData;
+//#endregion
+//#region src/completion/index.d.ts
+
+/**
+ * Generate completion script for the specified shell
+ */
+declare function generateCompletion(command: AnyCommand, options: CompletionOptions): CompletionResult;
+/**
+ * Get the list of supported shells
+ */
+declare function getSupportedShells(): ShellType[];
+/**
+ * Detect the current shell from environment
+ */
+declare function detectShell(): ShellType | null;
+/**
+ * Schema for the completion command arguments
+ */
+declare const completionArgsSchema: z.ZodObject<{
+  shell: z.ZodOptional<z.ZodEnum<{
+    bash: "bash";
+    zsh: "zsh";
+    fish: "fish";
+  }>>;
+  instructions: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>;
+type CompletionArgs = z.infer<typeof completionArgsSchema>;
+/**
+ * Create a completion subcommand for your CLI
+ *
+ * This creates a ready-to-use subcommand that generates completion scripts.
+ *
+ * @example
+ * ```typescript
+ * const mainCommand = defineCommand({
+ *   name: "mycli",
+ *   subCommands: {
+ *     completion: createCompletionCommand(mainCommand, "mycli")
+ *   }
+ * });
+ * ```
+ */
+declare function createCompletionCommand(rootCommand: AnyCommand, programName: string): Command<typeof completionArgsSchema, CompletionArgs, any>;
+/**
+ * Helper to add completion command to an existing command's subCommands
+ *
+ * @example
+ * ```typescript
+ * const command = defineCommand({
+ *   name: "mycli",
+ *   subCommands: {
+ *     ...withCompletionCommand(command, "mycli"),
+ *     // other subcommands
+ *   }
+ * });
+ * ```
+ */
+declare function withCompletionCommand(rootCommand: AnyCommand, programName: string): {
+  completion: ReturnType<typeof createCompletionCommand>;
+};
+//#endregion
+export { type CompletableOption, type CompletableSubcommand, type CompletionData, type CompletionGenerator, type CompletionOptions, type CompletionResult, type ShellType, createCompletionCommand, detectShell, extractCompletionData, extractPositionals, generateCompletion, getSupportedShells, withCompletionCommand };
+//# sourceMappingURL=index.d.cts.map

package/dist/completion/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","names":[],"sources":["../../src/completion/types.ts","../../src/completion/extractor.ts","../../src/completion/index.ts"],"sourcesContent":[],"mappings":";;;;;AASA;AAKA;AAcA;AAoBiB,KAvCL,SAAA,GAuCK,MAAqB,GAAA,KAAA,GAMvB,MAAA;AAQf;AAYA;AAYA;AACW,UAzEM,iBAAA,CAyEN;EACA;EACN,KAAA,EAzEI,SAyEJ;EAAgB;;;;EChDL;EA4CA,mBAAA,CAAA,EAAA,OAAqB;;;;AClCrC;AACW,UFxBM,iBAAA,CEwBN;EACA;EACR,IAAA,EAAA,MAAA;EAAgB;EAgBH,OAAA,EAAA,MAAA;EAOA;EAoBV,KAAA,CAAA,EAAA,MAAA,GAAA,SAgBJ;;;;;;EAhBwB,SAAA,EAAA,QAAA,GAAA,QAAA,GAAA,SAAA,GAAA,OAAA,GAAA,SAAA;EAAA;EAkBrB,QAAA,EAAA,OAAc;AAiBnB;;;;AAIG,UFxFc,qBAAA,CEwFd;EAAO;EA4CM,IAAA,EAAA,MAAA;EACD;EAEoB,WAAA,CAAA,EAAA,MAAA,GAAA,SAAA;EAAlB;EAAU,WAAA,EFjIZ,qBEiIY,EAAA;;WF/HhB;;;;;UAMM,cAAA;;WAEN;;;;iBAIM;;;;;UAMA,gBAAA;;;;SAIR;;;;;;;KAQG,mBAAA,aACD,qBACA,sBACN;;;AA7DL;AAoBA;AAcA;AAYiB,iBCjCD,kBAAA,CDqCP,OAAS,ECrC0B,UDqC1B,CAAA,ECrCuC,iBDqCvC,EAAA;AAQlB;;;AAGK,iBCJW,qBAAA,CDIX,OAAA,ECJ0C,UDI1C,EAAA,WAAA,EAAA,MAAA,CAAA,ECJ4E,cDI5E;;;;AEGJ;;;iBAzCe,kBAAA,UACL,qBACA,oBACR;;;;AA2CuB,iBA3BV,kBAAA,CAAA,CA2BU,EA3BY,SA2BZ,EAAA;AAAA;AAmC1B;;AAIkB,iBA3DF,WAAA,CAAA,CA2DE,EA3Da,SA2Db,GAAA,IAAA;;;;AA4ClB,cAnFM,oBAmF+B,EAnFX,CAAA,CAAA,SAmFW,CAAA;EACtB,KAAA,eAAA,UAAA,CAAA;IAEoB,IAAA,EAAA,MAAA;IAAlB,GAAA,EAAA,KAAA;IAAU,IAAA,EAAA,MAAA;;;;KApEtB,cAAA,GAAiB,CAAA,CAAE,aAAa;;;;;;;;;;;;;;;;iBAiBrB,uBAAA,cACD,kCAGZ,eAAe,sBAAsB;;;;;;;;;;;;;;;iBA4CxB,qBAAA,cACD;cAEE,kBAAkB"}

package/dist/completion/index.d.ts

@@ -0,0 +1,153 @@
+import { d as Command, n as ResolvedFieldMeta, s as AnyCommand } from "../schema-extractor-kkajLb9E.js";
+import { z } from "zod";
+
+//#region src/completion/types.d.ts
+
+/**
+ * Supported shell types for completion
+ */
+type ShellType = "bash" | "zsh" | "fish";
+/**
+ * Options for completion generation
+ */
+interface CompletionOptions {
+  /** The shell type to generate completion for */
+  shell: ShellType;
+  /** The command name as it will be invoked */
+  programName: string;
+  /** Include subcommand completions (default: true) */
+  includeSubcommands?: boolean;
+  /** Include description in completions where supported (default: true) */
+  includeDescriptions?: boolean;
+}
+/**
+ * Information about a completable option
+ */
+interface CompletableOption {
+  /** Long option name (e.g., "verbose") */
+  name: string;
+  /** CLI name (kebab-case, e.g., "dry-run") */
+  cliName: string;
+  /** Short alias (e.g., "v") */
+  alias?: string | undefined;
+  /** Description for completion */
+  description?: string | undefined;
+  /** Whether this option takes a value */
+  takesValue: boolean;
+  /** Type of value expected */
+  valueType: "string" | "number" | "boolean" | "array" | "unknown";
+  /** Whether the option is required */
+  required: boolean;
+}
+/**
+ * Information about a subcommand for completion
+ */
+interface CompletableSubcommand {
+  /** Subcommand name */
+  name: string;
+  /** Subcommand description */
+  description?: string | undefined;
+  /** Nested subcommands */
+  subcommands: CompletableSubcommand[];
+  /** Options for this subcommand */
+  options: CompletableOption[];
+}
+/**
+ * Extracted completion data from a command
+ */
+interface CompletionData {
+  /** The root command */
+  command: CompletableSubcommand;
+  /** Program name */
+  programName: string;
+  /** Global options (available to all subcommands) */
+  globalOptions: CompletableOption[];
+}
+/**
+ * Result of completion generation
+ */
+interface CompletionResult {
+  /** The generated completion script */
+  script: string;
+  /** The shell type this script is for */
+  shell: ShellType;
+  /** Instructions for installing the completion */
+  installInstructions: string;
+}
+/**
+ * Generator function type for shell completions
+ */
+type CompletionGenerator = (command: AnyCommand, options: CompletionOptions) => CompletionResult;
+//#endregion
+//#region src/completion/extractor.d.ts
+/**
+ * Extract positional arguments from a command
+ */
+declare function extractPositionals(command: AnyCommand): ResolvedFieldMeta[];
+/**
+ * Extract completion data from a command tree
+ */
+declare function extractCompletionData(command: AnyCommand, programName: string): CompletionData;
+//#endregion
+//#region src/completion/index.d.ts
+
+/**
+ * Generate completion script for the specified shell
+ */
+declare function generateCompletion(command: AnyCommand, options: CompletionOptions): CompletionResult;
+/**
+ * Get the list of supported shells
+ */
+declare function getSupportedShells(): ShellType[];
+/**
+ * Detect the current shell from environment
+ */
+declare function detectShell(): ShellType | null;
+/**
+ * Schema for the completion command arguments
+ */
+declare const completionArgsSchema: z.ZodObject<{
+  shell: z.ZodOptional<z.ZodEnum<{
+    bash: "bash";
+    zsh: "zsh";
+    fish: "fish";
+  }>>;
+  instructions: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>;
+type CompletionArgs = z.infer<typeof completionArgsSchema>;
+/**
+ * Create a completion subcommand for your CLI
+ *
+ * This creates a ready-to-use subcommand that generates completion scripts.
+ *
+ * @example
+ * ```typescript
+ * const mainCommand = defineCommand({
+ *   name: "mycli",
+ *   subCommands: {
+ *     completion: createCompletionCommand(mainCommand, "mycli")
+ *   }
+ * });
+ * ```
+ */
+declare function createCompletionCommand(rootCommand: AnyCommand, programName: string): Command<typeof completionArgsSchema, CompletionArgs, any>;
+/**
+ * Helper to add completion command to an existing command's subCommands
+ *
+ * @example
+ * ```typescript
+ * const command = defineCommand({
+ *   name: "mycli",
+ *   subCommands: {
+ *     ...withCompletionCommand(command, "mycli"),
+ *     // other subcommands
+ *   }
+ * });
+ * ```
+ */
+declare function withCompletionCommand(rootCommand: AnyCommand, programName: string): {
+  completion: ReturnType<typeof createCompletionCommand>;
+};
+//#endregion
+export { type CompletableOption, type CompletableSubcommand, type CompletionData, type CompletionGenerator, type CompletionOptions, type CompletionResult, type ShellType, createCompletionCommand, detectShell, extractCompletionData, extractPositionals, generateCompletion, getSupportedShells, withCompletionCommand };
+//# sourceMappingURL=index.d.ts.map

package/dist/completion/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../../src/completion/types.ts","../../src/completion/extractor.ts","../../src/completion/index.ts"],"sourcesContent":[],"mappings":";;;;;AASA;AAKA;AAcA;AAoBiB,KAvCL,SAAA,GAuCK,MAAqB,GAAA,KAAA,GAMvB,MAAA;AAQf;AAYA;AAYA;AACW,UAzEM,iBAAA,CAyEN;EACA;EACN,KAAA,EAzEI,SAyEJ;EAAgB;;;;EChDL;EA4CA,mBAAA,CAAA,EAAA,OAAqB;;;;AClCrC;AACW,UFxBM,iBAAA,CEwBN;EACA;EACR,IAAA,EAAA,MAAA;EAAgB;EAgBH,OAAA,EAAA,MAAA;EAOA;EAoBV,KAAA,CAAA,EAAA,MAAA,GAAA,SAgBJ;;;;;;EAhBwB,SAAA,EAAA,QAAA,GAAA,QAAA,GAAA,SAAA,GAAA,OAAA,GAAA,SAAA;EAAA;EAkBrB,QAAA,EAAA,OAAc;AAiBnB;;;;AAIG,UFxFc,qBAAA,CEwFd;EAAO;EA4CM,IAAA,EAAA,MAAA;EACD;EAEoB,WAAA,CAAA,EAAA,MAAA,GAAA,SAAA;EAAlB;EAAU,WAAA,EFjIZ,qBEiIY,EAAA;;WF/HhB;;;;;UAMM,cAAA;;WAEN;;;;iBAIM;;;;;UAMA,gBAAA;;;;SAIR;;;;;;;KAQG,mBAAA,aACD,qBACA,sBACN;;;AA7DL;AAoBA;AAcA;AAYiB,iBCjCD,kBAAA,CDqCP,OAAS,ECrC0B,UDqC1B,CAAA,ECrCuC,iBDqCvC,EAAA;AAQlB;;;AAGK,iBCJW,qBAAA,CDIX,OAAA,ECJ0C,UDI1C,EAAA,WAAA,EAAA,MAAA,CAAA,ECJ4E,cDI5E;;;;AEGJ;;;iBAzCe,kBAAA,UACL,qBACA,oBACR;;;;AA2CuB,iBA3BV,kBAAA,CAAA,CA2BU,EA3BY,SA2BZ,EAAA;AAAA;AAmC1B;;AAIkB,iBA3DF,WAAA,CAAA,CA2DE,EA3Da,SA2Db,GAAA,IAAA;;;;AA4ClB,cAnFM,oBAmF+B,EAnFX,CAAA,CAAA,SAmFW,CAAA;EACtB,KAAA,eAAA,UAAA,CAAA;IAEoB,IAAA,EAAA,MAAA;IAAlB,GAAA,EAAA,KAAA;IAAU,IAAA,EAAA,MAAA;;;;KApEtB,cAAA,GAAiB,CAAA,CAAE,aAAa;;;;;;;;;;;;;;;;iBAiBrB,uBAAA,cACD,kCAGZ,eAAe,sBAAsB;;;;;;;;;;;;;;;iBA4CxB,qBAAA,cACD;cAEE,kBAAkB"}