@adonisjs/core 6.1.5-2 → 6.1.5-21

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

@@ -1,13 +1,36 @@
 import type { CommandOptions } from '../../types/ace.js';
 import { BaseCommand } from '../../modules/ace/main.js';
+/**
+ * The list routes command is used to view the list of registered routes
+ */
 export default class ListRoutes extends BaseCommand {
     static commandName: string;
     static description: string;
+    /**
+     * Making sure to start the application so that the routes are
+     * imported
+     */
     static options: CommandOptions;
+    /**
+     * The match filter is used to find route by name, pattern and controller name that
+     * includes the match keyword
+     */
     match: string;
+    /**
+     * The middleware flag searches for the routes using all the mentioned middleware
+     */
     middleware: string[];
+    /**
+     * The ignoreMiddleware flag searches for the routes not using all the mentioned middleware
+     */
     ignoreMiddleware: string[];
+    /**
+     * The json flag is used to view list of routes as a JSON string.
+     */
     json: boolean;
+    /**
+     * The table flag is used to view list of routes as a classic CLI table
+     */
     table: boolean;
     run(): Promise<void>;
 }

package/build/commands/list/routes.js

@@ -1,17 +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 { 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
+ */
 export default class ListRoutes extends BaseCommand {
     static commandName = 'list:routes';
     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
+     */
     static options = {
         startApp: true,
     };
@@ -22,10 +34,16 @@ export default class ListRoutes extends BaseCommand {
             middleware: this.middleware,
             match: this.match,
         });
+        /**
+         * Display as JSON
+         */
         if (this.json) {
             this.logger.log(JSON.stringify(await formatter.formatAsJSON(), null, 2));
             return;
         }
+        /**
+         * Display as a standard table
+         */
         if (this.table) {
             const tables = await formatter.formatAsAnsiTable();
             tables.forEach((table) => {
@@ -38,6 +56,9 @@ export default class ListRoutes extends BaseCommand {
             });
             return;
         }
+        /**
+         * Display as a list
+         */
         const list = await formatter.formatAsAnsiList();
         list.forEach((item) => {
             this.logger.log('');
@@ -53,26 +74,21 @@ __decorate([
     args.string({
         description: 'Find routes matching the given keyword. Route name, pattern and controller name will be searched against the keyword',
         required: false,
-    }),
-    __metadata("design:type", String)
+    })
 ], ListRoutes.prototype, "match", void 0);
 __decorate([
     flags.array({
         description: 'View routes that includes all the mentioned middleware names. Use * to see routes that are using one or more middleware',
-    }),
-    __metadata("design:type", Array)
+    })
 ], ListRoutes.prototype, "middleware", void 0);
 __decorate([
     flags.array({
         description: 'View routes that does not include all the mentioned middleware names. Use * to see routes that are using zero middleware',
-    }),
-    __metadata("design:type", Array)
+    })
 ], ListRoutes.prototype, "ignoreMiddleware", void 0);
 __decorate([
-    flags.boolean({ description: 'Get routes list as a JSON string' }),
-    __metadata("design:type", Boolean)
+    flags.boolean({ description: 'Get routes list as a JSON string' })
 ], ListRoutes.prototype, "json", void 0);
 __decorate([
-    flags.boolean({ description: 'View list of routes as a table' }),
-    __metadata("design:type", Boolean)
+    flags.boolean({ description: 'View list of routes as a table' })
 ], ListRoutes.prototype, "table", void 0);

package/build/commands/main.d.ts

@@ -0,0 +1,4 @@
+import { CommandMetaData, Command } from '@adonisjs/ace/types';
+
+export function getMetaData(): Promise<CommandMetaData[]>
+export function getCommand(metaData: CommandMetaData): Promise<Command | null>

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

