@h3ravel/console 11.0.0 → 11.0.1

package/dist/index.d.cts

@@ -1,4 +1,249 @@
-import { ServiceProvider } from '@h3ravel/core';
+import * as commander from 'commander';
+import { Argument, program } from 'commander';
+import { Application, ServiceProvider } from '@h3ravel/core';
+import { XGeneric } from '@h3ravel/support';
+
+declare class Kernel {
+    app: Application;
+    cwd: string;
+    output: {
+        success: (msg: any, exit?: boolean) => void;
+        info: (msg: any, exit?: boolean) => void;
+        error: (msg: string | string[] | (Error & {
+            detail?: string;
+        }), exit?: boolean) => void;
+        split: (name: string, value: string, status?: "success" | "info" | "error", exit?: boolean) => void;
+        quiet: () => never;
+    };
+    basePath: string;
+    modulePath: string;
+    consolePath: string;
+    modulePackage: XGeneric<{
+        version: string;
+    }>;
+    consolePackage: XGeneric<{
+        version: string;
+    }>;
+    constructor(app: Application, basePath?: string);
+    static init(app: Application): void;
+    private run;
+    ensureDirectoryExists(dir: string): Promise<void>;
+    private loadRequirements;
+}
+
+declare class Command {
+    protected app: Application;
+    protected kernel: Kernel;
+    constructor(app: Application, kernel: Kernel);
+    /**
+     * 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>): void;
+    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>;
+}
+
+declare class MakeCommand extends Command {
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected signature: string;
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected description: string;
+    handle(): Promise<void>;
+    /**
+     * Generate a new controller class.
+     */
+    protected makeController(): Promise<void>;
+    protected makeResource(): void;
+    /**
+     * Generate a new database migration class
+     */
+    protected makeMigration(): Promise<void>;
+    protected makeFactory(): void;
+    protected makeSeeder(): void;
+    /**
+     * Generate a new Arquebus model class
+     */
+    protected makeModel(): Promise<void>;
+    /**
+     * Ge the database migration file name
+     *
+     * @param table
+     * @param create
+     * @param type
+     * @returns
+     */
+    getMigrationStubName(table?: string, create?: boolean, type?: 'ts' | 'js'): string;
+}
+
+declare class MigrateCommand extends Command {
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected signature: string;
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected description: string;
+    /**
+     * Execute the console command.
+     */
+    handle(): Promise<void>;
+    /**
+     * Run all pending migrations.
+     */
+    protected migrateRun(): Promise<void>;
+    /**
+     * Drop all tables and re-run all migrations.
+     */
+    protected migrateFresh(): Promise<void>;
+    /**
+     * Create the migration repository.
+     */
+    protected migrateInstall(): Promise<void>;
+    /**
+     * Reset and re-run all migrations.
+     */
+    protected migrateRefresh(): Promise<void>;
+    /**
+     * Rollback all database migrations.
+     */
+    protected migrateReset(): Promise<void>;
+    /**
+     * Rollback the last database migration.
+     */
+    protected migrateRollback(): Promise<void>;
+    /**
+     * Show the status of each migration.
+     */
+    protected migrateStatus(): Promise<void>;
+    /**
+     * Publish any migration files from installed packages.
+     */
+    protected migratePublish(): Promise<void>;
+}
+
+declare class ServeCommand extends Command {
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected signature: string;
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected description: string;
+    handle(): Promise<void>;
+    protected serve(): Promise<void>;
+}
+
+type CommandOption = {
+    name: string;
+    required?: boolean;
+    multiple?: boolean;
+    defaultValue?: string | number | boolean | undefined | string[];
+    shared?: boolean;
+    description?: string;
+    /**
+     * 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[];
+};
+
+/**
+ * Musket is H3ravel's CLI tool
+ */
+declare class Musket {
+    private app;
+    private kernel;
+    private output;
+    private commands;
+    constructor(app: Application, kernel: Kernel);
+    build(): Promise<commander.Command>;
+    private loadBaseCommands;
+    private loadDiscoveredCommands;
+    addCommand(command: Command): void;
+    private initialize;
+    makeOption(opt: CommandOption, cmd: typeof program, parse?: boolean, parent?: any): void;
+    static parse(kernel: Kernel): Promise<commander.Command>;
+}
 
 /**
  * Handles CLI commands and tooling.
@@ -14,4 +259,63 @@ declare class ConsoleServiceProvider extends ServiceProvider {
     register(): void;
 }
 
-export { ConsoleServiceProvider };
+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;
+}
+
+declare class Utils {
+    /**
+     * Wraps text with chalk
+     *
+     * @param txt
+     * @param color
+     * @returns
+     */
+    static textFormat(txt: any, color: (txt: string) => string): string;
+    /**
+     * Ouput formater object
+     *
+     * @returns
+     */
+    static output(): {
+        success: (msg: any, exit?: boolean) => void;
+        info: (msg: any, exit?: boolean) => void;
+        error: (msg: string | string[] | (Error & {
+            detail?: string;
+        }), exit?: boolean) => void;
+        split: (name: string, value: string, status?: "success" | "info" | "error", exit?: boolean) => void;
+        quiet: () => never;
+    };
+    static findModulePkg(moduleId: string, cwd?: string): string | undefined;
+    static getMigrationPaths(cwd: string, migrator: any, defaultPath: string, path: string): Promise<any[]>;
+    static twoColumnDetail(name: string, value: string): void;
+    /**
+     * Check if file exists
+     *
+     * @param path
+     * @returns
+     */
+    static fileExists(path: string): Promise<boolean>;
+    static findUpConfig(cwd: string, name: string, extensions: string[]): string | void;
+}
+declare class TableGuesser {
+    static CREATE_PATTERNS: RegExp[];
+    static CHANGE_PATTERNS: RegExp[];
+    static guess(migration: string): (string | boolean)[];
+}
+
+export { Command, type CommandOption, ConsoleServiceProvider, Kernel, MakeCommand, MigrateCommand, Musket, type ParsedCommand, ServeCommand, Signature, TableGuesser, Utils };

