@adonisjs/core 7.0.1 → 7.1.0

package/build/commands/make/controller.js

@@ -1,18 +1,59 @@
-import { t as stubsRoot } from "../../main-kn40V-hF.js";
-import { f as BaseCommand, l as flags, o as args } from "../../main-MBAMnmJb.js";
-import { t as __decorate } from "../../decorate-DmrZA614.js";
+import "../../chunk-Do49iUES.js";
+import { t as stubsRoot } from "../../main-CfTiGsiS.js";
+import { f as BaseCommand, l as flags, o as args } from "../../main-CRnMnrH7.js";
+import { t as __decorate } from "../../decorate-B9Uz0anB.js";
 import string from "@poppinss/utils/string";
+//#region commands/make/controller.ts
+/**
+* The make controller command to create an HTTP controller
+*
+* @example
+* ```
+* ace make:controller User
+* ace make:controller User store update
+* ace make:controller User --resource
+* ace make:controller User --api
+* ace make:controller User --singular
+* ```
+*/
 var MakeController = class extends BaseCommand {
+	/**
+	* The command name
+	*/
 	static commandName = "make:controller";
-	static description = "Create a new HTTP controller class";
+	/**
+	* The command description
+	*/
+	static description = "Create a new HTTP controller class in app/controllers. Use --resource for CRUD methods or --api for API-only CRUD (no create/edit)";
+	/**
+	* Command options configuration
+	*/
 	static options = { allowUnknownFlags: true };
+	/**
+	* The stub to use for generating the controller
+	*/
 	stubPath = "make/controller/main.stub";
+	/**
+	* Preparing the command state
+	*/
 	async prepare() {
+		/**
+		* Use actions stub
+		*/
 		if (this.actions) this.stubPath = "make/controller/actions.stub";
+		/**
+		* Use resource stub
+		*/
 		if (this.resource) if (this.actions) this.logger.warning("Cannot use --resource flag with actions. Ignoring --resource");
 		else this.stubPath = "make/controller/resource.stub";
+		/**
+		* Use api stub
+		*/
 		if (this.api) if (this.actions) this.logger.warning("Cannot use --api flag with actions. Ignoring --api");
 		else this.stubPath = "make/controller/api.stub";
+		/**
+		* Log warning when both flags are used together
+		*/
 		if (this.resource && this.api && !this.actions) this.logger.warning("--api and --resource flags cannot be used together. Ignoring --resource");
 	}
 	async run() {
@@ -42,4 +83,5 @@ __decorate([flags.boolean({
 	alias: "a"
 })], MakeController.prototype, "api", void 0);
 __decorate([flags.string({ description: "Use the contents of the given file as the generated output" })], MakeController.prototype, "contentsFrom", void 0);
+//#endregion
 export { MakeController as default };

package/build/commands/make/event.js

@@ -1,11 +1,42 @@
-import { t as stubsRoot } from "../../main-kn40V-hF.js";
-import { f as BaseCommand, l as flags, o as args } from "../../main-MBAMnmJb.js";
-import { t as __decorate } from "../../decorate-DmrZA614.js";
+import "../../chunk-Do49iUES.js";
+import { t as stubsRoot } from "../../main-CfTiGsiS.js";
+import { f as BaseCommand, l as flags, o as args } from "../../main-CRnMnrH7.js";
+import { t as __decorate } from "../../decorate-B9Uz0anB.js";
+//#region commands/make/event.ts
+/**
+* Command to create a new event class.
+* Events are data objects that encapsulate information about something
+* that happened in your application and can be dispatched to listeners.
+*
+* @example
+* ```
+* ace make:event UserRegistered
+* ace make:event OrderCompleted
+* ace make:event EmailSent
+* ```
+*/
 var MakeEvent = class extends BaseCommand {
+	/**
+	* The command name
+	*/
 	static commandName = "make:event";
-	static description = "Create a new event class";
+	/**
+	* The command description
+	*/
+	static description = "Create a new event class in app/events. Events are dispatched via emitter and handled by listeners";
+	/**
+	* Command options configuration.
+	* Allows unknown flags to be passed through.
+	*/
 	static options = { allowUnknownFlags: true };
+	/**
+	* The stub template file to use for generating the event class
+	*/
 	stubPath = "make/event/main.stub";
+	/**
+	* Execute the command to create a new event class.
+	* Generates the event file with proper event structure.
+	*/
 	async run() {
 		await (await this.createCodemods()).makeUsingStub(stubsRoot, this.stubPath, {
 			flags: this.parsed.flags,
@@ -15,4 +46,5 @@ var MakeEvent = class extends BaseCommand {
 };
 __decorate([args.string({ description: "Name of the event" })], MakeEvent.prototype, "name", void 0);
 __decorate([flags.string({ description: "Use the contents of the given file as the generated output" })], MakeEvent.prototype, "contentsFrom", void 0);
+//#endregion
 export { MakeEvent as default };

package/build/commands/make/exception.js

@@ -1,11 +1,42 @@
-import { t as stubsRoot } from "../../main-kn40V-hF.js";
-import { f as BaseCommand, l as flags, o as args } from "../../main-MBAMnmJb.js";
-import { t as __decorate } from "../../decorate-DmrZA614.js";
+import "../../chunk-Do49iUES.js";
+import { t as stubsRoot } from "../../main-CfTiGsiS.js";
+import { f as BaseCommand, l as flags, o as args } from "../../main-CRnMnrH7.js";
+import { t as __decorate } from "../../decorate-B9Uz0anB.js";
+//#region commands/make/exception.ts
+/**
+* Command to create a new custom exception class.
+* Custom exceptions allow you to define specific error types for your application
+* with custom error messages, status codes, and error handling logic.
+*
+* @example
+* ```
+* ace make:exception ValidationException
+* ace make:exception UnauthorizedException
+* ace make:exception ResourceNotFoundException
+* ```
+*/
 var MakeException = class extends BaseCommand {
+	/**
+	* The command name
+	*/
 	static commandName = "make:exception";
-	static description = "Create a new custom exception class";
+	/**
+	* The command description
+	*/
+	static description = "Create a new custom exception class in app/exceptions with handle and report methods";
+	/**
+	* Command options configuration.
+	* Allows unknown flags to be passed through.
+	*/
 	static options = { allowUnknownFlags: true };
+	/**
+	* The stub template file to use for generating the exception class
+	*/
 	stubPath = "make/exception/main.stub";
+	/**
+	* Execute the command to create a new custom exception class.
+	* Generates the exception file with proper error handling structure.
+	*/
 	async run() {
 		await (await this.createCodemods()).makeUsingStub(stubsRoot, this.stubPath, {
 			flags: this.parsed.flags,
@@ -15,4 +46,5 @@ var MakeException = class extends BaseCommand {
 };
 __decorate([args.string({ description: "Name of the exception" })], MakeException.prototype, "name", void 0);
 __decorate([flags.string({ description: "Use the contents of the given file as the generated output" })], MakeException.prototype, "contentsFrom", void 0);
+//#endregion
 export { MakeException as default };

package/build/commands/make/listener.js

@@ -1,18 +1,57 @@
-import { t as stubsRoot } from "../../main-kn40V-hF.js";
-import { f as BaseCommand, l as flags, o as args } from "../../main-MBAMnmJb.js";
-import { t as __decorate } from "../../decorate-DmrZA614.js";
+import "../../chunk-Do49iUES.js";
+import { t as stubsRoot } from "../../main-CfTiGsiS.js";
+import { f as BaseCommand, l as flags, o as args } from "../../main-CRnMnrH7.js";
+import { t as __decorate } from "../../decorate-B9Uz0anB.js";
+//#region commands/make/listener.ts
+/**
+* Command to create a new event listener class.
+* Event listeners handle events dispatched by the application and can optionally
+* generate the corresponding event class automatically.
+*
+* @example
+* ```
+* ace make:listener UserRegistered
+* ace make:listener EmailSent --event=EmailSent
+* ace make:listener OrderCompleted --event=OrderEvent
+* ```
+*/
 var MakeListener = class extends BaseCommand {
+	/**
+	* The command name
+	*/
 	static commandName = "make:listener";
-	static description = "Create a new event listener class";
+	/**
+	* The command description
+	*/
+	static description = "Create a new event listener class in app/listeners. Use --event to also generate the event class and bind them together";
+	/**
+	* Command options configuration.
+	* Allows unknown flags to be passed through.
+	*/
 	static options = { allowUnknownFlags: true };
+	/**
+	* The stub template file to use for generating the event listener
+	*/
 	stubPath = "make/listener/main.stub";
+	/**
+	* Prepare the command by selecting the appropriate stub based on options.
+	* Uses a different stub when generating a listener for a specific event.
+	*/
 	prepare() {
 		if (this.event) this.stubPath = "make/listener/for_event.stub";
 	}
+	/**
+	* Execute the command to create a new event listener.
+	* If an event is specified, creates the event class first,
+	* then generates the listener with proper event binding.
+	*/
 	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 codemods.makeUsingStub(stubsRoot, this.stubPath, {
@@ -35,4 +74,5 @@ __decorate([flags.string({
 	alias: "e"
 })], MakeListener.prototype, "event", void 0);
 __decorate([flags.string({ description: "Use the contents of the given file as the generated output" })], MakeListener.prototype, "contentsFrom", void 0);
+//#endregion
 export { MakeListener as default };

package/build/commands/make/middleware.js

@@ -1,13 +1,39 @@
-import { t as stubsRoot } from "../../main-kn40V-hF.js";
-import stringHelpers from "../../src/helpers/string.js";
-import { f as BaseCommand, l as flags, o as args } from "../../main-MBAMnmJb.js";
-import { t as __decorate } from "../../decorate-DmrZA614.js";
+import "../../chunk-Do49iUES.js";
+import { t as stubsRoot } from "../../main-CfTiGsiS.js";
+import { t as stringHelpers } from "../../string-8_8He-HH.js";
+import { f as BaseCommand, l as flags, o as args } from "../../main-CRnMnrH7.js";
+import { t as __decorate } from "../../decorate-B9Uz0anB.js";
 import string from "@poppinss/utils/string";
 import { basename, extname, relative } from "node:path";
+//#region commands/make/middleware.ts
+/**
+* The make middleware command to create a new middleware
+* class.
+*
+* @example
+* ```
+* ace make:middleware Auth
+* ace make:middleware Auth --stack=server
+* ace make:middleware Auth --stack=named
+* ace make:middleware Auth --stack=router
+* ```
+*/
 var MakeMiddleware = class extends BaseCommand {
+	/**
+	* The command name
+	*/
 	static commandName = "make:middleware";
-	static description = "Create a new middleware class for HTTP requests";
+	/**
+	* The command description
+	*/
+	static description = "Create a new middleware class in app/middleware and register it in start/kernel.ts under the chosen stack (server, router, or named)";
+	/**
+	* Command options configuration
+	*/
 	static options = { allowUnknownFlags: true };
+	/**
+	* The stub to use for generating the middleware
+	*/
 	stubPath = "make/middleware/main.stub";
 	async run() {
 		const stackChoices = [
@@ -15,19 +41,40 @@ var MakeMiddleware = class extends BaseCommand {
 			"router",
 			"named"
 		];
+		/**
+		* Prompt to select the stack under which to register
+		* the middleware
+		*/
 		if (!this.stack) this.stack = await this.prompt.choice("Under which stack you want to register the middleware?", stackChoices);
+		/**
+		* Error out when mentioned stack is invalid
+		*/
 		if (!stackChoices.includes(this.stack)) {
 			this.exitCode = 1;
 			this.logger.error(`Invalid middleware stack "${this.stack}". Select from "${stackChoices.join(", ")}"`);
 			return;
 		}
+		/**
+		* Create middleware
+		*/
 		const codemods = await this.createCodemods();
 		const { destination } = await codemods.makeUsingStub(stubsRoot, this.stubPath, {
 			flags: this.parsed.flags,
 			entity: this.app.generators.createEntity(this.name)
 		}, { contentsFromFile: this.contentsFrom });
+		/**
+		* Creative relative path for the middleware file from
+		* the "./app/middleware" directory
+		*/
 		const middlewareRelativePath = stringHelpers.toUnixSlash(relative(this.app.middlewarePath(), destination).replace(extname(destination), ""));
+		/**
+		* Take the middleware relative path, remove `_middleware` prefix from it
+		* and convert everything to camelcase
+		*/
 		const name = string.camelCase(basename(middlewareRelativePath).replace(/_middleware$/, ""));
+		/**
+		* Register middleware
+		*/
 		await codemods.registerMiddleware(this.stack, [{
 			name,
 			path: `#middleware/${middlewareRelativePath}`
@@ -40,4 +87,5 @@ __decorate([flags.string({
 	alias: "s"
 })], MakeMiddleware.prototype, "stack", void 0);
 __decorate([flags.string({ description: "Use the contents of the given file as the generated output" })], MakeMiddleware.prototype, "contentsFrom", void 0);
+//#endregion
 export { MakeMiddleware as default };

package/build/commands/make/preload.js

@@ -1,34 +1,83 @@
-import { t as stubsRoot } from "../../main-kn40V-hF.js";
-import stringHelpers from "../../src/helpers/string.js";
-import { f as BaseCommand, l as flags, o as args } from "../../main-MBAMnmJb.js";
-import { t as __decorate } from "../../decorate-DmrZA614.js";
+import "../../chunk-Do49iUES.js";
+import { t as stubsRoot } from "../../main-CfTiGsiS.js";
+import { t as stringHelpers } from "../../string-8_8He-HH.js";
+import { f as BaseCommand, l as flags, o as args } from "../../main-CRnMnrH7.js";
+import { t as __decorate } from "../../decorate-B9Uz0anB.js";
 import { extname, relative } from "node:path";
+//#region commands/make/preload.ts
 const ALLOWED_ENVIRONMENTS = [
 	"web",
 	"console",
 	"test",
 	"repl"
 ];
+/**
+* Command to create a new preload file in the start directory.
+* Preload files are executed during application startup and can be used
+* to set up global configurations, register global bindings, or perform
+* application-wide initialization tasks.
+*
+* @example
+* ```
+* ace make:preload routes
+* ace make:preload database --register
+* ace make:preload events --no-register
+* ace make:preload kernel --environments=web,console
+* ```
+*/
 var MakePreload = class extends BaseCommand {
+	/**
+	* The command name
+	*/
 	static commandName = "make:preload";
-	static description = "Create a new preload file inside the start directory";
+	/**
+	* The command description
+	*/
+	static description = "Create a new preload file in start/ and optionally register it in adonisrc.ts. Preload files run during app boot";
+	/**
+	* The stub template file to use for generating the preload file
+	*/
 	stubPath = "make/preload/main.stub";
+	/**
+	* Validate that all specified environments are valid application environments.
+	*
+	* @returns True if all environments are valid or none specified, false otherwise
+	*/
 	#isEnvironmentsFlagValid() {
 		if (!this.environments || !this.environments.length) return true;
 		return this.environments.every((one) => ALLOWED_ENVIRONMENTS.includes(one));
 	}
+	/**
+	* Execute the command to create a new preload file.
+	* Validates inputs, generates the preload file, and optionally registers it in .adonisrc.ts.
+	*/
 	async run() {
+		/**
+		* Ensure the environments are valid when provided via flag
+		*/
 		if (!this.#isEnvironmentsFlagValid()) {
 			this.logger.error(`Invalid environment(s) "${this.environments}". Only "${ALLOWED_ENVIRONMENTS}" are allowed`);
 			return;
 		}
+		/**
+		* Display prompt to know if we should register the preload
+		* file inside the ".adonisrc.ts" file.
+		*/
 		if (this.register === void 0) this.register = await this.prompt.confirm("Do you want to register the preload file in .adonisrc.ts file?");
 		const codemods = await this.createCodemods();
 		const { destination } = await codemods.makeUsingStub(stubsRoot, this.stubPath, {
 			flags: this.parsed.flags,
 			entity: this.app.generators.createEntity(this.name)
 		}, { contentsFromFile: this.contentsFrom });
+		/**
+		* Do not register when prompt has been denied or "--no-register"
+		* flag was used
+		*/
 		if (!this.register) return;
+		/**
+		* Creative relative path for the preload file from
+		* the "./start" directory
+		*/
 		const preloadFileRelativePath = stringHelpers.toUnixSlash(relative(this.app.startPath(), destination).replace(extname(destination), ""));
 		await codemods.updateRcFile((rcFile) => {
 			rcFile.addPreloadFile(`#start/${preloadFileRelativePath}`, this.environments);
@@ -46,4 +95,5 @@ __decorate([flags.array({
 	alias: "e"
 })], MakePreload.prototype, "environments", void 0);
 __decorate([flags.string({ description: "Use the contents of the given file as the generated output" })], MakePreload.prototype, "contentsFrom", void 0);
+//#endregion
 export { MakePreload as default };

package/build/commands/make/provider.js

@@ -1,34 +1,82 @@
-import { t as stubsRoot } from "../../main-kn40V-hF.js";
-import stringHelpers from "../../src/helpers/string.js";
-import { f as BaseCommand, l as flags, o as args } from "../../main-MBAMnmJb.js";
-import { t as __decorate } from "../../decorate-DmrZA614.js";
+import "../../chunk-Do49iUES.js";
+import { t as stubsRoot } from "../../main-CfTiGsiS.js";
+import { t as stringHelpers } from "../../string-8_8He-HH.js";
+import { f as BaseCommand, l as flags, o as args } from "../../main-CRnMnrH7.js";
+import { t as __decorate } from "../../decorate-B9Uz0anB.js";
 import { extname, relative } from "node:path";
+//#region commands/make/provider.ts
 const ALLOWED_ENVIRONMENTS = [
 	"web",
 	"console",
 	"test",
 	"repl"
 ];
+/**
+* Command to create a new service provider class.
+* Service providers are used to register bindings, configure services,
+* and bootstrap application components during startup.
+*
+* @example
+* ```
+* ace make:provider AuthProvider
+* ace make:provider DatabaseProvider --register
+* ace make:provider AppProvider --no-register
+* ace make:provider CacheProvider --environments=web,console
+* ```
+*/
 var MakeProvider = class extends BaseCommand {
+	/**
+	* The command name
+	*/
 	static commandName = "make:provider";
-	static description = "Create a new service provider class";
+	/**
+	* The command description
+	*/
+	static description = "Create a new service provider in providers/ and optionally register it in adonisrc.ts. Providers register IoC container bindings";
+	/**
+	* The stub template file to use for generating the provider class
+	*/
 	stubPath = "make/provider/main.stub";
+	/**
+	* Validate that all specified environments are valid application environments.
+	*
+	* @returns True if all environments are valid or none specified, false otherwise
+	*/
 	#isEnvironmentsFlagValid() {
 		if (!this.environments || !this.environments.length) return true;
 		return this.environments.every((one) => ALLOWED_ENVIRONMENTS.includes(one));
 	}
+	/**
+	* Execute the command to create a new service provider.
+	* Validates inputs, generates the provider file, and optionally registers it in .adonisrc.ts.
+	*/
 	async run() {
+		/**
+		* Ensure the environments are valid when provided via flag
+		*/
 		if (!this.#isEnvironmentsFlagValid()) {
 			this.logger.error(`Invalid environment(s) "${this.environments}". Only "${ALLOWED_ENVIRONMENTS}" are allowed`);
 			return;
 		}
+		/**
+		* Display prompt to know if we should register the provider
+		* file inside the ".adonisrc.ts" file.
+		*/
 		if (this.register === void 0) this.register = await this.prompt.confirm("Do you want to register the provider in .adonisrc.ts file?");
 		const codemods = await this.createCodemods();
 		const { destination } = await codemods.makeUsingStub(stubsRoot, this.stubPath, {
 			flags: this.parsed.flags,
 			entity: this.app.generators.createEntity(this.name)
 		}, { contentsFromFile: this.contentsFrom });
+		/**
+		* Do not register when prompt has been denied or "--no-register"
+		* flag was used
+		*/
 		if (!this.register) return;
+		/**
+		* Creative relative path for the provider file from
+		* the "./start" directory
+		*/
 		const providerRelativePath = stringHelpers.toUnixSlash(relative(this.app.providersPath(), destination).replace(extname(destination), ""));
 		await codemods.updateRcFile((rcFile) => {
 			rcFile.addProvider(`#providers/${providerRelativePath}`, this.environments);
@@ -46,4 +94,5 @@ __decorate([flags.array({
 	alias: "e"
 })], MakeProvider.prototype, "environments", void 0);
 __decorate([flags.string({ description: "Use the contents of the given file as the generated output" })], MakeProvider.prototype, "contentsFrom", void 0);
+//#endregion
 export { MakeProvider as default };

package/build/commands/make/service.js

@@ -1,10 +1,34 @@
-import { t as stubsRoot } from "../../main-kn40V-hF.js";
-import { f as BaseCommand, l as flags, o as args } from "../../main-MBAMnmJb.js";
-import { t as __decorate } from "../../decorate-DmrZA614.js";
+import "../../chunk-Do49iUES.js";
+import { t as stubsRoot } from "../../main-CfTiGsiS.js";
+import { f as BaseCommand, l as flags, o as args } from "../../main-CRnMnrH7.js";
+import { t as __decorate } from "../../decorate-B9Uz0anB.js";
+//#region commands/make/service.ts
+/**
+* Make a new service class
+*
+* @example
+* ```
+* ace make:service UserService
+* ace make:service AuthService
+* ace make:service User/ProfileService
+* ```
+*/
 var MakeService = class extends BaseCommand {
+	/**
+	* The command name
+	*/
 	static commandName = "make:service";
-	static description = "Create a new service class";
+	/**
+	* The command description
+	*/
+	static description = "Create a new service class in app/services. Services encapsulate reusable business logic outside of controllers";
+	/**
+	* Command options configuration
+	*/
 	static options = { allowUnknownFlags: true };
+	/**
+	* The stub to use for generating the service class
+	*/
 	stubPath = "make/service/main.stub";
 	async run() {
 		await (await this.createCodemods()).makeUsingStub(stubsRoot, this.stubPath, {
@@ -15,4 +39,5 @@ var MakeService = class extends BaseCommand {
 };
 __decorate([args.string({ description: "Name of the service" })], MakeService.prototype, "name", void 0);
 __decorate([flags.string({ description: "Use the contents of the given file as the generated output" })], MakeService.prototype, "contentsFrom", void 0);
+//#endregion
 export { MakeService as default };

package/build/commands/make/test.js

@@ -1,33 +1,91 @@
-import { t as stubsRoot } from "../../main-kn40V-hF.js";
-import { f as BaseCommand, l as flags, o as args } from "../../main-MBAMnmJb.js";
-import { t as __decorate } from "../../decorate-DmrZA614.js";
+import "../../chunk-Do49iUES.js";
+import { t as stubsRoot } from "../../main-CfTiGsiS.js";
+import { f as BaseCommand, l as flags, o as args } from "../../main-CRnMnrH7.js";
+import { t as __decorate } from "../../decorate-B9Uz0anB.js";
+//#region commands/make/test.ts
+/**
+* Command to create a new Japa test file.
+* Supports multiple test suites and automatically detects or prompts for
+* the appropriate suite and directory based on application configuration.
+*
+* @example
+* ```
+* ace make:test UserController
+* ace make:test UserModel --suite=unit
+* ace make:test AuthService --suite=integration
+* ```
+*/
 var MakeTest = class extends BaseCommand {
+	/**
+	* The command name
+	*/
 	static commandName = "make:test";
-	static description = "Create a new Japa test file";
+	/**
+	* The command description
+	*/
+	static description = "Create a new Japa test file in tests/. Use --suite to specify the test suite (unit, functional, etc.)";
+	/**
+	* The stub template file to use for generating the test file
+	*/
 	stubPath = "make/test/main.stub";
+	/**
+	* Determine the test suite name for creating the test file.
+	* Uses the provided suite flag, or automatically selects if only one suite exists,
+	* or prompts the user to choose from available suites.
+	*
+	* @returns The name of the selected test suite
+	*/
 	async #getSuite() {
 		if (this.suite) return this.suite;
+		/**
+		* Use the first suite from the rcFile when there is only
+		* one suite
+		*/
 		const rcFileSuites = this.app.rcFile.tests.suites;
 		if (rcFileSuites.length === 1) return rcFileSuites[0].name;
+		/**
+		* Prompt the user to select a suite manually
+		*/
 		return this.prompt.choice("Select the suite for the test file", this.app.rcFile.tests.suites.map((suite) => {
 			return suite.name;
 		}), { validate(choice) {
 			return choice ? true : "Please select a suite";
 		} });
 	}
+	/**
+	* Determine the directory path for the test file within the selected suite.
+	* Automatically selects if only one directory exists, otherwise prompts the user.
+	*
+	* @param directories - Array of available directories for the suite
+	* @returns The selected directory path
+	*/
 	async #getSuiteDirectory(directories) {
 		if (directories.length === 1) return directories[0];
 		return this.prompt.choice("Select directory for the test file", directories, { validate(choice) {
 			return choice ? true : "Please select a directory";
 		} });
 	}
+	/**
+	* Find suite configuration from the RC file by name.
+	*
+	* @param suiteName - The name of the suite to find
+	* @returns The suite configuration or undefined if not found
+	*/
 	#findSuite(suiteName) {
 		return this.app.rcFile.tests.suites.find((suite) => {
 			return suite.name === suiteName;
 		});
 	}
+	/**
+	* Execute the command to create a new test file.
+	* Validates the suite exists, prompts for missing information,
+	* and generates the test file in the appropriate location.
+	*/
 	async run() {
 		const suite = this.#findSuite(await this.#getSuite());
+		/**
+		* Show error when mentioned/selected suite does not exist
+		*/
 		if (!suite) {
 			this.logger.error(`The "${this.suite}" suite is not configured inside the "adonisrc.js" file`);
 			this.exitCode = 1;
@@ -46,4 +104,5 @@ __decorate([flags.string({
 	alias: "s"
 })], MakeTest.prototype, "suite", void 0);
 __decorate([flags.string({ description: "Use the contents of the given file as the generated output" })], MakeTest.prototype, "contentsFrom", void 0);
+//#endregion
 export { MakeTest as default };