@@ -1,8 +1,14 @@
-import BaseCommand from './_base.js';
+import { BaseCommand } from '../../modules/ace/main.js';
+/**
+ * Make a new ace command
+ */
 export default class MakeCommand extends BaseCommand {
     static commandName: string;
     static description: string;
     name: string;
+    /**
+     * The stub to use for generating the command class
+     */
     protected stubPath: string;
     run(): Promise<void>;
 }

package/build/commands/make/command.js

@@ -1,25 +1,38 @@
+/*
+ * @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 from './_base.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
+ */
 export default class MakeCommand extends BaseCommand {
     static commandName = 'make:command';
     static description = 'Create a new ace command class';
+    /**
+     * The stub to use for generating the command class
+     */
     stubPath = 'make/command/main.stub';
     async run() {
-        await this.generate(this.stubPath, {
+        const codemods = await this.createCodemods();
+        await codemods.makeUsingStub(stubsRoot, this.stubPath, {
+            flags: this.parsed.flags,
             entity: this.app.generators.createEntity(this.name),
         });
     }
 }
 __decorate([
-    args.string({ description: 'Name of the command' }),
-    __metadata("design:type", String)
+    args.string({ description: 'Name of the command' })
 ], MakeCommand.prototype, "name", void 0);

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

@@ -1,4 +1,7 @@
-import BaseCommand from './_base.js';
+import { BaseCommand } from '../../modules/ace/main.js';
+/**
+ * The make controller command to create an HTTP controller
+ */
 export default class MakeController extends BaseCommand {
     static commandName: string;
     static description: string;
@@ -6,7 +9,13 @@ export default class MakeController extends BaseCommand {
     singular: boolean;
     resource: boolean;
     api: boolean;
+    /**
+     * The stub to use for generating the controller
+     */
     protected stubPath: string;
+    /**
+     * Preparing the command state
+     */
     prepare(): Promise<void>;
     run(): Promise<void>;
 }

package/build/commands/make/controller.js

@@ -1,57 +1,78 @@
+/*
+ * @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 from './_base.js';
-import { args, flags } from '../../modules/ace/main.js';
+import { args, flags, BaseCommand } from '../../modules/ace/main.js';
+import { stubsRoot } from '../../stubs/main.js';
+/**
+ * The make controller command to create an HTTP controller
+ */
 export default class MakeController extends BaseCommand {
     static commandName = 'make:controller';
     static description = 'Create a new HTTP controller class';
+    /**
+     * The stub to use for generating the controller
+     */
     stubPath = 'make/controller/main.stub';
+    /**
+     * Preparing the command state
+     */
     async prepare() {
+        /**
+         * Use resource stub
+         */
         if (this.resource) {
             this.stubPath = 'make/controller/resource.stub';
         }
+        /**
+         * Use api stub
+         */
         if (this.api) {
             this.stubPath = 'make/controller/api.stub';
         }
+        /**
+         * Log warning when both flags are used together
+         */
         if (this.resource && this.api) {
             this.logger.warning('--api and --resource flags cannot be used together. Ignoring --resource');
         }
     }
     async run() {
-        await this.generate(this.stubPath, {
+        const codemods = await this.createCodemods();
+        await codemods.makeUsingStub(stubsRoot, this.stubPath, {
+            flags: this.parsed.flags,
             entity: this.app.generators.createEntity(this.name),
         });
     }
 }
 __decorate([
-    args.string({ description: 'The name of the controller' }),
-    __metadata("design:type", String)
+    args.string({ description: 'The name of the controller' })
 ], MakeController.prototype, "name", void 0);
 __decorate([
     flags.boolean({
         description: 'Convert controller class and file name to its singular form',
         alias: 'r',
-    }),
-    __metadata("design:type", Boolean)
+    })
 ], MakeController.prototype, "singular", void 0);
 __decorate([
     flags.boolean({
         description: 'Generate controller with resource actions',
         alias: 'r',
-    }),
-    __metadata("design:type", Boolean)
+    })
 ], MakeController.prototype, "resource", void 0);
 __decorate([
     flags.boolean({
         description: 'Generate controller with api resource actions',
         alias: 'a',
-    }),
-    __metadata("design:type", Boolean)
+    })
 ], MakeController.prototype, "api", void 0);

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

