@adonisjs/core 6.1.5-2 → 6.1.5-21

package/build/commands/build.d.ts

@@ -1,11 +1,21 @@
 import { BaseCommand } from '../modules/ace/main.js';
+/**
+ * Serve command is used to run the AdonisJS HTTP server during development. The
+ * command under the hood runs the "bin/server.ts" file and watches for file
+ * system changes
+ */
 export default class Build extends BaseCommand {
     #private;
     static commandName: string;
     static description: string;
+    static help: string[];
     watch?: boolean;
     ignoreTsErrors?: boolean;
     packageManager?: 'npm' | 'pnpm' | 'yarn';
     assets?: boolean;
+    assetsArgs?: string[];
+    /**
+     * Build application
+     */
     run(): Promise<void>;
 }

package/build/commands/build.js

@@ -1,26 +1,70 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
     var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
     if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
     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;
 };
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
 import { BaseCommand, flags } from '../modules/ace/main.js';
 import { detectAssetsBundler, importAssembler, importTypeScript } from '../src/internal_helpers.js';
+/**
+ * Serve command is used to run the AdonisJS HTTP server during development. The
+ * command under the hood runs the "bin/server.ts" file and watches for file
+ * system changes
+ */
 export default class Build extends BaseCommand {
     static commandName = 'build';
     static description = 'Build application for production by compiling frontend assets and TypeScript source to JavaScript';
+    static 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"',
+        '```',
+    ];
+    /**
+     * Log a development dependency is missing
+     */
     #logMissingDevelopmentDependency(dependency) {
         this.logger.error([
             `Cannot find package "${dependency}"`,
             '',
-            `The "${dependency}" package is a development dependency and therefore you should use the serve command during development only.`,
+            `The "${dependency}" package is a development dependency and therefore you should use the build command with development dependencies installed.`,
             '',
             'If you are using the build command inside a CI or with a deployment platform, make sure the NODE_ENV is set to "development"',
         ].join('\n'));
     }
+    /**
+     * Returns the assets bundler config
+     */
+    async #getAssetsBundlerConfig() {
+        const assetsBundler = await detectAssetsBundler(this.app);
+        return assetsBundler
+            ? {
+                serve: this.assets === false ? false : true,
+                driver: assetsBundler.name,
+                cmd: assetsBundler.build.command,
+                args: (assetsBundler.build.args || []).concat(this.assetsArgs || []),
+            }
+            : {
+                serve: false,
+            };
+    }
+    /**
+     * Build application
+     */
     async run() {
         const assembler = await importAssembler(this.app);
         if (!assembler) {
@@ -34,20 +78,18 @@ export default class Build extends BaseCommand {
             this.exitCode = 1;
             return;
         }
-        const assetsBundler = await detectAssetsBundler(this.app);
         const bundler = new assembler.Bundler(this.app.appRoot, ts, {
-            assets: assetsBundler
-                ? {
-                    serve: this.assets === false ? false : true,
-                    driver: assetsBundler.name,
-                    cmd: assetsBundler.buildCommand,
-                }
-                : {
-                    serve: false,
-                },
+            assets: await this.#getAssetsBundlerConfig(),
             metaFiles: this.app.rcFile.metaFiles,
         });
+        /**
+         * Share command logger with assembler, so that CLI flags like --no-ansi has
+         * similar impact for assembler logs as well.
+         */
         bundler.setLogger(this.logger);
+        /**
+         * Bundle project for production
+         */
         const stopOnError = this.ignoreTsErrors === true ? false : true;
         const builtSuccessfully = await bundler.bundle(stopOnError, this.packageManager);
         if (!builtSuccessfully) {
@@ -56,24 +98,25 @@ export default class Build extends BaseCommand {
     }
 }
 __decorate([
-    flags.boolean({ description: 'Watch filesystem and restart the HTTP server on file change' }),
-    __metadata("design:type", Boolean)
+    flags.boolean({ description: 'Watch filesystem and restart the HTTP server on file change' })
 ], Build.prototype, "watch", void 0);
 __decorate([
-    flags.boolean({ description: 'Ignore TypeScript errors and continue with the build process' }),
-    __metadata("design:type", Boolean)
+    flags.boolean({ description: 'Ignore TypeScript errors and continue with the build process' })
 ], Build.prototype, "ignoreTsErrors", void 0);
 __decorate([
     flags.string({
         description: 'Select the package manager you want to use to install production dependencies',
-    }),
-    __metadata("design:type", String)
+    })
 ], Build.prototype, "packageManager", void 0);
 __decorate([
     flags.boolean({
         description: 'Build frontend assets',
         showNegatedVariantInHelp: true,
         default: true,
-    }),
-    __metadata("design:type", Boolean)
+    })
 ], Build.prototype, "assets", void 0);
