@adonisjs/core 7.0.0-next.1 → 7.0.0-next.11

package/build/modules/ace/codemods.js

@@ -1,374 +1,222 @@
-/*
- * @adonisjs/core
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { EventEmitter } from 'node:events';
-import { EnvEditor } from '@adonisjs/env/editor';
-import stringHelpers from "../../src/helpers/string.js";
-/**
- * Codemods class for programmatically modifying AdonisJS source files.
- * This class provides APIs to modify configuration files, register middleware,
- * generate stubs, and install packages.
- *
- * The codemod APIs rely on the "@adonisjs/assembler" package, which must be
- * installed as a dependency in the user application.
- *
- * @example
- * ```ts
- * const codemods = new Codemods(app, logger)
- *
- * // Generate a controller from a stub
- * await codemods.makeUsingStub(stubsRoot, 'controller.stub', {
- *   filename: 'UserController',
- *   entity: { name: 'User' }
- * })
- *
- * // Install packages
- * await codemods.installPackages([
- *   { name: '@adonisjs/lucid', isDevDependency: false }
- * ])
- * ```
- */
-export class Codemods extends EventEmitter {
-    /**
-     * Reference to lazily imported assembler code transformer
-     */
-    #codeTransformer;
-    /**
-     * Reference to AdonisJS application
-     */
-    #app;
-    /**
-     * Reference to CLI logger to write logs
-     */
-    #cliLogger;
-    /**
-     * Overwrite existing files when generating files
-     * from stubs
-     */
-    overwriteExisting = false;
-    /**
-     * Display verbose logs for package installation
-     */
-    verboseInstallOutput = false;
-    constructor(app, cliLogger) {
-        super();
-        this.#app = app;
-        this.#cliLogger = cliLogger;
-    }
-    /**
-     * - Lazily import the code transformer
-     * - Return a fresh or reused instance of the code transformer
-     */
-    async #getCodeTransformer() {
-        try {
-            if (!this.#codeTransformer) {
-                const { CodeTransformer } = await import('@adonisjs/assembler/code_transformer');
-                this.#codeTransformer = new CodeTransformer(this.#app.appRoot);
-            }
-            return this.#codeTransformer;
-        }
-        catch {
-            return null;
-        }
-    }
-    /**
-     * Returns the installation command for different
-     * package managers
-     */
-    #getInstallationCommands(packages, packageManager, isDev) {
-        if (!packages.length) {
-            return '';
-        }
-        const colors = this.#cliLogger.getColors();
-        const devFlag = isDev ? ' -D' : '';
-        switch (packageManager) {
-            case 'yarn':
-            case 'yarn@berry':
-                return `${colors.yellow(`yarn add${devFlag}`)} ${packages.join(' ')}`;
-            case 'pnpm':
-                return `${colors.yellow(`pnpm add${devFlag}`)} ${packages.join(' ')}`;
-            case 'npm':
-            default:
-                return `${colors.yellow(`npm i${devFlag}`)} ${packages.join(' ')}`;
-        }
-    }
-    /**
-     * Define one or more environment variables in the .env file
-     *
-     * @param environmentVariables - Key-value pairs of environment variables
-     * @param options - Configuration options
-     * @param options.omitFromExample - Keys to exclude from .env.example file
-     *
-     * @example
-     * ```ts
-     * await codemods.defineEnvVariables({
-     *   DB_CONNECTION: 'mysql',
-     *   DB_HOST: 'localhost',
-     *   SECRET_KEY: 'abc123'
-     * }, {
-     *   omitFromExample: ['SECRET_KEY']
-     * })
-     * ```
-     */
-    async defineEnvVariables(environmentVariables, options) {
-        const editor = new EnvEditor(this.#app.appRoot);
-        await editor.load();
-        Object.keys(environmentVariables).forEach((key) => {
-            const value = environmentVariables[key];
-            editor.add(key, value, options?.omitFromExample?.includes(key));
-        });
-        await editor.save();
-        this.#cliLogger.action('update .env file').succeeded();
-    }
-    /**
-     * Returns the TsMorph project instance for advanced AST manipulations.
-     * See https://ts-morph.com/ for documentation.
-     *
-     * @example
-     * ```ts
-     * const project = await codemods.getTsMorphProject()
-     * if (project) {
-     *   const sourceFile = project.getSourceFile('app/controllers/user_controller.ts')
-     *   // Perform advanced AST operations
-     * }
-     * ```
-     */
-    async getTsMorphProject() {
-        const transformer = await this.#getCodeTransformer();
-        if (!transformer) {
-            this.#cliLogger.warning('Cannot create CodeTransformer. Install "@adonisjs/assembler" to modify source files');
-            return;
-        }
-        return transformer.project;
-    }
-    /**
-     * Define validations for the environment variables
-     */
-    async defineEnvValidations(validations) {
-        const transformer = await this.#getCodeTransformer();
-        if (!transformer) {
-            this.#cliLogger.warning('Cannot update "start/env.ts" file. Install "@adonisjs/assembler" to modify source files');
-            return;
-        }
-        const action = this.#cliLogger.action('update start/env.ts file');
-        try {
-            await transformer.defineEnvValidations(validations);
-            action.succeeded();
-        }
-        catch (error) {
-            this.emit('error', error);
-            action.failed(error.message);
-        }
-    }
-    /**
-     * Define validations for the environment variables
-     */
-    async registerMiddleware(stack, middleware) {
-        const transformer = await this.#getCodeTransformer();
-        if (!transformer) {
-            this.#cliLogger.warning('Cannot update "start/kernel.ts" file. Install "@adonisjs/assembler" to modify source files');
-            return;
-        }
-        const action = this.#cliLogger.action('update start/kernel.ts file');
-        try {
-            await transformer.addMiddlewareToStack(stack, middleware);
-            action.succeeded();
-        }
-        catch (error) {
-            this.emit('error', error);
-            action.failed(error.message);
-        }
-    }
-    /**
-     * Register bouncer policies to the list of policies
-     * collection exported from the "app/policies/main.ts"
-     * file.
-     */
-    async registerPolicies(policies) {
-        const transformer = await this.#getCodeTransformer();
-        if (!transformer) {
-            this.#cliLogger.warning('Cannot update "app/policies/main.ts" file. Install "@adonisjs/assembler" to modify source files');
-            return;
-        }
-        const action = this.#cliLogger.action('update app/policies/main.ts file');
-        try {
-            await transformer.addPolicies(policies);
-            action.succeeded();
-        }
-        catch (error) {
-            this.emit('error', error);
-            action.failed(error.message);
-        }
-    }
-    /**
-     * Update RCFile
-     */
-    async updateRcFile(...params) {
-        const transformer = await this.#getCodeTransformer();
-        if (!transformer) {
-            this.#cliLogger.warning('Cannot update "adonisrc.ts" file. Install "@adonisjs/assembler" to modify source files');
-            return;
-        }
-        const action = this.#cliLogger.action('update adonisrc.ts file');
-        try {
-            await transformer.updateRcFile(...params);
-            action.succeeded();
-        }
-        catch (error) {
-            this.emit('error', error);
-            action.failed(error.message);
-        }
-    }
-    /**
-     * Register a new Vite plugin in the `vite.config.ts` file
-     */
-    async registerVitePlugin(...params) {
-        const transformer = await this.#getCodeTransformer();
-        if (!transformer) {
-            this.#cliLogger.warning('Cannot update "vite.config.ts" file. Install "@adonisjs/assembler" to modify source files');
-            return;
-        }
-        const action = this.#cliLogger.action('update vite.config.ts file');
-        try {
-            await transformer.addVitePlugin(...params);
-            action.succeeded();
-        }
-        catch (error) {
-            this.emit('error', error);
-            action.failed(error.message);
-        }
-    }
-    /**
-     * Register a new Japa plugin in the `tests/bootstrap.ts` file
-     */
-    async registerJapaPlugin(...params) {
-        const transformer = await this.#getCodeTransformer();
-        if (!transformer) {
-            this.#cliLogger.warning('Cannot update "tests/bootstrap.ts" file. Install "@adonisjs/assembler" to modify source files');
-            return;
-        }
-        const action = this.#cliLogger.action('update tests/bootstrap.ts file');
-        try {
-            await transformer.addJapaPlugin(...params);
-            action.succeeded();
-        }
-        catch (error) {
-            this.emit('error', error);
-            action.failed(error.message);
-        }
-    }
-    /**
-     * Generate a file using a stub template
-     *
-     * @param stubsRoot - Root directory containing stub files
-     * @param stubPath - Path to the specific stub file
-     * @param stubState - Template variables for stub generation
-     *
-     * @example
-     * ```ts
-     * const result = await codemods.makeUsingStub(
-     *   './stubs',
-     *   'controller.stub',
-     *   {
-     *     filename: 'UserController',
-     *     entity: { name: 'User', modelName: 'User' },
-     *     resourceful: true
-     *   }
-     * )
-     * ```
-     */
-    async makeUsingStub(stubsRoot, stubPath, stubState) {
-        const stubs = await this.#app.stubs.create();
-        const stub = await stubs.build(stubPath, { source: stubsRoot });
-        const output = await stub.generate({ force: this.overwriteExisting, ...stubState });
-        const entityFileName = stringHelpers.toUnixSlash(this.#app.relativePath(output.destination));
-        const result = { ...output, relativeFileName: entityFileName };
-        if (output.status === 'skipped') {
-            this.#cliLogger.action(`create ${entityFileName}`).skipped(output.skipReason);
-            return result;
-        }
-        this.#cliLogger.action(`create ${entityFileName}`).succeeded();
-        return result;
-    }
-    /**
-     * Install packages using the correct package manager
-     * You can specify version of each package by setting it in the
-     * name like :
-     *
-     * ```
-     * this.installPackages([{ name: '@adonisjs/lucid@next', isDevDependency: false }])
-     * ```
-     */
-    async installPackages(packages, packageManager) {
-        const transformer = await this.#getCodeTransformer();
-        const appPath = this.#app.makePath();
-        const colors = this.#cliLogger.getColors();
-        const devDependencies = packages.filter((pkg) => pkg.isDevDependency).map(({ name }) => name);
-        const dependencies = packages.filter((pkg) => !pkg.isDevDependency).map(({ name }) => name);
-        if (!transformer) {
-            this.#cliLogger.warning('Cannot install packages. Install "@adonisjs/assembler" or manually install following packages');
-            this.#cliLogger.log(`devDependencies: ${devDependencies.join(',')}`);
-            this.#cliLogger.log(`dependencies: ${dependencies.join(',')}`);
-            return false;
-        }
-        packageManager = packageManager ?? (await transformer.detectPackageManager(appPath)) ?? 'npm';
-        const spinner = this.#cliLogger.await(`installing dependencies using ${packageManager} `);
-        const silentLogs = !this.verboseInstallOutput;
-        if (silentLogs) {
-            spinner.start();
-        }
-        try {
-            if (dependencies.length) {
-                await transformer.installPackage(dependencies, {
-                    cwd: appPath,
-                    silent: silentLogs,
-                    packageManager,
-                });
-            }
-            if (devDependencies.length) {
-                await transformer.installPackage(devDependencies, {
-                    dev: true,
-                    cwd: appPath,
-                    silent: silentLogs,
-                    packageManager,
-                });
-            }
-            if (silentLogs) {
-                spinner.stop();
-            }
-            this.#cliLogger.success('Packages installed');
-            this.#cliLogger.log(devDependencies.map((dependency) => `    ${colors.dim('dev')} ${dependency} `).join('\n'));
-            this.#cliLogger.log(dependencies.map((dependency) => `    ${colors.dim('prod')} ${dependency} `).join('\n'));
-            return true;
-        }
-        catch (error) {
-            if (silentLogs) {
-                spinner.update('unable to install dependencies');
-                spinner.stop();
-            }
-            this.#cliLogger.fatal(error);
-            this.emit('error', error);
-            return false;
-        }
-    }
-    /**
-     * List the packages one should install before using the packages
-     */
-    async listPackagesToInstall(packages) {
-        const appPath = this.#app.makePath();
-        const devDependencies = packages.filter((pkg) => pkg.isDevDependency).map(({ name }) => name);
-        const dependencies = packages.filter((pkg) => !pkg.isDevDependency).map(({ name }) => name);
-        let packageManager = null;
-        const transformer = await this.#getCodeTransformer();
-        if (transformer)
-            packageManager = await transformer.detectPackageManager(appPath);
-        this.#cliLogger.log('Please install following packages');
-        this.#cliLogger.log(this.#getInstallationCommands(devDependencies, packageManager || 'npm', true));
-        this.#cliLogger.log(this.#getInstallationCommands(dependencies, packageManager || 'npm', false));
-    }
-}
+import { t as string_default } from "../../string-CJ7ewUFq.js";
+import { EnvEditor } from "@adonisjs/env/editor";
+import { EventEmitter } from "node:events";
+var Codemods = class extends EventEmitter {
+	#codeTransformer;
+	#app;
+	#cliLogger;
+	overwriteExisting = false;
+	verboseInstallOutput = false;
+	constructor(app, cliLogger) {
+		super();
+		this.#app = app;
+		this.#cliLogger = cliLogger;
+	}
+	async #getCodeTransformer() {
+		try {
+			if (!this.#codeTransformer) {
+				const { CodeTransformer } = await import("@adonisjs/assembler/code_transformer");
+				this.#codeTransformer = new CodeTransformer(this.#app.appRoot);
+			}
+			return this.#codeTransformer;
+		} catch {
+			return null;
+		}
+	}
+	#getInstallationCommands(packages, packageManager, isDev) {
+		if (!packages.length) return "";
+		const colors = this.#cliLogger.getColors();
+		const devFlag = isDev ? " -D" : "";
+		switch (packageManager) {
+			case "yarn":
+			case "yarn@berry": return `${colors.yellow(`yarn add${devFlag}`)} ${packages.join(" ")}`;
+			case "pnpm": return `${colors.yellow(`pnpm add${devFlag}`)} ${packages.join(" ")}`;
+			case "npm":
+			default: return `${colors.yellow(`npm i${devFlag}`)} ${packages.join(" ")}`;
+		}
+	}
+	async defineEnvVariables(environmentVariables, options) {
+		const editor = new EnvEditor(this.#app.appRoot);
+		await editor.load();
+		Object.keys(environmentVariables).forEach((key) => {
+			const value = environmentVariables[key];
+			editor.add(key, value, options?.omitFromExample?.includes(key));
+		});
+		await editor.save();
+		this.#cliLogger.action("update .env file").succeeded();
+	}
+	async getTsMorphProject() {
+		const transformer = await this.#getCodeTransformer();
+		if (!transformer) {
+			this.#cliLogger.warning("Cannot create CodeTransformer. Install \"@adonisjs/assembler\" to modify source files");
+			return;
+		}
+		return transformer.project;
+	}
+	async defineEnvValidations(validations) {
+		const transformer = await this.#getCodeTransformer();
+		if (!transformer) {
+			this.#cliLogger.warning("Cannot update \"start/env.ts\" file. Install \"@adonisjs/assembler\" to modify source files");
+			return;
+		}
+		const action = this.#cliLogger.action("update start/env.ts file");
+		try {
+			await transformer.defineEnvValidations(validations);
+			action.succeeded();
+		} catch (error) {
+			this.emit("error", error);
+			action.failed(error.message);
+		}
+	}
+	async registerMiddleware(stack, middleware) {
+		const transformer = await this.#getCodeTransformer();
+		if (!transformer) {
+			this.#cliLogger.warning("Cannot update \"start/kernel.ts\" file. Install \"@adonisjs/assembler\" to modify source files");
+			return;
+		}
+		const action = this.#cliLogger.action("update start/kernel.ts file");
+		try {
+			await transformer.addMiddlewareToStack(stack, middleware);
+			action.succeeded();
+		} catch (error) {
+			this.emit("error", error);
+			action.failed(error.message);
+		}
+	}
+	async registerPolicies(policies) {
+		const transformer = await this.#getCodeTransformer();
+		if (!transformer) {
+			this.#cliLogger.warning("Cannot update \"app/policies/main.ts\" file. Install \"@adonisjs/assembler\" to modify source files");
+			return;
+		}
+		const action = this.#cliLogger.action("update app/policies/main.ts file");
+		try {
+			await transformer.addPolicies(policies);
+			action.succeeded();
+		} catch (error) {
+			this.emit("error", error);
+			action.failed(error.message);
+		}
+	}
+	async updateRcFile(...params) {
+		const transformer = await this.#getCodeTransformer();
+		if (!transformer) {
+			this.#cliLogger.warning("Cannot update \"adonisrc.ts\" file. Install \"@adonisjs/assembler\" to modify source files");
+			return;
+		}
+		const action = this.#cliLogger.action("update adonisrc.ts file");
+		try {
+			await transformer.updateRcFile(...params);
+			action.succeeded();
+		} catch (error) {
+			this.emit("error", error);
+			action.failed(error.message);
+		}
+	}
+	async registerVitePlugin(...params) {
+		const transformer = await this.#getCodeTransformer();
+		if (!transformer) {
+			this.#cliLogger.warning("Cannot update \"vite.config.ts\" file. Install \"@adonisjs/assembler\" to modify source files");
+			return;
+		}
+		const action = this.#cliLogger.action("update vite.config.ts file");
+		try {
+			await transformer.addVitePlugin(...params);
+			action.succeeded();
+		} catch (error) {
+			this.emit("error", error);
+			action.failed(error.message);
+		}
+	}
+	async registerJapaPlugin(...params) {
+		const transformer = await this.#getCodeTransformer();
+		if (!transformer) {
+			this.#cliLogger.warning("Cannot update \"tests/bootstrap.ts\" file. Install \"@adonisjs/assembler\" to modify source files");
+			return;
+		}
+		const action = this.#cliLogger.action("update tests/bootstrap.ts file");
+		try {
+			await transformer.addJapaPlugin(...params);
+			action.succeeded();
+		} catch (error) {
+			this.emit("error", error);
+			action.failed(error.message);
+		}
+	}
+	async makeUsingStub(stubsRoot, stubPath, stubState) {
+		const output = await (await (await this.#app.stubs.create()).build(stubPath, { source: stubsRoot })).generate({
+			force: this.overwriteExisting,
+			...stubState
+		});
+		const entityFileName = string_default.toUnixSlash(this.#app.relativePath(output.destination));
+		const result = {
+			...output,
+			relativeFileName: entityFileName
+		};
+		if (output.status === "skipped") {
+			this.#cliLogger.action(`create ${entityFileName}`).skipped(output.skipReason);
+			return result;
+		}
+		this.#cliLogger.action(`create ${entityFileName}`).succeeded();
+		return result;
+	}
+	async installPackages(packages, packageManager) {
+		const transformer = await this.#getCodeTransformer();
+		const appPath = this.#app.makePath();
+		const colors = this.#cliLogger.getColors();
+		const devDependencies = packages.filter((pkg) => pkg.isDevDependency).map(({ name }) => {
+			return name.startsWith("@adonisjs/") ? `${name}@next` : name;
+		});
+		const dependencies = packages.filter((pkg) => !pkg.isDevDependency).map(({ name }) => {
+			return name.startsWith("@adonisjs/") ? `${name}@next` : name;
+		});
+		if (!transformer) {
+			this.#cliLogger.warning("Cannot install packages. Install \"@adonisjs/assembler\" or manually install following packages");
+			this.#cliLogger.log(`devDependencies: ${devDependencies.join(",")}`);
+			this.#cliLogger.log(`dependencies: ${dependencies.join(",")}`);
+			return false;
+		}
+		packageManager = packageManager ?? await transformer.detectPackageManager(appPath) ?? "npm";
+		const spinner = this.#cliLogger.await(`installing dependencies using ${packageManager} `);
+		const silentLogs = !this.verboseInstallOutput;
+		if (silentLogs) spinner.start();
+		try {
+			if (dependencies.length) await transformer.installPackage(dependencies, {
+				cwd: appPath,
+				silent: silentLogs,
+				packageManager
+			});
+			if (devDependencies.length) await transformer.installPackage(devDependencies, {
+				dev: true,
+				cwd: appPath,
+				silent: silentLogs,
+				packageManager
+			});
+			if (silentLogs) spinner.stop();
+			this.#cliLogger.success("Packages installed");
+			this.#cliLogger.log(devDependencies.map((dependency) => `    ${colors.dim("dev")} ${dependency} `).join("\n"));
+			this.#cliLogger.log(dependencies.map((dependency) => `    ${colors.dim("prod")} ${dependency} `).join("\n"));
+			return true;
+		} catch (error) {
+			if (silentLogs) {
+				spinner.update("unable to install dependencies");
+				spinner.stop();
+			}
+			this.#cliLogger.fatal(error);
+			this.emit("error", error);
+			return false;
+		}
+	}
+	async listPackagesToInstall(packages) {
+		const appPath = this.#app.makePath();
+		const devDependencies = packages.filter((pkg) => pkg.isDevDependency).map(({ name }) => name);
+		const dependencies = packages.filter((pkg) => !pkg.isDevDependency).map(({ name }) => name);
+		let packageManager = null;
+		const transformer = await this.#getCodeTransformer();
+		if (transformer) packageManager = await transformer.detectPackageManager(appPath);
+		this.#cliLogger.log("Please install following packages");
+		this.#cliLogger.log(this.#getInstallationCommands(devDependencies, packageManager || "npm", true));
+		this.#cliLogger.log(this.#getInstallationCommands(dependencies, packageManager || "npm", false));
+	}
+};
+export { Codemods };

package/build/modules/ace/main.d.ts

@@ -1,3 +1,33 @@
+/**
+ * Ace command line interface module for AdonisJS applications.
+ * Provides the kernel, base commands, and utilities for building CLI applications.
+ *
+ * @example
+ * // Create and use the Ace kernel
+ * import { Kernel, BaseCommand } from '@adonisjs/core/ace'
+ *
+ * const kernel = new Kernel(app)
+ * await kernel.handle(['make:controller', 'UserController'])
+ *
+ * @example
+ * // Create a custom command
+ * import { BaseCommand, args, flags } from '@adonisjs/core/ace'
+ *
+ * export default class MakeUser extends BaseCommand {
+ *   static commandName = 'make:user'
+ *   static description = 'Create a new user'
+ *
+ *   @args.string({ description: 'Name of the user' })
+ *   declare name: string
+ *
+ *   @flags.boolean({ description: 'Create admin user' })
+ *   declare admin: boolean
+ *
+ *   async run() {
+ *     this.logger.info(`Creating user: ${this.name}`)
+ *   }
+ * }
+ */
 export { Kernel } from './kernel.ts';
 export { BaseCommand, ListCommand } from './commands.ts';
 export { args, flags, errors, Parser, FsLoader, ListLoader, cliHelpers, HelpCommand, IndexGenerator, tracingChannels, } from '@adonisjs/ace';

package/build/modules/ace/main.js

@@ -1,11 +1,2 @@
-/*
- * @adonisjs/core
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-export { Kernel } from "./kernel.js";
-export { BaseCommand, ListCommand } from "./commands.js";
-export { args, flags, errors, Parser, FsLoader, ListLoader, cliHelpers, HelpCommand, IndexGenerator, tracingChannels, } from '@adonisjs/ace';
+import { a as Parser, c as errors, d as Kernel, f as BaseCommand, i as ListLoader, l as flags, n as HelpCommand, o as args, p as ListCommand, r as IndexGenerator, s as cliHelpers, t as FsLoader, u as tracingChannels } from "../../main-Cn_x9YY5.js";
+export { BaseCommand, FsLoader, HelpCommand, IndexGenerator, Kernel, ListCommand, ListLoader, Parser, args, cliHelpers, errors, flags, tracingChannels };