@adonisjs/core 7.0.0-next.0 → 7.0.0-next.2

package/build/commands/add.d.ts

@@ -4,16 +4,48 @@ import { type SupportedPackageManager } from '@adonisjs/assembler/types';
 /**
  * The install command is used to `npm install` and `node ace configure` a new package
  * in one go.
+ *
+ * @example
+ * ```
+ * ace add @adonisjs/lucid
+ * ace add @adonisjs/session --dev
+ * ace add vinejs --force
+ * ace add edge --package-manager=pnpm
+ * ```
  */
 export default class Add extends BaseCommand {
     #private;
+    /**
+     * The command name
+     */
     static commandName: string;
+    /**
+     * The command description
+     */
     static description: string;
+    /**
+     * Command options configuration
+     */
     static options: CommandOptions;
+    /**
+     * Package name to install and configure
+     */
     name: string;
+    /**
+     * Display logs in verbose mode
+     */
     verbose?: boolean;
+    /**
+     * Define the package manager you want to use
+     */
     packageManager?: SupportedPackageManager;
+    /**
+     * Should we install the package as a dev dependency
+     */
     dev?: boolean;
+    /**
+     * Forcefully overwrite existing files
+     */
     force?: boolean;
     /**
      * Run method is invoked by ace automatically

package/build/commands/add.js

@@ -16,10 +16,27 @@ import { args, BaseCommand, flags } from "../modules/ace/main.js";
 /**
  * The install command is used to `npm install` and `node ace configure` a new package
  * in one go.
+ *
+ * @example
+ * ```
+ * ace add @adonisjs/lucid
+ * ace add @adonisjs/session --dev
+ * ace add vinejs --force
+ * ace add edge --package-manager=pnpm
+ * ```
  */
 export default class Add extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName = 'add';
+    /**
+     * The command description
+     */
     static description = 'Install and configure a package';
+    /**
+     * Command options configuration
+     */
     static options = {
         allowUnknownFlags: true,
     };

package/build/commands/build.d.ts

@@ -2,13 +2,35 @@ import { BaseCommand } from '../modules/ace/main.ts';
 /**
  * Create the production build by compiling TypeScript source and the
  * frontend assets
+ *
+ * @example
+ * ```
+ * ace build
+ * ace build --ignore-ts-errors
+ * ace build --package-manager=pnpm
+ * ```
  */
 export default class Build extends BaseCommand {
     #private;
+    /**
+     * The command name
+     */
     static commandName: string;
+    /**
+     * The command description
+     */
     static description: string;
+    /**
+     * Help text for the command
+     */
     static help: string[];
+    /**
+     * Ignore TypeScript errors and continue with the build process
+     */
     ignoreTsErrors?: boolean;
+    /**
+     * Define the package manager to copy the appropriate lock file
+     */
     packageManager?: 'npm' | 'pnpm' | 'yarn' | 'yarn@berry' | 'bun';
     /**
      * Build application

package/build/commands/build.js

@@ -17,10 +17,26 @@ import { importAssembler, importTypeScript } from "../src/utils.js";
 /**
  * Create the production build by compiling TypeScript source and the
  * frontend assets
+ *
+ * @example
+ * ```
+ * ace build
+ * ace build --ignore-ts-errors
+ * ace build --package-manager=pnpm
+ * ```
  */
 export default class Build extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName = 'build';
+    /**
+     * The command description
+     */
     static description = 'Build application for production by compiling frontend assets and TypeScript source to JavaScript';
+    /**
+     * Help text for the command
+     */
     static help = [
         'Create the production build using the following command.',
         '```',
@@ -35,6 +51,8 @@ export default class Build extends BaseCommand {
     ];
     /**
      * Log a development dependency is missing
+     *
+     * @param dependency - The name of the missing dependency
      */
     #logMissingDevelopmentDependency(dependency) {
         this.logger.error([

package/build/commands/commands.json

@@ -1 +1 @@
-{"commands":[{"commandName":"add","description":"Install and configure a package","help":"","namespace":null,"aliases":[],"flags":[{"name":"verbose","flagName":"verbose","required":false,"type":"boolean","description":"Display logs in verbose mode"},{"name":"packageManager","flagName":"package-manager","required":false,"type":"string","description":"Define the package manager you want to use"},{"name":"dev","flagName":"dev","required":false,"type":"boolean","description":"Should we install the package as a dev dependency","alias":"D"},{"name":"force","flagName":"force","required":false,"type":"boolean","description":"Forcefully overwrite existing files"}],"args":[{"name":"name","argumentName":"name","required":true,"description":"Package name","type":"string"}],"options":{"allowUnknownFlags":true},"filePath":"add.js"},{"commandName":"build","description":"Build application for production by compiling frontend assets and TypeScript source to JavaScript","help":["Create the production build using the following command.","```","{{ binaryName }} build","```","","The assets bundler dev server runs automatically after detecting vite config or webpack config files","You may pass vite CLI args using the --assets-args command line flag.","```","{{ binaryName }} build --assets-args=\"--debug --base=/public\"","```"],"namespace":null,"aliases":[],"flags":[{"name":"ignoreTsErrors","flagName":"ignore-ts-errors","required":false,"type":"boolean","description":"Ignore TypeScript errors and continue with the build process"},{"name":"packageManager","flagName":"package-manager","required":false,"type":"string","description":"Define the package manager to copy the appropriate lock file"}],"args":[],"options":{},"filePath":"build.js"},{"commandName":"configure","description":"Configure a package after it has been installed","help":"","namespace":null,"aliases":[],"flags":[{"name":"verbose","flagName":"verbose","required":false,"type":"boolean","description":"Display logs in verbose mode","alias":"v"},{"name":"force","flagName":"force","required":false,"type":"boolean","description":"Forcefully overwrite existing files","alias":"f"}],"args":[{"name":"name","argumentName":"name","required":true,"description":"Package name","type":"string"}],"options":{"allowUnknownFlags":true},"filePath":"configure.js"},{"commandName":"eject","description":"Eject scaffolding stubs to your application root","help":"","namespace":null,"aliases":[],"flags":[{"name":"pkg","flagName":"pkg","required":false,"type":"string","description":"Mention package name for searching stubs","default":"@adonisjs/core"}],"args":[{"name":"stubPath","argumentName":"stub-path","required":true,"description":"Path to the stubs directory or a single stub file","type":"string"}],"options":{},"filePath":"eject.js"},{"commandName":"env:add","description":"Add a new environment variable","help":"","namespace":"env","aliases":[],"flags":[{"name":"type","flagName":"type","required":false,"type":"string","description":"Type of the variable"},{"name":"enumValues","flagName":"enum-values","required":false,"type":"array","description":"Allowed values for the enum type in a comma-separated list","default":[""]}],"args":[{"name":"name","argumentName":"name","required":false,"description":"Variable name. Will be converted to screaming snake case","type":"string"},{"name":"value","argumentName":"value","required":false,"description":"Variable value","type":"string"}],"options":{"allowUnknownFlags":true},"filePath":"env/add.js"},{"commandName":"generate:key","description":"Generate a cryptographically secure random application key","help":"","namespace":"generate","aliases":[],"flags":[{"name":"show","flagName":"show","required":false,"type":"boolean","description":"Display the key on the terminal, instead of writing it to .env file"},{"name":"force","flagName":"force","required":false,"type":"boolean","description":"Force update .env file in production environment"}],"args":[],"options":{},"filePath":"generate_key.js"},{"commandName":"inspect:rcfile","description":"Inspect the RC file with its default values","help":"","namespace":"inspect","aliases":[],"flags":[],"args":[],"options":{},"filePath":"inspect_rcfile.js"},{"commandName":"list:routes","description":"List application routes. This command will boot the application in the console environment","help":"","namespace":"list","aliases":[],"flags":[{"name":"middleware","flagName":"middleware","required":false,"type":"array","description":"View routes that includes all the mentioned middleware names. Use * to see routes that are using one or more middleware"},{"name":"ignoreMiddleware","flagName":"ignore-middleware","required":false,"type":"array","description":"View routes that does not include all the mentioned middleware names. Use * to see routes that are using zero middleware"},{"name":"json","flagName":"json","required":false,"type":"boolean","description":"Get routes list as a JSON string"},{"name":"table","flagName":"table","required":false,"type":"boolean","description":"View list of routes as a table"}],"args":[{"name":"match","argumentName":"match","required":false,"description":"Find routes matching the given keyword. Route name, pattern and controller name will be searched against the keyword","type":"string"}],"options":{"startApp":true},"filePath":"list/routes.js"},{"commandName":"make:command","description":"Create a new ace command class","help":"","namespace":"make","aliases":[],"flags":[],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the command","type":"string"}],"options":{},"filePath":"make/command.js"},{"commandName":"make:controller","description":"Create a new HTTP controller class","help":"","namespace":"make","aliases":[],"flags":[{"name":"singular","flagName":"singular","required":false,"type":"boolean","description":"Generate controller in singular form","alias":"s"},{"name":"resource","flagName":"resource","required":false,"type":"boolean","description":"Generate resourceful controller with methods to perform CRUD actions on a resource","alias":"r"},{"name":"api","flagName":"api","required":false,"type":"boolean","description":"Generate resourceful controller without the \"edit\" and the \"create\" methods","alias":"a"}],"args":[{"name":"name","argumentName":"name","required":true,"description":"The name of the controller","type":"string"},{"name":"actions","argumentName":"actions","required":false,"description":"Create controller with custom method names","type":"spread"}],"options":{"allowUnknownFlags":true},"filePath":"make/controller.js"},{"commandName":"make:event","description":"Create a new event class","help":"","namespace":"make","aliases":[],"flags":[],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the event","type":"string"}],"options":{"allowUnknownFlags":true},"filePath":"make/event.js"},{"commandName":"make:exception","description":"Create a new custom exception class","help":"","namespace":"make","aliases":[],"flags":[],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the exception","type":"string"}],"options":{"allowUnknownFlags":true},"filePath":"make/exception.js"},{"commandName":"make:listener","description":"Create a new event listener class","help":"","namespace":"make","aliases":[],"flags":[{"name":"event","flagName":"event","required":false,"type":"string","description":"Generate an event class alongside the listener","alias":"e"}],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the event listener","type":"string"}],"options":{"allowUnknownFlags":true},"filePath":"make/listener.js"},{"commandName":"make:middleware","description":"Create a new middleware class for HTTP requests","help":"","namespace":"make","aliases":[],"flags":[{"name":"stack","flagName":"stack","required":false,"type":"string","description":"The stack in which to register the middleware","alias":"s"}],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the middleware","type":"string"}],"options":{"allowUnknownFlags":true},"filePath":"make/middleware.js"},{"commandName":"make:preload","description":"Create a new preload file inside the start directory","help":"","namespace":"make","aliases":[],"flags":[{"name":"register","flagName":"register","required":false,"type":"boolean","description":"Auto register the preload file inside the .adonisrc.ts file","showNegatedVariantInHelp":true,"alias":"r"},{"name":"environments","flagName":"environments","required":false,"type":"array","description":"Define the preload file's environment. Accepted values are \"web,console,test,repl\"","alias":"e"}],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the preload file","type":"string"}],"options":{},"filePath":"make/preload.js"},{"commandName":"make:provider","description":"Create a new service provider class","help":"","namespace":"make","aliases":[],"flags":[{"name":"register","flagName":"register","required":false,"type":"boolean","description":"Auto register the provider inside the .adonisrc.ts file","showNegatedVariantInHelp":true,"alias":"r"},{"name":"environments","flagName":"environments","required":false,"type":"array","description":"Define the provider environment. Accepted values are \"web,console,test,repl\"","alias":"e"}],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the provider","type":"string"}],"options":{},"filePath":"make/provider.js"},{"commandName":"make:service","description":"Create a new service class","help":"","namespace":"make","aliases":[],"flags":[],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the service","type":"string"}],"options":{"allowUnknownFlags":true},"filePath":"make/service.js"},{"commandName":"make:test","description":"Create a new Japa test file","help":"","namespace":"make","aliases":[],"flags":[{"name":"suite","flagName":"suite","required":false,"type":"string","description":"The suite for which to create the test file","alias":"s"}],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the test file","type":"string"}],"options":{},"filePath":"make/test.js"},{"commandName":"make:validator","description":"Create a new file to define VineJS validators","help":"","namespace":"make","aliases":[],"flags":[{"name":"resource","flagName":"resource","required":false,"type":"boolean","description":"Create a file with pre-defined validators for create and update actions"}],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the validator file","type":"string"}],"options":{"allowUnknownFlags":true},"filePath":"make/validator.js"},{"commandName":"make:view","description":"Create a new Edge.js template file","help":"","namespace":"make","aliases":[],"flags":[],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the template","type":"string"}],"options":{},"filePath":"make/view.js"},{"commandName":"repl","description":"Start a new REPL session","help":"","namespace":null,"aliases":[],"flags":[],"args":[],"options":{"startApp":true,"staysAlive":true},"filePath":"repl.js"},{"commandName":"serve","description":"Start the development HTTP server along with the file watcher to perform restarts on file change","help":["Start the development server with file watcher using the following command.","```","{{ binaryName }} serve --watch","```","","You can also start the server with HMR support using the following command.","```","{{ binaryName }} serve --hmr","```","","The assets bundler dev server runs automatically after detecting vite config or webpack config files","You may pass vite CLI args using the --assets-args command line flag.","```","{{ binaryName }} serve --assets-args=\"--debug --base=/public\"","```"],"namespace":null,"aliases":[],"flags":[{"name":"hmr","flagName":"hmr","required":false,"type":"boolean","description":"Start the server with HMR support"},{"name":"watch","flagName":"watch","required":false,"type":"boolean","description":"Watch filesystem and restart the HTTP server on file change","alias":"w"},{"name":"poll","flagName":"poll","required":false,"type":"boolean","description":"Use polling to detect filesystem changes","alias":"p"},{"name":"clear","flagName":"clear","required":false,"type":"boolean","description":"Clear the terminal for new logs after file change","showNegatedVariantInHelp":true,"default":true}],"args":[],"options":{"staysAlive":true},"filePath":"serve.js"},{"commandName":"test","description":"Run tests along with the file watcher to re-run tests on file change","help":"","namespace":null,"aliases":[],"flags":[{"name":"files","flagName":"files","required":false,"type":"array","description":"Filter tests by the filename"},{"name":"tags","flagName":"tags","required":false,"type":"array","description":"Filter tests by tags"},{"name":"groups","flagName":"groups","required":false,"type":"array","description":"Filter tests by parent group title"},{"name":"tests","flagName":"tests","required":false,"type":"array","description":"Filter tests by test title"},{"name":"reporters","flagName":"reporters","required":false,"type":"array","description":"Activate one or more test reporters"},{"name":"watch","flagName":"watch","required":false,"type":"boolean","description":"Watch filesystem and re-run tests on file change"},{"name":"poll","flagName":"poll","required":false,"type":"boolean","description":"Use polling to detect filesystem changes"},{"name":"timeout","flagName":"timeout","required":false,"type":"number","description":"Define default timeout for all tests"},{"name":"retries","flagName":"retries","required":false,"type":"number","description":"Define default retries for all tests"},{"name":"failed","flagName":"failed","required":false,"type":"boolean","description":"Execute tests failed during the last run"},{"name":"clear","flagName":"clear","required":false,"type":"boolean","description":"Clear the terminal for new logs after file change","showNegatedVariantInHelp":true,"default":true}],"args":[{"name":"suites","argumentName":"suites","required":false,"description":"Mention suite names to run tests for selected suites","type":"spread"}],"options":{"allowUnknownFlags":true,"staysAlive":true},"filePath":"test.js"}],"version":1}
+{"commands":[{"commandName":"add","description":"Install and configure a package","help":"","namespace":null,"aliases":[],"flags":[{"name":"verbose","flagName":"verbose","required":false,"type":"boolean","description":"Display logs in verbose mode"},{"name":"packageManager","flagName":"package-manager","required":false,"type":"string","description":"Define the package manager you want to use"},{"name":"dev","flagName":"dev","required":false,"type":"boolean","description":"Should we install the package as a dev dependency","alias":"D"},{"name":"force","flagName":"force","required":false,"type":"boolean","description":"Forcefully overwrite existing files"}],"args":[{"name":"name","argumentName":"name","required":true,"description":"Package name","type":"string"}],"options":{"allowUnknownFlags":true},"filePath":"add.js"},{"commandName":"build","description":"Build application for production by compiling frontend assets and TypeScript source to JavaScript","help":["Create the production build using the following command.","```","{{ binaryName }} build","```","","The assets bundler dev server runs automatically after detecting vite config or webpack config files","You may pass vite CLI args using the --assets-args command line flag.","```","{{ binaryName }} build --assets-args=\"--debug --base=/public\"","```"],"namespace":null,"aliases":[],"flags":[{"name":"ignoreTsErrors","flagName":"ignore-ts-errors","required":false,"type":"boolean","description":"Ignore TypeScript errors and continue with the build process"},{"name":"packageManager","flagName":"package-manager","required":false,"type":"string","description":"Define the package manager to copy the appropriate lock file"}],"args":[],"options":{},"filePath":"build.js"},{"commandName":"configure","description":"Configure a package after it has been installed","help":"","namespace":null,"aliases":[],"flags":[{"name":"verbose","flagName":"verbose","required":false,"type":"boolean","description":"Display logs in verbose mode","alias":"v"},{"name":"force","flagName":"force","required":false,"type":"boolean","description":"Forcefully overwrite existing files","alias":"f"}],"args":[{"name":"name","argumentName":"name","required":true,"description":"Package name","type":"string"}],"options":{"allowUnknownFlags":true},"filePath":"configure.js"},{"commandName":"eject","description":"Eject scaffolding stubs to your application root","help":"","namespace":null,"aliases":[],"flags":[{"name":"pkg","flagName":"pkg","required":false,"type":"string","description":"Mention package name for searching stubs","default":"@adonisjs/core"}],"args":[{"name":"stubPath","argumentName":"stub-path","required":true,"description":"Path to the stubs directory or a single stub file","type":"string"}],"options":{},"filePath":"eject.js"},{"commandName":"env:add","description":"Add a new environment variable","help":"","namespace":"env","aliases":[],"flags":[{"name":"type","flagName":"type","required":false,"type":"string","description":"Type of the variable"},{"name":"enumValues","flagName":"enum-values","required":false,"type":"array","description":"Allowed values for the enum type in a comma-separated list","default":[""]}],"args":[{"name":"name","argumentName":"name","required":false,"description":"Variable name. Will be converted to screaming snake case","type":"string"},{"name":"value","argumentName":"value","required":false,"description":"Variable value","type":"string"}],"options":{"allowUnknownFlags":true},"filePath":"env/add.js"},{"commandName":"generate:key","description":"Generate a cryptographically secure random application key","help":"","namespace":"generate","aliases":[],"flags":[{"name":"show","flagName":"show","required":false,"type":"boolean","description":"Display the key on the terminal, instead of writing it to .env file"},{"name":"force","flagName":"force","required":false,"type":"boolean","description":"Force update .env file in production environment"}],"args":[],"options":{},"filePath":"generate_key.js"},{"commandName":"inspect:rcfile","description":"Inspect the RC file with its default values","help":"","namespace":"inspect","aliases":[],"flags":[],"args":[],"options":{},"filePath":"inspect_rcfile.js"},{"commandName":"list:routes","description":"List application routes. This command will boot the application in the console environment","help":"","namespace":"list","aliases":[],"flags":[{"name":"middleware","flagName":"middleware","required":false,"type":"array","description":"View routes that includes all the mentioned middleware names. Use * to see routes that are using one or more middleware"},{"name":"ignoreMiddleware","flagName":"ignore-middleware","required":false,"type":"array","description":"View routes that does not include all the mentioned middleware names. Use * to see routes that are using zero middleware"},{"name":"json","flagName":"json","required":false,"type":"boolean","description":"Get routes list as a JSON string"},{"name":"table","flagName":"table","required":false,"type":"boolean","description":"View list of routes as a table"}],"args":[{"name":"match","argumentName":"match","required":false,"description":"Find routes matching the given keyword. Route name, pattern and controller name will be searched against the keyword","type":"string"}],"options":{"startApp":true},"filePath":"list/routes.js"},{"commandName":"make:command","description":"Create a new ace command class","help":"","namespace":"make","aliases":[],"flags":[],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the command","type":"string"}],"options":{},"filePath":"make/command.js"},{"commandName":"make:controller","description":"Create a new HTTP controller class","help":"","namespace":"make","aliases":[],"flags":[{"name":"singular","flagName":"singular","required":false,"type":"boolean","description":"Generate controller in singular form","alias":"s"},{"name":"resource","flagName":"resource","required":false,"type":"boolean","description":"Generate resourceful controller with methods to perform CRUD actions on a resource","alias":"r"},{"name":"api","flagName":"api","required":false,"type":"boolean","description":"Generate resourceful controller without the \"edit\" and the \"create\" methods","alias":"a"}],"args":[{"name":"name","argumentName":"name","required":true,"description":"The name of the controller","type":"string"},{"name":"actions","argumentName":"actions","required":false,"description":"Create controller with custom method names","type":"spread"}],"options":{"allowUnknownFlags":true},"filePath":"make/controller.js"},{"commandName":"make:event","description":"Create a new event class","help":"","namespace":"make","aliases":[],"flags":[],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the event","type":"string"}],"options":{"allowUnknownFlags":true},"filePath":"make/event.js"},{"commandName":"make:exception","description":"Create a new custom exception class","help":"","namespace":"make","aliases":[],"flags":[],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the exception","type":"string"}],"options":{"allowUnknownFlags":true},"filePath":"make/exception.js"},{"commandName":"make:listener","description":"Create a new event listener class","help":"","namespace":"make","aliases":[],"flags":[{"name":"event","flagName":"event","required":false,"type":"string","description":"Generate an event class alongside the listener","alias":"e"}],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the event listener","type":"string"}],"options":{"allowUnknownFlags":true},"filePath":"make/listener.js"},{"commandName":"make:middleware","description":"Create a new middleware class for HTTP requests","help":"","namespace":"make","aliases":[],"flags":[{"name":"stack","flagName":"stack","required":false,"type":"string","description":"The stack in which to register the middleware","alias":"s"}],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the middleware","type":"string"}],"options":{"allowUnknownFlags":true},"filePath":"make/middleware.js"},{"commandName":"make:preload","description":"Create a new preload file inside the start directory","help":"","namespace":"make","aliases":[],"flags":[{"name":"register","flagName":"register","required":false,"type":"boolean","description":"Auto register the preload file inside the .adonisrc.ts file","showNegatedVariantInHelp":true,"alias":"r"},{"name":"environments","flagName":"environments","required":false,"type":"array","description":"Define the preload file's environment. Accepted values are \"web,console,test,repl\"","alias":"e"}],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the preload file","type":"string"}],"options":{},"filePath":"make/preload.js"},{"commandName":"make:provider","description":"Create a new service provider class","help":"","namespace":"make","aliases":[],"flags":[{"name":"register","flagName":"register","required":false,"type":"boolean","description":"Auto register the provider inside the .adonisrc.ts file","showNegatedVariantInHelp":true,"alias":"r"},{"name":"environments","flagName":"environments","required":false,"type":"array","description":"Define the provider environment. Accepted values are \"web,console,test,repl\"","alias":"e"}],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the provider","type":"string"}],"options":{},"filePath":"make/provider.js"},{"commandName":"make:service","description":"Create a new service class","help":"","namespace":"make","aliases":[],"flags":[],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the service","type":"string"}],"options":{"allowUnknownFlags":true},"filePath":"make/service.js"},{"commandName":"make:test","description":"Create a new Japa test file","help":"","namespace":"make","aliases":[],"flags":[{"name":"suite","flagName":"suite","required":false,"type":"string","description":"The suite for which to create the test file","alias":"s"}],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the test file","type":"string"}],"options":{},"filePath":"make/test.js"},{"commandName":"make:transformer","description":"Create a new transformer class","help":"","namespace":"make","aliases":[],"flags":[],"args":[{"name":"name","argumentName":"name","required":true,"description":"Entity name for which to generate the transformer","type":"string"}],"options":{"allowUnknownFlags":true},"filePath":"make/transformer.js"},{"commandName":"make:validator","description":"Create a new file to define VineJS validators","help":"","namespace":"make","aliases":[],"flags":[{"name":"resource","flagName":"resource","required":false,"type":"boolean","description":"Create a file with pre-defined validators for create and update actions"}],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the validator file","type":"string"}],"options":{"allowUnknownFlags":true},"filePath":"make/validator.js"},{"commandName":"make:view","description":"Create a new Edge.js template file","help":"","namespace":"make","aliases":[],"flags":[],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the template","type":"string"}],"options":{},"filePath":"make/view.js"},{"commandName":"repl","description":"Start a new REPL session","help":"","namespace":null,"aliases":[],"flags":[],"args":[],"options":{"startApp":true,"staysAlive":true},"filePath":"repl.js"},{"commandName":"serve","description":"Start the development HTTP server along with the file watcher to perform restarts on file change","help":["Start the development server with file watcher using the following command.","```","{{ binaryName }} serve --watch","```","","You can also start the server with HMR support using the following command.","```","{{ binaryName }} serve --hmr","```","","The assets bundler dev server runs automatically after detecting vite config or webpack config files","You may pass vite CLI args using the --assets-args command line flag.","```","{{ binaryName }} serve --assets-args=\"--debug --base=/public\"","```"],"namespace":null,"aliases":[],"flags":[{"name":"hmr","flagName":"hmr","required":false,"type":"boolean","description":"Start the server with HMR support"},{"name":"watch","flagName":"watch","required":false,"type":"boolean","description":"Watch filesystem and restart the HTTP server on file change","alias":"w"},{"name":"poll","flagName":"poll","required":false,"type":"boolean","description":"Use polling to detect filesystem changes","alias":"p"},{"name":"clear","flagName":"clear","required":false,"type":"boolean","description":"Clear the terminal for new logs after file change","showNegatedVariantInHelp":true,"default":true}],"args":[],"options":{"staysAlive":true},"filePath":"serve.js"},{"commandName":"test","description":"Run tests along with the file watcher to re-run tests on file change","help":"","namespace":null,"aliases":[],"flags":[{"name":"files","flagName":"files","required":false,"type":"array","description":"Filter tests by the filename"},{"name":"tags","flagName":"tags","required":false,"type":"array","description":"Filter tests by tags"},{"name":"groups","flagName":"groups","required":false,"type":"array","description":"Filter tests by parent group title"},{"name":"tests","flagName":"tests","required":false,"type":"array","description":"Filter tests by test title"},{"name":"reporters","flagName":"reporters","required":false,"type":"array","description":"Activate one or more test reporters"},{"name":"watch","flagName":"watch","required":false,"type":"boolean","description":"Watch filesystem and re-run tests on file change"},{"name":"poll","flagName":"poll","required":false,"type":"boolean","description":"Use polling to detect filesystem changes"},{"name":"timeout","flagName":"timeout","required":false,"type":"number","description":"Define default timeout for all tests"},{"name":"retries","flagName":"retries","required":false,"type":"number","description":"Define default retries for all tests"},{"name":"failed","flagName":"failed","required":false,"type":"boolean","description":"Execute tests failed during the last run"},{"name":"clear","flagName":"clear","required":false,"type":"boolean","description":"Clear the terminal for new logs after file change","showNegatedVariantInHelp":true,"default":true}],"args":[{"name":"suites","argumentName":"suites","required":false,"description":"Mention suite names to run tests for selected suites","type":"spread"}],"options":{"allowUnknownFlags":true,"staysAlive":true},"filePath":"test.js"}],"version":1}

package/build/commands/configure.d.ts

@@ -1,21 +1,42 @@
 import type { CommandOptions } from '../types/ace.ts';
 import { BaseCommand } from '../modules/ace/main.ts';
 /**
- * The configure command is used to configure packages after installation
+ * Command to configure packages after installation by running their configuration hooks.
+ * Supports built-in configurations for VineJS, Edge, and health checks, or can execute
+ * custom configure functions exported by packages.
+ *
+ * @example
+ * ```
+ * ace configure @adonisjs/lucid
+ * ace configure vinejs
+ * ace configure edge
+ * ace configure health_checks
+ * ace configure @adonisjs/auth --force --verbose
+ * ```
  */
 export default class Configure extends BaseCommand {
     #private;
+    /**
+     * The command name
+     */
     static commandName: string;
+    /**
+     * The command description
+     */
     static description: string;
+    /**
+     * Command options configuration.
+     * Allows unknown flags to be passed to package configure functions.
+     */
     static options: CommandOptions;
     /**
-     * Exposing all flags from the protected property "parsed"
+     * Expose all flags from the protected property "parsed" for access by package configure functions
      */
     get parsedFlags(): {
         [argName: string]: any;
     };
     /**
-     * Exposing all args from the protected property "parsed"
+     * Expose all arguments from the protected property "parsed" for access by package configure functions
      */
     get parsedArgs(): (string | number)[];
     /**
@@ -23,24 +44,26 @@ export default class Configure extends BaseCommand {
      */
     name: string;
     /**
-     * Turn on verbose mode for packages installation
+     * Enable verbose logging during package installation and configuration
      */
     verbose?: boolean;
     /**
-     * Forcefully overwrite existing files.
+     * Forcefully overwrite existing files during configuration
      */
     force?: boolean;
     /**
-     * The root of the stubs directory. The value is defined after we import
-     * the package
+     * The root directory path of the package's stubs.
+     * Set automatically when the package exports a stubsRoot property.
      */
     stubsRoot: string;
     /**
-     * Creates codemods as per configure command options
+     * Create a codemods instance configured with command options.
+     * Sets overwrite and verbose flags based on command arguments.
      */
     createCodemods(): Promise<import("../modules/ace/codemods.ts").Codemods>;
     /**
-     * Run method is invoked by ace automatically
+     * Execute the configure command. Handles built-in configurations for VineJS, Edge,
+     * and health checks, or imports and executes the configure function from the specified package.
      */
     run(): Promise<void>;
 }

package/build/commands/configure.js

@@ -16,28 +16,53 @@ import { RuntimeException } from '@poppinss/utils/exception';
 import { stubsRoot } from "../stubs/main.js";
 import { args, BaseCommand, flags } from "../modules/ace/main.js";
 /**
- * The configure command is used to configure packages after installation
+ * Command to configure packages after installation by running their configuration hooks.
+ * Supports built-in configurations for VineJS, Edge, and health checks, or can execute
+ * custom configure functions exported by packages.
+ *
+ * @example
+ * ```
+ * ace configure @adonisjs/lucid
+ * ace configure vinejs
+ * ace configure edge
+ * ace configure health_checks
+ * ace configure @adonisjs/auth --force --verbose
+ * ```
  */
 export default class Configure extends BaseCommand {
+    /**
+     * The command name
+     */
     static commandName = 'configure';
+    /**
+     * The command description
+     */
     static description = 'Configure a package after it has been installed';
+    /**
+     * Command options configuration.
+     * Allows unknown flags to be passed to package configure functions.
+     */
     static options = {
         allowUnknownFlags: true,
     };
     /**
-     * Exposing all flags from the protected property "parsed"
+     * Expose all flags from the protected property "parsed" for access by package configure functions
      */
     get parsedFlags() {
         return this.parsed.flags;
     }
     /**
-     * Exposing all args from the protected property "parsed"
+     * Expose all arguments from the protected property "parsed" for access by package configure functions
      */
     get parsedArgs() {
         return this.parsed._;
     }
     /**
-     * Returns the package main exports
+     * Import and return the main exports of a package.
+     * Returns null if the package is not found, rethrows other errors.
+     *
+     * @param packageName - The name of the package to import
+     * @returns The package exports or null if not found
      */
     async #getPackageSource(packageName) {
         try {
@@ -53,7 +78,7 @@ export default class Configure extends BaseCommand {
         }
     }
     /**
-     * Registers VineJS provider
+     * Configure VineJS validation library by registering its provider in the RC file
      */
     async #configureVineJS() {
         const codemods = await this.createCodemods();
@@ -62,7 +87,7 @@ export default class Configure extends BaseCommand {
         });
     }
     /**
-     * Registers Edge provider
+     * Configure Edge template engine by registering its provider and adding view meta files
      */
     async #configureEdge() {
         const codemods = await this.createCodemods();
@@ -72,7 +97,7 @@ export default class Configure extends BaseCommand {
         });
     }
     /**
-     * Configure health checks
+     * Configure health checks feature by generating the main health file and controller
      */
     async #configureHealthChecks() {
         const codemods = await this.createCodemods();
@@ -86,7 +111,8 @@ export default class Configure extends BaseCommand {
         });
     }
     /**
-     * Creates codemods as per configure command options
+     * Create a codemods instance configured with command options.
+     * Sets overwrite and verbose flags based on command arguments.
      */
     async createCodemods() {
         const codemods = await super.createCodemods();
@@ -95,7 +121,8 @@ export default class Configure extends BaseCommand {
         return codemods;
     }
     /**
-     * Run method is invoked by ace automatically
+     * Execute the configure command. Handles built-in configurations for VineJS, Edge,
+     * and health checks, or imports and executes the configure function from the specified package.
      */
     async run() {
         if (this.name === 'vinejs') {

package/build/commands/eject.d.ts

@@ -1,12 +1,37 @@
 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

@@ -15,12 +15,31 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 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, {

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

@@ -3,18 +3,55 @@ 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

@@ -16,21 +16,48 @@ 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

@@ -2,11 +2,30 @@ 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>;
 }