+__decorate([
+    flags.array({
+        description: 'Define CLI arguments to pass to the assets bundler',
+    })
+], Build.prototype, "assetsArgs", void 0);

package/build/commands/commands.json

@@ -1 +1 @@
-{"commands":[{"commandName":"build","description":"Build application for production by compiling frontend assets and TypeScript source to JavaScript","help":"","namespace":null,"aliases":[],"flags":[{"name":"watch","flagName":"watch","required":false,"type":"boolean","description":"Watch filesystem and restart the HTTP server on file change"},{"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":"Select the package manager you want to use to install production dependencies"},{"name":"assets","flagName":"assets","required":false,"type":"boolean","description":"Build frontend assets","showNegatedVariantInHelp":true,"default":true}],"args":[],"options":{},"filePath":"build.js"},{"commandName":"configure","description":"Configure a package post installation","help":"","namespace":null,"aliases":[],"flags":[],"args":[{"name":"name","argumentName":"name","required":true,"description":"Package name","type":"string"}],"options":{},"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":"generate:key","description":"Generate a 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":"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":{"allowUnknownFlags":true},"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":"Convert controller class and file name to its singular form","alias":"r"},{"name":"resource","flagName":"resource","required":false,"type":"boolean","description":"Generate controller with resource actions","alias":"r"},{"name":"api","flagName":"api","required":false,"type":"boolean","description":"Generate controller with api resource actions","alias":"a"}],"args":[{"name":"name","argumentName":"name","required":true,"description":"The name of the controller","type":"string"}],"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: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 listener","type":"string"}],"options":{"allowUnknownFlags":true},"filePath":"make/listener.js"},{"commandName":"make:middleware","description":"Create a new middleware class","help":"","namespace":"make","aliases":[],"flags":[],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the middleware","type":"string"}],"options":{"allowUnknownFlags":true},"filePath":"make/middleware.js"},{"commandName":"make:provider","description":"Create a new service provider class","help":"","namespace":"make","aliases":[],"flags":[],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the provider","type":"string"}],"options":{"allowUnknownFlags":true},"filePath":"make/provider.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"}],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the test file","type":"string"}],"options":{"allowUnknownFlags":true},"filePath":"make/test.js"},{"commandName":"serve","description":"Start the development HTTP server along with the file watcher to perform restarts on file change","help":"","namespace":null,"aliases":[],"flags":[{"name":"watch","flagName":"watch","required":false,"type":"boolean","description":"Watch filesystem and restart the HTTP server on file change"},{"name":"poll","flagName":"poll","required":false,"type":"boolean","description":"Use polling to detect filesystem changes"},{"name":"clear","flagName":"clear","required":false,"type":"boolean","description":"Clear the terminal for new logs after file change","showNegatedVariantInHelp":true,"default":true},{"name":"assets","flagName":"assets","required":false,"type":"boolean","description":"Start assets bundler dev server","showNegatedVariantInHelp":true,"default":true}],"args":[],"options":{"staysAlive":true},"filePath":"serve.js"}],"version":1}
+{"commands":[{"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":"watch","flagName":"watch","required":false,"type":"boolean","description":"Watch filesystem and restart the HTTP server on file change"},{"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":"Select the package manager you want to use to install production dependencies"},{"name":"assets","flagName":"assets","required":false,"type":"boolean","description":"Build frontend assets","showNegatedVariantInHelp":true,"default":true},{"name":"assetsArgs","flagName":"assets-args","required":false,"type":"array","description":"Define CLI arguments to pass to the assets bundler"}],"args":[],"options":{},"filePath":"build.js","absoluteFilePath":"/Users/virk/code/adonisjs/core/core/build/commands/build.js"},{"commandName":"configure","description":"Configure a package post installation","help":"","namespace":null,"aliases":[],"flags":[{"name":"verbose","flagName":"verbose","required":false,"type":"boolean","description":"Display logs in verbose mode"}],"args":[{"name":"name","argumentName":"name","required":true,"description":"Package name","type":"string"}],"options":{},"filePath":"configure.js","absoluteFilePath":"/Users/virk/code/adonisjs/core/core/build/commands/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","absoluteFilePath":"/Users/virk/code/adonisjs/core/core/build/commands/eject.js"},{"commandName":"generate:key","description":"Generate a 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","absoluteFilePath":"/Users/virk/code/adonisjs/core/core/build/commands/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","absoluteFilePath":"/Users/virk/code/adonisjs/core/core/build/commands/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","absoluteFilePath":"/Users/virk/code/adonisjs/core/core/build/commands/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","absoluteFilePath":"/Users/virk/code/adonisjs/core/core/build/commands/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":"Convert controller class and file name to its singular form","alias":"r"},{"name":"resource","flagName":"resource","required":false,"type":"boolean","description":"Generate controller with resource actions","alias":"r"},{"name":"api","flagName":"api","required":false,"type":"boolean","description":"Generate controller with api resource actions","alias":"a"}],"args":[{"name":"name","argumentName":"name","required":true,"description":"The name of the controller","type":"string"}],"options":{},"filePath":"make/controller.js","absoluteFilePath":"/Users/virk/code/adonisjs/core/core/build/commands/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":{},"filePath":"make/event.js","absoluteFilePath":"/Users/virk/code/adonisjs/core/core/build/commands/make/event.js"},{"commandName":"make:exception","description":"Create a new ace exception class","help":"","namespace":"make","aliases":[],"flags":[],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the exception","type":"string"}],"options":{},"filePath":"make/exception.js","absoluteFilePath":"/Users/virk/code/adonisjs/core/core/build/commands/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 listener","type":"string"}],"options":{},"filePath":"make/listener.js","absoluteFilePath":"/Users/virk/code/adonisjs/core/core/build/commands/make/listener.js"},{"commandName":"make:middleware","description":"Create a new middleware class","help":"","namespace":"make","aliases":[],"flags":[],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the middleware","type":"string"}],"options":{},"filePath":"make/middleware.js","absoluteFilePath":"/Users/virk/code/adonisjs/core/core/build/commands/make/middleware.js"},{"commandName":"make:preload","description":"Create a new preload file inside the start directory","help":"","namespace":"make","aliases":[],"flags":[{"name":"environments","flagName":"environments","required":false,"type":"array","description":"Define the preload file's environment. Accepted values are \"web,console,test,repl\""}],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the preload file","type":"string"}],"options":{},"filePath":"make/preload.js","absoluteFilePath":"/Users/virk/code/adonisjs/core/core/build/commands/make/preload.js"},{"commandName":"make:provider","description":"Create a new service provider class","help":"","namespace":"make","aliases":[],"flags":[],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the provider","type":"string"}],"options":{},"filePath":"make/provider.js","absoluteFilePath":"/Users/virk/code/adonisjs/core/core/build/commands/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":{},"filePath":"make/service.js","absoluteFilePath":"/Users/virk/code/adonisjs/core/core/build/commands/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"}],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the test file","type":"string"}],"options":{},"filePath":"make/test.js","absoluteFilePath":"/Users/virk/code/adonisjs/core/core/build/commands/make/test.js"},{"commandName":"make:validator","description":"Create a new VineJS validator","help":"","namespace":"make","aliases":[],"flags":[],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the validator","type":"string"}],"options":{},"filePath":"make/validator.js","absoluteFilePath":"/Users/virk/code/adonisjs/core/core/build/commands/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","absoluteFilePath":"/Users/virk/code/adonisjs/core/core/build/commands/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","absoluteFilePath":"/Users/virk/code/adonisjs/core/core/build/commands/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","```","","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":"watch","flagName":"watch","required":false,"type":"boolean","description":"Watch filesystem and restart the HTTP server on file change"},{"name":"poll","flagName":"poll","required":false,"type":"boolean","description":"Use polling to detect filesystem changes"},{"name":"clear","flagName":"clear","required":false,"type":"boolean","description":"Clear the terminal for new logs after file change","showNegatedVariantInHelp":true,"default":true},{"name":"assets","flagName":"assets","required":false,"type":"boolean","description":"Start assets bundler dev server","showNegatedVariantInHelp":true,"default":true},{"name":"assetsArgs","flagName":"assets-args","required":false,"type":"array","description":"Define CLI arguments to pass to the assets bundler"}],"args":[],"options":{"staysAlive":true},"filePath":"serve.js","absoluteFilePath":"/Users/virk/code/adonisjs/core/core/build/commands/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},{"name":"assets","flagName":"assets","required":false,"type":"boolean","description":"Start assets bundler dev server.","showNegatedVariantInHelp":true,"default":true},{"name":"assetsArgs","flagName":"assets-args","required":false,"type":"array","description":"Define CLI arguments to pass to the assets bundler"}],"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","absoluteFilePath":"/Users/virk/code/adonisjs/core/core/build/commands/test.js"}],"version":1}

