@h3ravel/musket 0.1.0 → 0.1.1

package/dist/index.d.cts

@@ -0,0 +1,308 @@
+import * as commander0 from "commander";
+import { Argument, Command as Command$1 } from "commander";
+import { XGeneric } from "@h3ravel/support";
+import { Options } from "tsdown";
+
+//#region src/Contracts/ICommand.d.ts
+type CommandOption = {
+  name: string;
+  shared?: boolean;
+  required?: boolean;
+  multiple?: boolean;
+  placeholder?: string;
+  description?: string;
+  defaultValue?: string | number | boolean | undefined | string[];
+  choices?: string[];
+  argParser?: (...args: []) => any;
+  /**
+   * for options like --Q|queue
+   */
+  flags?: string[];
+  /**
+   * true if it's a flag option
+   */
+  isFlag?: boolean;
+  /**
+   * true if name begins with '#' or '^'
+   */
+  isHidden?: boolean;
+  /**
+   * for nested options
+   */
+  nestedOptions?: CommandOption[];
+};
+type ParsedCommand = {
+  commandClass: Command;
+  baseCommand: string;
+  description?: string;
+  /**
+   * true if baseCommand begins with '#' or '^'
+   */
+  isHidden?: boolean;
+  /**
+   * true if baseCommand ends with ':'
+   */
+  isNamespaceCommand: boolean;
+  /**
+   * for colon-ended commands
+   */
+  subCommands?: CommandOption[];
+  /**
+   * for normal commands
+   */
+  options?: CommandOption[];
+};
+interface InitConfig {
+  /**
+   * ASCII Art style logo
+   */
+  logo?: string;
+  /**
+   * The name of the CLI app we're building
+   *
+   * @default musket
+   */
+  cliName?: string;
+  /**
+   * Don't parse the command, usefull for testing or manual control
+   */
+  skipParsing?: boolean;
+  /**
+   * A callback function that should resolve the handle method of every command
+   *
+   * @param cmd
+   * @param met
+   * @returns
+   */
+  resolver?: <X>(cmd: X, met: string) => Promise<X>;
+  /**
+   * Packages that should show up up when the `-V` flag is passed
+   */
+  packages?: string[];
+  /**
+   * If set to true, information about musket CLI like name and
+   * version info will not be unexpectedly shown in console
+   */
+  hideMusketInfo?: boolean;
+  /**
+   * Commands that should be autoloaded by default
+   */
+  baseCommands?: typeof Command[];
+  /**
+   * Paths where musket can search and auto discover commands
+   *
+   *
+   * @example 'Console/Commands/*.js'
+   * @example 'dist/app/Console/Commands/*.js'
+   * @example ['Console/Commands/*.js', 'src/app/Commands/*.js']
+   */
+  discoveryPaths?: string | string[];
+}
+//#endregion
+//#region src/Core/Kernel.d.ts
+declare class Kernel {
+  app: Application;
+  cwd: string;
+  output: "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function";
+  modules: XGeneric<{
+    version: string;
+    name: string;
+  }>[];
+  basePath: string;
+  packages: string[];
+  private config;
+  constructor(app: Application);
+  ensureDirectoryExists(dir: string): Promise<void>;
+  static init(app: Application, config?: InitConfig): Promise<commander0.Command>;
+  private run;
+  private loadRequirements;
+}
+//#endregion
+//#region src/Core/Command.d.ts
+declare class Command {
+  protected app: Application;
+  protected kernel: Kernel;
+  constructor(app: Application, kernel: Kernel);
+  /**
+   * The underlying commander instance.
+   *
+   * @var Command
+   */
+  program: Command$1;
+  /**
+   * The name and signature of the console command.
+   *
+   * @var string
+   */
+  protected signature: string;
+  /**
+   * A dictionary of signatures or what not.
+   *
+   * @var object
+   */
+  protected dictionary: Record<string, any>;
+  /**
+   * The console command description.
+   *
+   * @var string
+   */
+  protected description?: string;
+  /**
+   * The console command input.
+   *
+   * @var object
+   */
+  private input;
+  /**
+   * Execute the console command.
+   */
+  handle(..._args: any[]): Promise<void>;
+  setApplication(app: Application): void;
+  setInput(options: XGeneric, args: string[], regArgs: readonly Argument[], dictionary: Record<string, any>, program: Command$1): this;
+  setOption(key: string, value: unknown): this;
+  setProgram(program: Command$1): this;
+  getSignature(): string;
+  getDescription(): string | undefined;
+  option(key: string, def?: any): any;
+  options(key?: string): any;
+  argument(key: string, def?: any): any;
+  arguments(): Record<string, any>;
+  loadBaseFlags(): void;
+  /**
+   * Check if the command is quiet
+   *
+   * @returns
+   */
+  isQuiet(): any;
+  /**
+   * Check if the command is silent
+   *
+   * @returns
+   */
+  isSilent(): any;
+  /**
+   * Check if the command is non interactive
+   *
+   * @returns
+   */
+  isNonInteractive(): boolean;
+  /**
+   * Get the verbosity of the command
+   *
+   * @returns
+   */
+  getVerbosity(): number;
+  /**
+   * Log an info message
+   */
+  info(message: string): this;
+  /**
+   * Log a warning message
+   */
+  warn(message: string): this;
+  /**
+   * Log a line message
+   */
+  line(message: string): this;
+  /**
+   * Log a new line
+   */
+  newLine(count?: number): this;
+  /**
+   * Log a success message
+   */
+  success(message: string): this;
+  /**
+   * Log an error message
+   */
+  error(message: string): this;
+  /**
+   * Log an error message and terminate execution of the command
+   * return an exit code of 1
+   *
+   * This method is not chainable
+   */
+  fail(message: string): void;
+  /**
+   * Log a debug message
+   */
+  debug(message: string | string[]): this;
+}
+//#endregion
+//#region src/Musket.d.ts
+declare class Musket {
+  private app;
+  private kernel;
+  private baseCommands;
+  private resolver?;
+  private tsDownConfig;
+  /**
+   * The name of the CLI app we're building
+   *
+   * @default musket
+   */
+  cliName: string;
+  private config;
+  private commands;
+  constructor(app: Application, kernel: Kernel, baseCommands?: Command[], resolver?: (<X>(cmd: X, met: string) => Promise<X>) | undefined, tsDownConfig?: Options);
+  build(): Promise<Command$1>;
+  private loadBaseCommands;
+  /**
+   * Provide the configuration to initialize the CLI with
+   *
+   * @param config
+   * @returns
+   */
+  configure(config: InitConfig): this;
+  /**
+   * Set the paths where the cli can search and auto discover commands
+   *
+   * @param paths
+   *
+   * @example instance.discoverCommandsFrom('Console/Commands/*.js')
+   * @example instance.discoverCommandsFrom(['Console/Commands/*.js', 'App/Commands/*.js'])
+   *
+   * @returns the current cli intance
+   */
+  discoverCommandsFrom(paths: string | string[]): this;
+  private loadDiscoveredCommands;
+  addCommand(command: Command): void;
+  private initialize;
+  rebuild(name: string): Promise<void>;
+  private makeOption;
+  private handle;
+  static parse(kernel: Kernel, config?: InitConfig): Promise<Command$1>;
+}
+//#endregion
+//#region src/Contracts/Application.d.ts
+declare class Application {
+  /**
+   * The current musket CLI Instance
+   */
+  musket?: Musket;
+  /**
+   * Registered commands will be preloaded
+   */
+  registeredCommands?: typeof Command[];
+}
+//#endregion
+//#region src/Signature.d.ts
+declare class Signature {
+  /**
+   * Helper to parse options inside a block of text
+   *
+   * @param block
+   * @returns
+   */
+  static parseOptions(block: string): CommandOption[];
+  /**
+   * Helper to parse a command's signature
+   *
+   * @param signature
+   * @param commandClass
+   * @returns
+   */
+  static parseSignature(signature: string, commandClass: Command): ParsedCommand;
+}
+//#endregion
+export { Application, Command, CommandOption, InitConfig, Kernel, Musket, ParsedCommand, Signature };