@@ -1,8 +1,14 @@
-import BaseCommand from './_base.js';
+import { BaseCommand } from '../../modules/ace/main.js';
+/**
+ * The make event command to create a class based event
+ */
 export default class MakeEvent extends BaseCommand {
     static commandName: string;
     static description: string;
     name: string;
+    /**
+     * The stub to use for generating the event
+     */
     protected stubPath: string;
     run(): Promise<void>;
 }

package/build/commands/make/event.js

@@ -1,25 +1,37 @@
+/*
+ * @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 from './_base.js';
-import { args } from '../../modules/ace/main.js';
+import { stubsRoot } from '../../stubs/main.js';
+import { args, BaseCommand } from '../../modules/ace/main.js';
+/**
+ * The make event command to create a class based event
+ */
 export default class MakeEvent extends BaseCommand {
     static commandName = 'make:event';
     static description = 'Create a new event class';
+    /**
+     * The stub to use for generating the event
+     */
     stubPath = 'make/event/main.stub';
     async run() {
-        await this.generate(this.stubPath, {
+        const codemods = await this.createCodemods();
+        await codemods.makeUsingStub(stubsRoot, this.stubPath, {
+            flags: this.parsed.flags,
             entity: this.app.generators.createEntity(this.name),
         });
     }
 }
 __decorate([
-    args.string({ description: 'Name of the event' }),
-    __metadata("design:type", String)
+    args.string({ description: 'Name of the event' })
 ], MakeEvent.prototype, "name", void 0);

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

@@ -0,0 +1,14 @@
+import { BaseCommand } from '../../modules/ace/main.js';
+/**
+ * Make a new exception class
+ */
+export default class MakeException extends BaseCommand {
+    static commandName: string;
+    static description: string;
+    name: string;
+    /**
+     * The stub to use for generating the command class
+     */
+    protected stubPath: string;
+    run(): Promise<void>;
+}

package/build/commands/make/exception.js

@@ -0,0 +1,37 @@
+/*
+ * @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;
+};
+import { stubsRoot } from '../../stubs/main.js';
+import { args, BaseCommand } from '../../modules/ace/main.js';
+/**
+ * Make a new exception class
+ */
+export default class MakeException extends BaseCommand {
+    static commandName = 'make:exception';
+    static description = 'Create a new ace exception class';
+    /**
+     * The stub to use for generating the command class
+     */
+    stubPath = 'make/exception/main.stub';
+    async run() {
+        const codemods = await this.createCodemods();
+        await codemods.makeUsingStub(stubsRoot, this.stubPath, {
+            flags: this.parsed.flags,
+            entity: this.app.generators.createEntity(this.name),
+        });
+    }
+}
+__decorate([
+    args.string({ description: 'Name of the exception' })
+], MakeException.prototype, "name", void 0);

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

@@ -1,9 +1,16 @@
-import BaseCommand from './_base.js';
+import { BaseCommand } from '../../modules/ace/main.js';
+/**
+ * The make listener command to create a class based event
+ * listener
+ */
 export default class MakeListener extends BaseCommand {
     static commandName: string;
     static description: string;
     name: string;
     event: string;
+    /**
+     * The stub to use for generating the event listener
+     */
     protected stubPath: string;
     prepare(): void;
     run(): Promise<void>;

package/build/commands/make/listener.js

@@ -1,17 +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 BaseCommand from './_base.js';
-import { args, flags } from '../../modules/ace/main.js';
+import { stubsRoot } from '../../stubs/main.js';
+import { args, flags, BaseCommand } from '../../modules/ace/main.js';
+/**
+ * The make listener command to create a class based event
+ * listener
+ */
 export default class MakeListener extends BaseCommand {
     static commandName = 'make:listener';
     static description = 'Create a new event listener class';
+    /**
+     * The stub to use for generating the event listener
+     */
     stubPath = 'make/listener/main.stub';
     prepare() {
         if (this.event) {
@@ -19,30 +31,34 @@ export default class MakeListener extends BaseCommand {
         }
     }
     async run() {
+        const codemods = await this.createCodemods();
         if (this.event) {
             const { exitCode } = await this.kernel.exec('make:event', [this.event]);
+            /**
+             * Create listener only when make:event is completed successfully
+             */
             if (exitCode === 0) {
                 const eventEntity = this.app.generators.createEntity(this.event);
-                await this.generate(this.stubPath, {
-                    entity: this.app.generators.createEntity(this.name),
+                await codemods.makeUsingStub(stubsRoot, this.stubPath, {
                     event: eventEntity,
+                    flags: this.parsed.flags,
+                    entity: this.app.generators.createEntity(this.name),
                 });
             }
             return;
         }
-        await this.generate(this.stubPath, {
+        await codemods.makeUsingStub(stubsRoot, this.stubPath, {
+            flags: this.parsed.flags,
             entity: this.app.generators.createEntity(this.name),
         });
     }
 }
 __decorate([
-    args.string({ description: 'Name of the listener' }),
-    __metadata("design:type", String)
+    args.string({ description: 'Name of the listener' })
 ], MakeListener.prototype, "name", void 0);
 __decorate([
     flags.string({
         description: 'Generate an event class alongside the listener',
         alias: 'e',
-    }),
-    __metadata("design:type", String)
+    })
 ], MakeListener.prototype, "event", void 0);

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

@@ -1,8 +1,15 @@
-import BaseCommand from './_base.js';
+import { BaseCommand } from '../../modules/ace/main.js';
+/**
+ * The make middleware command to create a new middleware
+ * class.
+ */
 export default class MakeMiddleware extends BaseCommand {
     static commandName: string;
     static description: string;
     name: string;
+    /**
+     * The stub to use for generating the middleware
+     */
     protected stubPath: string;
     run(): Promise<void>;
 }

package/build/commands/make/middleware.js

@@ -1,25 +1,38 @@
+/*
+ * @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 from './_base.js';
-import { args } from '../../modules/ace/main.js';
+import { stubsRoot } from '../../stubs/main.js';
+import { args, BaseCommand } from '../../modules/ace/main.js';
+/**
+ * The make middleware command to create a new middleware
+ * class.
+ */
 export default class MakeMiddleware extends BaseCommand {
     static commandName = 'make:middleware';
     static description = 'Create a new middleware class';
+    /**
+     * The stub to use for generating the middleware
+     */
     stubPath = 'make/middleware/main.stub';
     async run() {
-        await this.generate(this.stubPath, {
+        const codemods = await this.createCodemods();
+        await codemods.makeUsingStub(stubsRoot, this.stubPath, {
+            flags: this.parsed.flags,
             entity: this.app.generators.createEntity(this.name),
         });
     }
 }
 __decorate([
-    args.string({ description: 'Name of the middleware' }),
-    __metadata("design:type", String)
+    args.string({ description: 'Name of the middleware' })
 ], MakeMiddleware.prototype, "name", void 0);

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

@@ -0,0 +1,22 @@
+import { BaseCommand } from '../../modules/ace/main.js';
+declare const ALLOWED_ENVIRONMENTS: ("web" | "console" | "test" | "repl")[];
+type AllowedAppEnvironments = typeof ALLOWED_ENVIRONMENTS;
+/**
+ * Make a new preload file
+ */
+export default class MakePreload extends BaseCommand {
+    #private;
+    static commandName: string;
+    static description: string;
+    name: string;
+    environments: AllowedAppEnvironments;
+    /**
+     * The stub to use for generating the preload file
+     */
+    protected stubPath: string;
+    /**
+     * Run command
+     */
+    run(): Promise<void>;
+}
+export {};