package/build/commands/configure.d.ts

@@ -1,17 +1,44 @@
-import type { ApplicationService } from '../src/types.js';
 import { BaseCommand } from '../modules/ace/main.js';
+/**
+ * The configure command is used to configure packages after installation
+ */
 export default class Configure extends BaseCommand {
     #private;
     static commandName: string;
     static description: string;
     name: string;
+    verbose?: boolean;
+    /**
+     * The root of the stubs directory. The value is defined after we import
+     * the package
+     */
     stubsRoot: string;
+    /**
+     * Publish a stub file to the user project
+     */
     publishStub(stubPath: string, stubData?: Record<string, any>): Promise<void>;
-    defineEnvVariables(environmentVariables: Record<string, number | string | boolean>): Promise<void>;
-    updateRcFile(callback: (rcFileEditor: ApplicationService['rcFileEditor']) => Promise<void> | void): Promise<void>;
+    /**
+     * Install packages using the correct package manager
+     * You can specify version of each package by setting it in the
+     * name like :
+     *
+     * ```
+     * installPackages(['@adonisjs/lucid@next', '@adonisjs/auth@3.0.0'])
+     * ```
+     */
+    installPackages(packages: {
+        name: string;
+        isDevDependency: boolean;
+    }[]): Promise<void>;
+    /**
+     * List the packages one should install before using the packages
+     */
     listPackagesToInstall(packages: {
         name: string;
         isDevDependency: boolean;
     }[]): void;
+    /**
+     * Run method is invoked by ace automatically
+     */
     run(): Promise<void>;
 }

