@adonisjs/core 6.19.0 → 7.0.0-next.1

package/build/commands/eject.d.ts

@@ -1,12 +1,37 @@
-import { BaseCommand } from '../modules/ace/main.js';
+import { BaseCommand } from '../modules/ace/main.ts';
 /**
- * The eject command is used to eject templates to the user
- * application codebase for customizing them
+ * Command to eject scaffolding stubs from packages to your application root.
+ * This allows you to customize templates used by make commands and other
+ * code generation features by copying them to your local application.
+ *
+ * @example
+ * ```
+ * ace eject make/controller
+ * ace eject make/controller --pkg=@adonisjs/lucid
+ * ace eject stubs/
+ * ```
  */
 export default class Eject extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName: string;
+    /**
+     * The command description
+     */
     static description: string;
+    /**
+     * Path to the stubs directory or a single stub file to eject
+     */
     stubPath: string;
+    /**
+     * Package name to search for stubs. Defaults to @adonisjs/core
+     */
     pkg: string;
+    /**
+     * Execute the command to eject stubs from the specified package.
+     * Copies the stubs to the application root and logs success messages
+     * for each ejected file.
+     */
     run(): Promise<void>;
 }

package/build/commands/eject.js

@@ -12,22 +12,41 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
-import { slash } from '@poppinss/utils';
-import { args, BaseCommand, flags } from '../modules/ace/main.js';
+import { args, BaseCommand, flags } from "../modules/ace/main.js";
+import stringHelpers from "../src/helpers/string.js";
 /**
- * The eject command is used to eject templates to the user
- * application codebase for customizing them
+ * Command to eject scaffolding stubs from packages to your application root.
+ * This allows you to customize templates used by make commands and other
+ * code generation features by copying them to your local application.
+ *
+ * @example
+ * ```
+ * ace eject make/controller
+ * ace eject make/controller --pkg=@adonisjs/lucid
+ * ace eject stubs/
+ * ```
  */
 export default class Eject extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName = 'eject';
+    /**
+     * The command description
+     */
     static description = 'Eject scaffolding stubs to your application root';
+    /**
+     * Execute the command to eject stubs from the specified package.
+     * Copies the stubs to the application root and logs success messages
+     * for each ejected file.
+     */
     async run() {
         const stubs = await this.app.stubs.create();
         const copied = await stubs.copy(this.stubPath, {
             pkg: this.pkg,
         });
         copied.forEach((stubPath) => {
-            this.logger.success(`eject ${slash(this.app.relativePath(stubPath))}`);
+            this.logger.success(`eject ${stringHelpers.toUnixSlash(this.app.relativePath(stubPath))}`);
         });
     }
 }

package/build/commands/env/add.d.ts

@@ -1,20 +1,57 @@
-import { CommandOptions } from '../../types/ace.js';
-import { BaseCommand } from '../../modules/ace/main.js';
+import { type CommandOptions } from '../../types/ace.ts';
+import { BaseCommand } from '../../modules/ace/main.ts';
 declare const ALLOWED_TYPES: readonly ["string", "boolean", "number", "enum"];
 type AllowedTypes = (typeof ALLOWED_TYPES)[number];
 /**
- * The env:add command is used to add a new environment variable to the
- * `.env`, `.env.example` and `start/env.ts` files.
+ * Command to add a new environment variable to the application.
+ * Updates .env, .env.example, and start/env.ts files with the new variable,
+ * including appropriate validation schema based on the variable type.
+ *
+ * @example
+ * ```
+ * ace env:add
+ * ace env:add DATABASE_URL postgres://localhost:5432/mydb
+ * ace env:add API_KEY secret --type=string
+ * ace env:add PORT 3333 --type=number
+ * ace env:add DEBUG true --type=boolean
+ * ace env:add LOG_LEVEL info --type=enum --enum-values=debug,info,warn,error
+ * ```
  */
 export default class EnvAdd extends BaseCommand {
     #private;
+    /**
+     * The command name
+     */
     static commandName: string;
+    /**
+     * The command description
+     */
     static description: string;
+    /**
+     * Command options configuration.
+     * Allows unknown flags to be passed through.
+     */
     static options: CommandOptions;
+    /**
+     * Environment variable name (will be converted to SCREAMING_SNAKE_CASE)
+     */
     name: string;
+    /**
+     * Environment variable value
+     */
     value: string;
+    /**
+     * Data type of the environment variable (string, boolean, number, enum)
+     */
     type: AllowedTypes;
+    /**
+     * Allowed values for enum type variables
+     */
     enumValues: string[];
+    /**
+     * Execute the command to add a new environment variable.
+     * Prompts for missing values, validates inputs, and updates all relevant files.
+     */
     run(): Promise<void>;
 }
 export {};