package/dist/index.d.ts

@@ -1,4 +1,249 @@
-import { ServiceProvider } from '@h3ravel/core';
+import * as commander from 'commander';
+import { Argument, program } from 'commander';
+import { Application, ServiceProvider } from '@h3ravel/core';
+import { XGeneric } from '@h3ravel/support';
+
+declare class Kernel {
+    app: Application;
+    cwd: string;
+    output: {
+        success: (msg: any, exit?: boolean) => void;
+        info: (msg: any, exit?: boolean) => void;
+        error: (msg: string | string[] | (Error & {
+            detail?: string;
+        }), exit?: boolean) => void;
+        split: (name: string, value: string, status?: "success" | "info" | "error", exit?: boolean) => void;
+        quiet: () => never;
+    };
+    basePath: string;
+    modulePath: string;
+    consolePath: string;
+    modulePackage: XGeneric<{
+        version: string;
+    }>;
+    consolePackage: XGeneric<{
+        version: string;
+    }>;
+    constructor(app: Application, basePath?: string);
+    static init(app: Application): void;
+    private run;
+    ensureDirectoryExists(dir: string): Promise<void>;
+    private loadRequirements;
+}
+
+declare class Command {
+    protected app: Application;
+    protected kernel: Kernel;
+    constructor(app: Application, kernel: Kernel);
+    /**
+     * 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>): void;
+    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>;
+}
+
+declare class MakeCommand extends Command {
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected signature: string;
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected description: string;
+    handle(): Promise<void>;
+    /**
+     * Generate a new controller class.
+     */
+    protected makeController(): Promise<void>;
+    protected makeResource(): void;
+    /**
+     * Generate a new database migration class
+     */
+    protected makeMigration(): Promise<void>;
+    protected makeFactory(): void;
+    protected makeSeeder(): void;
+    /**
+     * Generate a new Arquebus model class
+     */
+    protected makeModel(): Promise<void>;
+    /**
+     * Ge the database migration file name
+     *
+     * @param table
+     * @param create
+     * @param type
+     * @returns
+     */
+    getMigrationStubName(table?: string, create?: boolean, type?: 'ts' | 'js'): string;
+}
+
+declare class MigrateCommand extends Command {
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected signature: string;
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected description: string;
+    /**
+     * Execute the console command.
+     */
+    handle(): Promise<void>;
+    /**
+     * Run all pending migrations.
+     */
+    protected migrateRun(): Promise<void>;
+    /**
+     * Drop all tables and re-run all migrations.
+     */
+    protected migrateFresh(): Promise<void>;
+    /**
+     * Create the migration repository.
+     */
+    protected migrateInstall(): Promise<void>;
+    /**
+     * Reset and re-run all migrations.
+     */
+    protected migrateRefresh(): Promise<void>;
+    /**
+     * Rollback all database migrations.
+     */
+    protected migrateReset(): Promise<void>;
+    /**
+     * Rollback the last database migration.
+     */
+    protected migrateRollback(): Promise<void>;
+    /**
+     * Show the status of each migration.
+     */
+    protected migrateStatus(): Promise<void>;
+    /**
+     * Publish any migration files from installed packages.
+     */
+    protected migratePublish(): Promise<void>;
+}
+
+declare class ServeCommand extends Command {
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected signature: string;
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected description: string;
+    handle(): Promise<void>;
+    protected serve(): Promise<void>;
+}
+
+type CommandOption = {
+    name: string;
+    required?: boolean;
+    multiple?: boolean;
+    defaultValue?: string | number | boolean | undefined | string[];
+    shared?: boolean;
+    description?: string;
+    /**
+     * 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[];
+};
+
+/**
+ * Musket is H3ravel's CLI tool
+ */
+declare class Musket {
+    private app;
+    private kernel;
+    private output;
+    private commands;
+    constructor(app: Application, kernel: Kernel);
+    build(): Promise<commander.Command>;
+    private loadBaseCommands;
+    private loadDiscoveredCommands;
+    addCommand(command: Command): void;
+    private initialize;
+    makeOption(opt: CommandOption, cmd: typeof program, parse?: boolean, parent?: any): void;
+    static parse(kernel: Kernel): Promise<commander.Command>;
+}
 
 /**
  * Handles CLI commands and tooling.
@@ -14,4 +259,63 @@ declare class ConsoleServiceProvider extends ServiceProvider {
     register(): void;
 }
 
-export { ConsoleServiceProvider };
+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;
+}
+
+declare class Utils {
+    /**
+     * Wraps text with chalk
+     *
+     * @param txt
+     * @param color
+     * @returns
+     */
+    static textFormat(txt: any, color: (txt: string) => string): string;
+    /**
+     * Ouput formater object
+     *
+     * @returns
+     */
+    static output(): {
+        success: (msg: any, exit?: boolean) => void;
+        info: (msg: any, exit?: boolean) => void;
+        error: (msg: string | string[] | (Error & {
+            detail?: string;
+        }), exit?: boolean) => void;
+        split: (name: string, value: string, status?: "success" | "info" | "error", exit?: boolean) => void;
+        quiet: () => never;
+    };
+    static findModulePkg(moduleId: string, cwd?: string): string | undefined;
+    static getMigrationPaths(cwd: string, migrator: any, defaultPath: string, path: string): Promise<any[]>;
+    static twoColumnDetail(name: string, value: string): void;
+    /**
+     * Check if file exists
+     *
+     * @param path
+     * @returns
+     */
+    static fileExists(path: string): Promise<boolean>;
+    static findUpConfig(cwd: string, name: string, extensions: string[]): string | void;
+}
+declare class TableGuesser {
+    static CREATE_PATTERNS: RegExp[];
+    static CHANGE_PATTERNS: RegExp[];
+    static guess(migration: string): (string | boolean)[];
+}
+
+export { Command, type CommandOption, ConsoleServiceProvider, Kernel, MakeCommand, MigrateCommand, Musket, type ParsedCommand, ServeCommand, Signature, TableGuesser, Utils };