package/build/commands/configure.js

@@ -1,21 +1,36 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
     var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
     if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
     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;
 };
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
 import { slash } from '@poppinss/utils';
-import { EnvEditor } from '../modules/env.js';
-import { args, BaseCommand } from '../modules/ace/main.js';
+import { installPackage, detectPackageManager } from '@antfu/install-pkg';
+import { args, BaseCommand, flags } from '../modules/ace/main.js';
+/**
+ * The configure command is used to configure packages after installation
+ */
 export default class Configure extends BaseCommand {
     static commandName = 'configure';
     static description = 'Configure a package post installation';
+    /**
+     * Returns the package main exports
+     */
     #getPackageSource(packageName) {
         return this.app.import(packageName);
     }
+    /**
+     * Returns the installation command for different
+     * package managers
+     */
     #getInstallationCommands(packages, packageManager, isDev) {
         if (!packages.length) {
             return '';
@@ -30,35 +45,78 @@ export default class Configure extends BaseCommand {
                 return `${this.colors.yellow(`pnpm add${devFlag}`)} ${packages.join(' ')}`;
         }
     }
+    /**
+     * Registers VineJS provider
+     */
+    async #configureVineJS() {
+        const codemods = await this.createCodemods();
+        await codemods.updateRcFile((rcFile) => {
+            rcFile.addProvider('@adonisjs/core/providers/vinejs_provider');
+        });
+    }
+    /**
+     * Registers Edge provider
+     */
+    async #configureEdge() {
+        const codemods = await this.createCodemods();
+        await codemods.updateRcFile((rcFile) => {
+            rcFile.addProvider('@adonisjs/core/providers/edge_provider');
+        });
+    }
+    /**
+     * Publish a stub file to the user project
+     */
     async publishStub(stubPath, stubData) {
-        const stub = await this.app.stubs.build(stubPath, {
+        const stubs = await this.app.stubs.create();
+        const stub = await stubs.build(stubPath, {
             source: this.stubsRoot,
         });
         const output = await stub.generate(stubData || {});
+        /**
+         * Log message
+         */
         const entityFileName = slash(this.app.relativePath(output.destination));
         if (output.status === 'skipped') {
             return this.logger.action(`create ${entityFileName}`).skipped(output.skipReason);
         }
         this.logger.action(`create ${entityFileName}`).succeeded();
     }
-    async defineEnvVariables(environmentVariables) {
-        const logs = [];
-        const editor = new EnvEditor(this.app.appRoot);
-        await editor.load();
-        Object.keys(environmentVariables).forEach((key) => {
-            const value = environmentVariables[key];
-            editor.add(key, value);
-            logs.push(`               ${this.colors.dim(`${key}=${value}`)}`);
-        });
-        await editor.save();
-        this.logger.action('update .env file').succeeded();
-        this.logger.log(logs.join('\n'));
-    }
-    async updateRcFile(callback) {
-        await callback(this.app.rcFileEditor);
-        await this.app.rcFileEditor.save();
-        this.logger.action('update .adonisrc.json file').succeeded();
+    /**
+     * Install packages using the correct package manager
+     * You can specify version of each package by setting it in the
+     * name like :
+     *
+     * ```
+     * installPackages(['@adonisjs/lucid@next', '@adonisjs/auth@3.0.0'])
+     * ```
+     */
+    async installPackages(packages) {
+        const appPath = this.app.makePath();
+        const silent = this.verbose === true ? false : true;
+        const devDeps = packages.filter((pkg) => pkg.isDevDependency).map(({ name }) => name);
+        const deps = packages.filter((pkg) => !pkg.isDevDependency).map(({ name }) => name);
+        const packageManager = await detectPackageManager(appPath);
+        let spinner = this.logger
+            .await(`installing dependencies using ${packageManager || 'npm'}`)
+            .start();
+        try {
+            await installPackage(deps, { cwd: appPath, silent });
+            await installPackage(devDeps, { dev: true, cwd: appPath, silent });
+            spinner.stop();
+            this.logger.success('dependencies installed');
+            this.logger.log(devDeps.map((dep) => `      ${this.colors.dim('dev')} ${dep}`).join('\n'));
+            this.logger.log(deps.map((dep) => `      ${this.colors.dim('prod')} ${dep}`).join('\n'));
+        }
+        catch (error) {
+            spinner.update('unable to install dependencies');
+            spinner.stop();
+            this.exitCode = 1;
+            this.logger.fatal(error);
+        }
     }
+    /**
+     * List the packages one should install before using the packages
+     */
     listPackagesToInstall(packages) {
         const devDependencies = packages.filter((pkg) => pkg.isDevDependency).map(({ name }) => name);
         const prodDependencies = packages.filter((pkg) => !pkg.isDevDependency).map(({ name }) => name);
@@ -84,22 +142,42 @@ export default class Configure extends BaseCommand {
             .forEach((line) => instructions.add(line));
         instructions.render();
     }
+    /**
+     * Run method is invoked by ace automatically
+     */
     async run() {
+        if (this.name === 'vinejs') {
+            return this.#configureVineJS();
+        }
+        if (this.name === 'edge') {
+            return this.#configureEdge();
+        }
         const packageExports = await this.#getPackageSource(this.name);
+        /**
+         * Warn, there are not instructions to run
+         */
         if (!packageExports.configure) {
             this.logger.warning(`Cannot configure "${this.name}" package. The package does not export the configure hook`);
             return;
         }
+        /**
+         * Instructions needs stubs root
+         */
         if (!packageExports.stubsRoot) {
             this.logger.error(`Missing "stubsRoot" export from "${this.name}" package. The stubsRoot variable is required to lookup package stubs`);
             this.exitCode = 1;
             return;
         }
         this.stubsRoot = packageExports.stubsRoot;
+        /**
+         * Run instructions
+         */
         await packageExports.configure(this);
     }
 }
 __decorate([
-    args.string({ description: 'Package name' }),
-    __metadata("design:type", String)
+    args.string({ description: 'Package name' })
 ], Configure.prototype, "name", void 0);
+__decorate([
+    flags.boolean({ description: 'Display logs in verbose mode' })
+], Configure.prototype, "verbose", void 0);

package/build/commands/eject.d.ts

@@ -1,4 +1,8 @@
 import { BaseCommand } from '../modules/ace/main.js';
+/**
+ * The eject command is used to eject templates to the user
+ * application codebase for customizing them
+ */
 export default class Eject extends BaseCommand {
     static commandName: string;
     static description: string;

package/build/commands/eject.js

@@ -1,19 +1,29 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
     var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
     if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
     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;
 };
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
 import { slash } from '@poppinss/utils';
 import { args, BaseCommand, flags } from '../modules/ace/main.js';
+/**
+ * The eject command is used to eject templates to the user
+ * application codebase for customizing them
+ */
 export default class Eject extends BaseCommand {
     static commandName = 'eject';
     static description = 'Eject scaffolding stubs to your application root';
     async run() {
-        const copied = await this.app.stubs.copy(this.stubPath, {
+        const stubs = await this.app.stubs.create();
+        const copied = await stubs.copy(this.stubPath, {
             pkg: this.pkg,
         });
         copied.forEach((stubPath) => {
@@ -22,13 +32,11 @@ export default class Eject extends BaseCommand {
     }
 }
 __decorate([
-    args.string({ description: 'Path to the stubs directory or a single stub file' }),
-    __metadata("design:type", String)
+    args.string({ description: 'Path to the stubs directory or a single stub file' })
 ], Eject.prototype, "stubPath", void 0);
 __decorate([
     flags.string({
         description: 'Mention package name for searching stubs',
         default: '@adonisjs/core',
-    }),
-    __metadata("design:type", String)
+    })
 ], Eject.prototype, "pkg", void 0);

package/build/commands/generate_key.d.ts

@@ -1,4 +1,8 @@
 import { BaseCommand } from '../modules/ace/main.js';
+/**
+ * The generate key command is used to generate the app key
+ * and write it inside the .env file.
+ */
 export default class GenerateKey extends BaseCommand {
     static commandName: string;
     static description: string;

package/build/commands/generate_key.js

@@ -1,15 +1,24 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
     var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
     if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
     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;
 };
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
 import string from '@poppinss/utils/string';
-import { EnvEditor } from '../modules/env.js';
+import { EnvEditor } from '@adonisjs/env/editor';
 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.
+ */
 export default class GenerateKey extends BaseCommand {
     static commandName = 'generate:key';
     static description = 'Generate a secure random application key';
@@ -36,12 +45,10 @@ export default class GenerateKey extends BaseCommand {
 __decorate([
     flags.boolean({
         description: 'Display the key on the terminal, instead of writing it to .env file',
-    }),
-    __metadata("design:type", Boolean)
+    })
 ], GenerateKey.prototype, "show", void 0);
 __decorate([
     flags.boolean({
         description: 'Force update .env file in production environment',
-    }),
-    __metadata("design:type", Boolean)
+    })
 ], GenerateKey.prototype, "force", void 0);

package/build/commands/inspect_rcfile.d.ts

@@ -0,0 +1,9 @@
+import { BaseCommand } from '../modules/ace/main.js';
+/**
+ * Prints the RcFile file contents to the terminal
+ */
+export default class InspectRCFile extends BaseCommand {
+    static commandName: string;
+    static description: string;
+    run(): Promise<void>;
+}

package/build/commands/inspect_rcfile.js

@@ -0,0 +1,36 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import lodash from '@poppinss/utils/lodash';
+import { BaseCommand } from '../modules/ace/main.js';
+/**
+ * Prints the RcFile file contents to the terminal
+ */
+export default class InspectRCFile extends BaseCommand {
+    static commandName = 'inspect:rcfile';
+    static description = 'Inspect the RC file with its default values';
+    async run() {
+        const rcContents = lodash.omit(this.app.rcFile, ['raw']);
+        rcContents.providers = rcContents.providers?.map((provider) => {
+            return {
+                ...provider,
+                file: provider.file.toString(),
+            };
+        });
+        rcContents.preloads = rcContents.preloads?.map((preload) => {
+            return {
+                ...preload,
+                file: preload.file.toString(),
+            };
+        });
+        rcContents.commands = rcContents.commands?.map((command) => {
+            return command.toString();
+        });
+        this.logger.log(JSON.stringify(rcContents, null, 2));
+    }
+}