package/build/commands/env/add.js

@@ -12,25 +12,52 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
-import stringHelpers from '../../src/helpers/string.js';
-import { args, BaseCommand, flags } from '../../modules/ace/main.js';
+import stringHelpers from "../../src/helpers/string.js";
+import { args, BaseCommand, flags } from "../../modules/ace/main.js";
 const ALLOWED_TYPES = ['string', 'boolean', 'number', 'enum'];
 /**
- * The env:add command is used to add a new environment variable to the
- * `.env`, `.env.example` and `start/env.ts` files.
+ * Command to add a new environment variable to the application.
+ * Updates .env, .env.example, and start/env.ts files with the new variable,
+ * including appropriate validation schema based on the variable type.
+ *
+ * @example
+ * ```
+ * ace env:add
+ * ace env:add DATABASE_URL postgres://localhost:5432/mydb
+ * ace env:add API_KEY secret --type=string
+ * ace env:add PORT 3333 --type=number
+ * ace env:add DEBUG true --type=boolean
+ * ace env:add LOG_LEVEL info --type=enum --enum-values=debug,info,warn,error
+ * ```
  */
 export default class EnvAdd extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName = 'env:add';
+    /**
+     * The command description
+     */
     static description = 'Add a new environment variable';
+    /**
+     * Command options configuration.
+     * Allows unknown flags to be passed through.
+     */
     static options = {
         allowUnknownFlags: true,
     };
     /**
-     * Validate the type flag passed by the user
+     * Validate that the provided type is one of the allowed types.
+     *
+     * @returns True if the type is valid, false otherwise
      */
     #isTypeFlagValid() {
         return ALLOWED_TYPES.includes(this.type);
     }
+    /**
+     * Execute the command to add a new environment variable.
+     * Prompts for missing values, validates inputs, and updates all relevant files.
+     */
     async run() {
         /**
          * Prompt for missing name

package/build/commands/generate_key.d.ts

@@ -1,12 +1,31 @@
-import { BaseCommand } from '../modules/ace/main.js';
+import { BaseCommand } from '../modules/ace/main.ts';
 /**
  * The generate key command is used to generate the app key
  * and write it inside the .env file.
+ *
+ * @example
+ * ```
+ * ace generate:key
+ * ace generate:key --show
+ * ace generate:key --force
+ * ```
  */
 export default class GenerateKey extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName: string;
+    /**
+     * The command description
+     */
     static description: string;
+    /**
+     * Display the key on the terminal, instead of writing it to .env file
+     */
     show: boolean;
+    /**
+     * Force update .env file in production environment
+     */
     force: boolean;
     run(): Promise<void>;
 }

package/build/commands/generate_key.js

@@ -14,13 +14,26 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 };
 import string from '@poppinss/utils/string';
 import { EnvEditor } from '@adonisjs/env/editor';
-import { BaseCommand, flags } from '../modules/ace/main.js';
+import { BaseCommand, flags } from "../modules/ace/main.js";
 /**
  * The generate key command is used to generate the app key
  * and write it inside the .env file.
+ *
+ * @example
+ * ```
+ * ace generate:key
+ * ace generate:key --show
+ * ace generate:key --force
+ * ```
  */
 export default class GenerateKey extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName = 'generate:key';
+    /**
+     * The command description
+     */
     static description = 'Generate a cryptographically secure random application key';
     async run() {
         let writeToFile = process.env.NODE_ENV !== 'production';

package/build/commands/inspect_rcfile.d.ts

@@ -1,9 +1,27 @@
-import { BaseCommand } from '../modules/ace/main.js';
+import { BaseCommand } from '../modules/ace/main.ts';
 /**
- * Prints the RcFile file contents to the terminal
+ * Command to inspect and display the AdonisJS RC file contents with default values.
+ * The RC file contains configuration for providers, preloads, commands, and other
+ * application settings. This command formats and displays the contents in a readable JSON format.
+ *
+ * @example
+ * ```
+ * ace inspect:rcfile
+ * ```
  */
 export default class InspectRCFile extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName: string;
+    /**
+     * The command description
+     */
     static description: string;
+    /**
+     * Execute the command to display RC file contents.
+     * Transforms provider, preload, and command entries to display their file paths
+     * as strings and formats the output as readable JSON.
+     */
     run(): Promise<void>;
 }

package/build/commands/inspect_rcfile.js