package/dist/index.d.ts

@@ -0,0 +1,308 @@
+import * as commander0 from "commander";
+import { Argument, Command as Command$1 } from "commander";
+import { Options } from "tsdown";
+import { XGeneric } from "@h3ravel/support";
+
+//#region src/Contracts/ICommand.d.ts
+type CommandOption = {
+  name: string;
+  shared?: boolean;
+  required?: boolean;
+  multiple?: boolean;
+  placeholder?: string;
+  description?: string;
+  defaultValue?: string | number | boolean | undefined | string[];
+  choices?: string[];
+  argParser?: (...args: []) => any;
+  /**
+   * for options like --Q|queue
+   */
+  flags?: string[];
+  /**
+   * true if it's a flag option
+   */
+  isFlag?: boolean;
+  /**
+   * true if name begins with '#' or '^'
+   */
+  isHidden?: boolean;
+  /**
+   * for nested options
+   */
+  nestedOptions?: CommandOption[];
+};
+type ParsedCommand = {
+  commandClass: Command;
+  baseCommand: string;
+  description?: string;
+  /**
+   * true if baseCommand begins with '#' or '^'
+   */
+  isHidden?: boolean;
+  /**
+   * true if baseCommand ends with ':'
+   */
+  isNamespaceCommand: boolean;
+  /**
+   * for colon-ended commands
+   */
+  subCommands?: CommandOption[];
+  /**
+   * for normal commands
+   */
+  options?: CommandOption[];
+};
+interface InitConfig {
+  /**
+   * ASCII Art style logo
+   */
+  logo?: string;
+  /**
+   * The name of the CLI app we're building
+   *
+   * @default musket
+   */
+  cliName?: string;
+  /**
+   * Don't parse the command, usefull for testing or manual control
+   */
+  skipParsing?: boolean;
+  /**
+   * A callback function that should resolve the handle method of every command
+   *
+   * @param cmd
+   * @param met
+   * @returns
+   */
+  resolver?: <X>(cmd: X, met: string) => Promise<X>;
+  /**
+   * Packages that should show up up when the `-V` flag is passed
+   */
+  packages?: string[];
+  /**
+   * If set to true, information about musket CLI like name and
+   * version info will not be unexpectedly shown in console
+   */
+  hideMusketInfo?: boolean;
+  /**
+   * Commands that should be autoloaded by default
+   */
+  baseCommands?: typeof Command[];
+  /**
+   * Paths where musket can search and auto discover commands
+   *
+   *
+   * @example 'Console/Commands/*.js'
+   * @example 'dist/app/Console/Commands/*.js'
+   * @example ['Console/Commands/*.js', 'src/app/Commands/*.js']
+   */
+  discoveryPaths?: string | string[];
+}
+//#endregion
+//#region src/Core/Kernel.d.ts
+declare class Kernel {
+  app: Application;
+  cwd: string;
+  output: "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function";
+  modules: XGeneric<{
+    version: string;
+    name: string;
+  }>[];
+  basePath: string;
+  packages: string[];
+  private config;
+  constructor(app: Application);
+  ensureDirectoryExists(dir: string): Promise<void>;
+  static init(app: Application, config?: InitConfig): Promise<commander0.Command>;
+  private run;
+  private loadRequirements;
+}
+//#endregion
+//#region src/Core/Command.d.ts
+declare class Command {
+  protected app: Application;
+  protected kernel: Kernel;
+  constructor(app: Application, kernel: Kernel);
+  /**
+   * The underlying commander instance.
+   *
+   * @var Command
+   */
+  program: Command$1;
+  /**
+   * The name and signature of the console command.
+   *
+   * @var string
+   */
+  protected signature: string;
+  /**
+   * A dictionary of signatures or what not.
+   *
+   * @var object
+   */
+  protected dictionary: Record<string, any>;
+  /**
+   * The console command description.
+   *
+   * @var string
+   */
+  protected description?: string;
+  /**
+   * The console command input.
+   *
+   * @var object
+   */
+  private input;
+  /**
+   * Execute the console command.
+   */
+  handle(..._args: any[]): Promise<void>;
+  setApplication(app: Application): void;
+  setInput(options: XGeneric, args: string[], regArgs: readonly Argument[], dictionary: Record<string, any>, program: Command$1): this;
+  setOption(key: string, value: unknown): this;
+  setProgram(program: Command$1): this;
+  getSignature(): string;
+  getDescription(): string | undefined;
+  option(key: string, def?: any): any;
+  options(key?: string): any;
+  argument(key: string, def?: any): any;
+  arguments(): Record<string, any>;
+  loadBaseFlags(): void;
+  /**
+   * Check if the command is quiet
+   *
+   * @returns
+   */
+  isQuiet(): any;
+  /**
+   * Check if the command is silent
+   *
+   * @returns
+   */
+  isSilent(): any;
+  /**
+   * Check if the command is non interactive
+   *
+   * @returns
+   */
+  isNonInteractive(): boolean;
+  /**
+   * Get the verbosity of the command
+   *
+   * @returns
+   */
+  getVerbosity(): number;
+  /**
+   * Log an info message
+   */
+  info(message: string): this;
+  /**
+   * Log a warning message
+   */
+  warn(message: string): this;
+  /**
+   * Log a line message
+   */
+  line(message: string): this;
+  /**
+   * Log a new line
+   */
+  newLine(count?: number): this;
+  /**
+   * Log a success message
+   */
+  success(message: string): this;
+  /**
+   * Log an error message
+   */
+  error(message: string): this;
+  /**
+   * Log an error message and terminate execution of the command
+   * return an exit code of 1
+   *
+   * This method is not chainable
+   */
+  fail(message: string): void;
+  /**
+   * Log a debug message
+   */
+  debug(message: string | string[]): this;
+}
+//#endregion
+//#region src/Musket.d.ts
+declare class Musket {
+  private app;
+  private kernel;
+  private baseCommands;
+  private resolver?;
+  private tsDownConfig;
+  /**
+   * The name of the CLI app we're building
+   *
+   * @default musket
+   */
+  cliName: string;
+  private config;
+  private commands;
+  constructor(app: Application, kernel: Kernel, baseCommands?: Command[], resolver?: (<X>(cmd: X, met: string) => Promise<X>) | undefined, tsDownConfig?: Options);
+  build(): Promise<Command$1>;
+  private loadBaseCommands;
+  /**
+   * Provide the configuration to initialize the CLI with
+   *
+   * @param config
+   * @returns
+   */
+  configure(config: InitConfig): this;
+  /**
+   * Set the paths where the cli can search and auto discover commands
+   *
+   * @param paths
+   *
+   * @example instance.discoverCommandsFrom('Console/Commands/*.js')
+   * @example instance.discoverCommandsFrom(['Console/Commands/*.js', 'App/Commands/*.js'])
+   *
+   * @returns the current cli intance
+   */
+  discoverCommandsFrom(paths: string | string[]): this;
+  private loadDiscoveredCommands;
+  addCommand(command: Command): void;
+  private initialize;
+  rebuild(name: string): Promise<void>;
+  private makeOption;
+  private handle;
+  static parse(kernel: Kernel, config?: InitConfig): Promise<Command$1>;
+}
+//#endregion
+//#region src/Contracts/Application.d.ts
+declare class Application {
+  /**
+   * The current musket CLI Instance
+   */
+  musket?: Musket;
+  /**
+   * Registered commands will be preloaded
+   */
+  registeredCommands?: typeof Command[];
+}
+//#endregion
+//#region src/Signature.d.ts
+declare class Signature {
+  /**
+   * Helper to parse options inside a block of text
+   *
+   * @param block
+   * @returns
+   */
+  static parseOptions(block: string): CommandOption[];
+  /**
+   * Helper to parse a command's signature
+   *
+   * @param signature
+   * @param commandClass
+   * @returns
+   */
+  static parseSignature(signature: string, commandClass: Command): ParsedCommand;
+}
+//#endregion
+export { Application, Command, CommandOption, InitConfig, Kernel, Musket, ParsedCommand, Signature };