package/dist/index.js

@@ -1,17 +1,45 @@
-var __defProp = Object.defineProperty;
-var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-
-// src/Providers/ConsoleServiceProvider.ts
-import { ServiceProvider } from "@h3ravel/core";
-var ConsoleServiceProvider = class extends ServiceProvider {
-  static {
-    __name(this, "ConsoleServiceProvider");
-  }
-  static priority = 992;
-  register() {
-  }
-};
-export {
+import "./chunk-NADN2PHB.js";
+import "./chunk-XSL373TG.js";
+import "./chunk-KMIFCLXG.js";
+import {
   ConsoleServiceProvider
+} from "./chunk-IGEFNODG.js";
+import {
+  Kernel
+} from "./chunk-URLTFJET.js";
+import {
+  Musket
+} from "./chunk-TN5SV7LF.js";
+import {
+  MigrateCommand
+} from "./chunk-FOSDCKCR.js";
+import {
+  ServeCommand
+} from "./chunk-SP4JKAUC.js";
+import {
+  Signature
+} from "./chunk-3FVPHQCH.js";
+import "./chunk-UCOXL3OM.js";
+import {
+  MakeCommand
+} from "./chunk-PMV4TMFS.js";
+import {
+  TableGuesser,
+  Utils
+} from "./chunk-POF4JGTX.js";
+import {
+  Command
+} from "./chunk-O45AB4MX.js";
+import "./chunk-SHUYVCID.js";
+export {
+  Command,
+  ConsoleServiceProvider,
+  Kernel,
+  MakeCommand,
+  MigrateCommand,
+  Musket,
+  ServeCommand,
+  Signature,
+  TableGuesser,
+  Utils
 };
-//# sourceMappingURL=index.js.map

package/dist/run.cjs

@@ -0,0 +1 @@
+"use strict";

package/dist/run.js

@@ -0,0 +1 @@
+import "./chunk-UCOXL3OM.js";