@@ -6,13 +6,31 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-import { BaseCommand } from '../modules/ace/main.js';
+import { BaseCommand } from "../modules/ace/main.js";
 /**
- * Prints the RcFile file contents to the terminal
+ * Command to inspect and display the AdonisJS RC file contents with default values.
+ * The RC file contains configuration for providers, preloads, commands, and other
+ * application settings. This command formats and displays the contents in a readable JSON format.
+ *
+ * @example
+ * ```
+ * ace inspect:rcfile
+ * ```
  */
 export default class InspectRCFile extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName = 'inspect:rcfile';
+    /**
+     * The command description
+     */
     static description = 'Inspect the RC file with its default values';
+    /**
+     * Execute the command to display RC file contents.
+     * Transforms provider, preload, and command entries to display their file paths
+     * as strings and formats the output as readable JSON.
+     */
     async run() {
         const { raw, providers, preloads, commands, ...rest } = this.app.rcFile;
         this.logger.log(JSON.stringify({

package/build/commands/list/routes.d.ts

@@ -1,36 +1,58 @@
-import type { CommandOptions } from '../../types/ace.js';
-import { BaseCommand } from '../../modules/ace/main.js';
+import type { CommandOptions } from '../../types/ace.ts';
+import { BaseCommand } from '../../modules/ace/main.ts';
 /**
- * The list routes command is used to view the list of registered routes
+ * Command to display a list of all registered routes in the application.
+ * Supports filtering by keywords, middleware, and output formatting options.
+ * Routes can be displayed as a formatted list, table, or JSON.
+ *
+ * @example
+ * ```
+ * ace list:routes
+ * ace list:routes user
+ * ace list:routes --middleware=auth
+ * ace list:routes --ignore-middleware=guest
+ * ace list:routes --json
+ * ace list:routes --table
+ * ```
  */
 export default class ListRoutes extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName: string;
+    /**
+     * The command description
+     */
     static description: string;
     /**
-     * Making sure to start the application so that the routes are
-     * imported
+     * Command options configuration.
+     * Requires the application to be started so routes are loaded.
      */
     static options: CommandOptions;
     /**
-     * The match filter is used to find route by name, pattern and controller name that
-     * includes the match keyword
+     * Keyword to match against route names, patterns, and controller names
      */
     match: string;
     /**
-     * The middleware flag searches for the routes using all the mentioned middleware
+     * Filter routes that include all specified middleware names
      */
     middleware: string[];
     /**
-     * The ignoreMiddleware flag searches for the routes not using all the mentioned middleware
+     * Filter routes that do not include all specified middleware names
      */
     ignoreMiddleware: string[];
     /**
-     * The json flag is used to view list of routes as a JSON string.
+     * Output routes as JSON format
      */
     json: boolean;
     /**
-     * The table flag is used to view list of routes as a classic CLI table
+     * Output routes as a CLI table format
      */
     table: boolean;
+    /**
+     * Execute the command to list application routes.
+     * Creates a formatter with the specified filters and outputs routes
+     * in the requested format (JSON, table, or formatted list).
+     */
     run(): Promise<void>;
 }

package/build/commands/list/routes.js

@@ -12,21 +12,44 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
-import { args, BaseCommand, flags } from '../../modules/ace/main.js';
-import { RoutesListFormatter } from '../../src/cli_formatters/routes_list.js';
+import { args, BaseCommand, flags } from "../../modules/ace/main.js";
+import { RoutesListFormatter } from "../../src/cli_formatters/routes_list.js";
 /**
- * The list routes command is used to view the list of registered routes
+ * Command to display a list of all registered routes in the application.
+ * Supports filtering by keywords, middleware, and output formatting options.
+ * Routes can be displayed as a formatted list, table, or JSON.
+ *
+ * @example
+ * ```
+ * ace list:routes
+ * ace list:routes user
+ * ace list:routes --middleware=auth
+ * ace list:routes --ignore-middleware=guest
+ * ace list:routes --json
+ * ace list:routes --table
+ * ```
  */
 export default class ListRoutes extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName = 'list:routes';
+    /**
+     * The command description
+     */
     static description = 'List application routes. This command will boot the application in the console environment';
     /**
-     * Making sure to start the application so that the routes are
-     * imported
+     * Command options configuration.
+     * Requires the application to be started so routes are loaded.
      */
     static options = {
         startApp: true,
     };
+    /**
+     * Execute the command to list application routes.
+     * Creates a formatter with the specified filters and outputs routes
+     * in the requested format (JSON, table, or formatted list).
+     */
     async run() {
         const router = await this.app.container.make('router');
         const formatter = new RoutesListFormatter(router, this.ui, {}, {

package/build/commands/make/command.d.ts

@@ -1,14 +1,37 @@
-import { BaseCommand } from '../../modules/ace/main.js';
+import { BaseCommand } from '../../modules/ace/main.ts';
 /**
- * Make a new ace command
+ * Command to create a new Ace command class.
+ * Ace commands are CLI commands that can be executed via the `ace` binary,
+ * allowing you to create custom functionality for your application's command line interface.
+ *
+ * @example
+ * ```
+ * ace make:command SendEmails
+ * ace make:command ProcessPayments
+ * ace make:command GenerateReports
+ * ace make:command CleanupFiles
+ * ```
  */
 export default class MakeCommand extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName: string;
+    /**
+     * The command description
+     */
     static description: string;
+    /**
+     * Name of the command class to create
+     */
     name: string;
     /**
-     * The stub to use for generating the command class
+     * The stub template file to use for generating the command class
      */
     protected stubPath: string;
+    /**
+     * Execute the command to create a new Ace command class.
+     * Generates the command file with proper CLI command structure.
+     */
     run(): Promise<void>;
 }

package/build/commands/make/command.js

@@ -12,19 +12,39 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
-import { stubsRoot } from '../../stubs/main.js';
-import { args } from '../../modules/ace/main.js';
-import { BaseCommand } from '../../modules/ace/main.js';
+import { stubsRoot } from "../../stubs/main.js";
+import { args } from "../../modules/ace/main.js";
+import { BaseCommand } from "../../modules/ace/main.js";
 /**
- * Make a new ace command
+ * Command to create a new Ace command class.
+ * Ace commands are CLI commands that can be executed via the `ace` binary,
+ * allowing you to create custom functionality for your application's command line interface.
+ *
+ * @example
+ * ```
+ * ace make:command SendEmails
+ * ace make:command ProcessPayments
+ * ace make:command GenerateReports
+ * ace make:command CleanupFiles
+ * ```
  */
 export default class MakeCommand extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName = 'make:command';
+    /**
+     * The command description
+     */
     static description = 'Create a new ace command class';
     /**
-     * The stub to use for generating the command class
+     * The stub template file to use for generating the command class
      */
     stubPath = 'make/command/main.stub';
+    /**
+     * Execute the command to create a new Ace command class.
+     * Generates the command file with proper CLI command structure.
+     */
     async run() {
         const codemods = await this.createCodemods();
         await codemods.makeUsingStub(stubsRoot, this.stubPath, {

package/build/commands/make/controller.d.ts

@@ -1,16 +1,49 @@
-import { BaseCommand } from '../../modules/ace/main.js';
-import { CommandOptions } from '../../types/ace.js';
+import { BaseCommand } from '../../modules/ace/main.ts';
+import { type CommandOptions } from '../../types/ace.ts';
 /**
  * The make controller command to create an HTTP controller
+ *
+ * @example
+ * ```
+ * ace make:controller User
+ * ace make:controller User store update
+ * ace make:controller User --resource
+ * ace make:controller User --api
+ * ace make:controller User --singular
+ * ```
  */
 export default class MakeController extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName: string;
+    /**
+     * The command description
+     */
     static description: string;
+    /**
+     * Command options configuration
+     */
     static options: CommandOptions;
+    /**
+     * The name of the controller
+     */
     name: string;
+    /**
+     * Create controller with custom method names
+     */
     actions?: string[];
+    /**
+     * Generate controller in singular form
+     */
     singular: boolean;
+    /**
+     * Generate resourceful controller with methods to perform CRUD actions on a resource
+     */
     resource: boolean;
+    /**
+     * Generate resourceful controller without the "edit" and the "create" methods
+     */
     api: boolean;
     /**
      * The stub to use for generating the controller

package/build/commands/make/controller.js

@@ -13,14 +13,32 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
 import string from '@poppinss/utils/string';
-import { stubsRoot } from '../../stubs/main.js';
-import { args, flags, BaseCommand } from '../../modules/ace/main.js';
+import { stubsRoot } from "../../stubs/main.js";
+import { args, flags, BaseCommand } from "../../modules/ace/main.js";
 /**
  * The make controller command to create an HTTP controller
+ *
+ * @example
+ * ```
+ * ace make:controller User
+ * ace make:controller User store update
+ * ace make:controller User --resource
+ * ace make:controller User --api
+ * ace make:controller User --singular
+ * ```
  */
 export default class MakeController extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName = 'make:controller';
+    /**
+     * The command description
+     */
     static description = 'Create a new HTTP controller class';
+    /**
+     * Command options configuration
+     */
     static options = {
         allowUnknownFlags: true,
     };