@adonisjs/assembler 8.0.0 → 8.1.0

package/build/chunk-DF48asd8.js

@@ -0,0 +1,9 @@
+import "node:module";
+Object.create;
+Object.defineProperty;
+Object.getOwnPropertyDescriptor;
+Object.getOwnPropertyNames;
+Object.getPrototypeOf;
+Object.prototype.hasOwnProperty;
+//#endregion
+export {};

package/build/{codemod_exception-CzQgXAAf.js → codemod_exception-BMNJZ0i1.js}

@@ -1,5 +1,23 @@
+//#region src/exceptions/codemod_exception.ts
+/**
+* Custom exception for codemod errors that provides helpful instructions
+* to the user when automatic code transformation fails.
+*
+* @example
+* ```ts
+* throw CodemodException.missingEnvFile('start/env.ts', {
+*   variables: { MY_VAR: 'Env.schema.string()' }
+* })
+* ```
+*/
 var CodemodException = class CodemodException extends Error {
+	/**
+	* Instructions for the user to manually perform the codemod action
+	*/
 	instructions;
+	/**
+	* The file path that was being modified
+	*/
 	filePath;
 	constructor(message, options) {
 		super(message);
@@ -7,6 +25,9 @@ var CodemodException = class CodemodException extends Error {
 		this.instructions = options?.instructions;
 		this.filePath = options?.filePath;
 	}
+	/**
+	* Format env validations as code string
+	*/
 	static #formatEnvValidations(definition) {
 		const lines = [];
 		if (definition.leadingComment) {
@@ -19,19 +40,37 @@ var CodemodException = class CodemodException extends Error {
 		for (const [variable, validation] of Object.entries(definition.variables)) lines.push(`${variable}: ${validation},`);
 		return lines.join("\n");
 	}
+	/**
+	* Format middleware as code string
+	*/
 	static #formatMiddleware(stack, middleware) {
 		if (stack === "named") return `export const middleware = router.named({\n  ${middleware.filter((m) => m.name).map((m) => `${m.name}: () => import('${m.path}')`).join(",\n  ")}\n})`;
 		return `${stack}.use([\n  ${middleware.map((m) => `() => import('${m.path}')`).join(",\n  ")}\n])`;
 	}
+	/**
+	* Format policies as code string
+	*/
 	static #formatPolicies(policies) {
 		return `export const policies = {\n  ${policies.map((p) => `${p.name}: () => import('${p.path}')`).join(",\n  ")}\n}`;
 	}
+	/**
+	* Format Vite plugin as code string
+	*/
 	static #formatVitePlugin(pluginCall, importDeclarations) {
 		return `${importDeclarations.map((decl) => decl.isNamed ? `import { ${decl.identifier} } from '${decl.module}'` : `import ${decl.identifier} from '${decl.module}'`).join("\n")}\n\nexport default defineConfig({\n  plugins: [${pluginCall}]\n})`;
 	}
+	/**
+	* Format Japa plugin as code string
+	*/
 	static #formatJapaPlugin(pluginCall, importDeclarations) {
 		return `${importDeclarations.map((decl) => decl.isNamed ? `import { ${decl.identifier} } from '${decl.module}'` : `import ${decl.identifier} from '${decl.module}'`).join("\n")}\n\nexport const plugins: Config['plugins'] = [\n  ${pluginCall}\n]`;
 	}
+	/**
+	* Creates an exception when start/env.ts file is missing
+	*
+	* @param filePath - The path to the missing file
+	* @param definition - The environment validation definition that was being added
+	*/
 	static missingEnvFile(filePath, definition) {
 		const code = this.#formatEnvValidations(definition);
 		return new CodemodException(`Could not find source file at path: "${filePath}"`, {
@@ -39,18 +78,37 @@ var CodemodException = class CodemodException extends Error {
 			instructions: `Add the following code to "${filePath}":\n\n${code}`
 		});
 	}
+	/**
+	* Creates an exception when Env.create is not found in the file
+	*
+	* @param filePath - The path to the file being modified
+	* @param definition - The environment validation definition that was being added
+	*/
 	static missingEnvCreate(filePath, definition) {
 		return new CodemodException(`Cannot find Env.create statement in the file.`, {
 			filePath,
 			instructions: `Add the following code inside Env.create() in "${filePath}":\n\n${this.#formatEnvValidations(definition)}`
 		});
 	}
+	/**
+	* Creates an exception when Env.create has invalid structure
+	*
+	* @param filePath - The path to the file being modified
+	* @param definition - The environment validation definition that was being added
+	*/
 	static invalidEnvCreate(filePath, definition) {
 		return new CodemodException(`The second argument of Env.create is not an object literal.`, {
 			filePath,
 			instructions: `Add the following code inside Env.create() in "${filePath}":\n\n${this.#formatEnvValidations(definition)}`
 		});
 	}
+	/**
+	* Creates an exception when start/kernel.ts file is missing
+	*
+	* @param filePath - The path to the missing file
+	* @param stack - The middleware stack that was being modified
+	* @param middleware - The middleware entries that were being added
+	*/
 	static missingKernelFile(filePath, stack, middleware) {
 		const code = this.#formatMiddleware(stack, middleware);
 		return new CodemodException(`Could not find source file at path: "${filePath}"`, {
@@ -58,6 +116,13 @@ var CodemodException = class CodemodException extends Error {
 			instructions: `Add the following code to "${filePath}":\n\n${code}`
 		});
 	}
+	/**
+	* Creates an exception when server.use/router.use is not found
+	*
+	* @param filePath - The path to the file being modified
+	* @param stack - The middleware stack that was being modified
+	* @param middleware - The middleware entries that were being added
+	*/
 	static missingMiddlewareStack(filePath, stack, middleware) {
 		const code = this.#formatMiddleware(stack, middleware);
 		return new CodemodException(`Cannot find ${stack === "named" ? "middleware variable" : `${stack}.use`} statement in the file.`, {
@@ -65,12 +130,26 @@ var CodemodException = class CodemodException extends Error {
 			instructions: `Add the following code to "${filePath}":\n\n${code}`
 		});
 	}
+	/**
+	* Creates an exception when middleware array structure is invalid
+	*
+	* @param filePath - The path to the file being modified
+	* @param stack - The middleware stack that was being modified
+	* @param middleware - The middleware entries that were being added
+	* @param reason - The reason why the structure is invalid
+	*/
 	static invalidMiddlewareStack(filePath, stack, middleware, reason) {
 		return new CodemodException(reason, {
 			filePath,
 			instructions: `Add the following code to "${filePath}":\n\n${this.#formatMiddleware(stack, middleware)}`
 		});
 	}
+	/**
+	* Creates an exception when app/policies/main.ts file is missing
+	*
+	* @param filePath - The path to the missing file
+	* @param policies - The policies that were being added
+	*/
 	static missingPoliciesFile(filePath, policies) {
 		const code = this.#formatPolicies(policies);
 		return new CodemodException(`Could not find source file at path: "${filePath}"`, {
@@ -78,24 +157,53 @@ var CodemodException = class CodemodException extends Error {
 			instructions: `Add the following code to "${filePath}":\n\n${code}`
 		});
 	}
+	/**
+	* Creates an exception when policies structure is invalid
+	*
+	* @param filePath - The path to the file being modified
+	* @param policies - The policies that were being added
+	* @param reason - The reason why the structure is invalid
+	*/
 	static invalidPoliciesFile(filePath, policies, reason) {
 		return new CodemodException(reason, {
 			filePath,
 			instructions: `Add the following code to "${filePath}":\n\n${this.#formatPolicies(policies)}`
 		});
 	}
+	/**
+	* Creates an exception when vite.config.ts file is missing
+	*
+	* @param filePath - The path to the missing file
+	* @param pluginCall - The plugin call that was being added
+	* @param importDeclarations - The import declarations needed for the plugin
+	*/
 	static missingViteConfig(filePath, pluginCall, importDeclarations) {
 		return new CodemodException(`Cannot find vite.config.ts file. Make sure to rename vite.config.js to vite.config.ts`, {
 			filePath,
 			instructions: `Add the following code to "${filePath}":\n\n${this.#formatVitePlugin(pluginCall, importDeclarations)}`
 		});
 	}
+	/**
+	* Creates an exception when vite.config.ts structure is invalid
+	*
+	* @param filePath - The path to the file being modified
+	* @param pluginCall - The plugin call that was being added
+	* @param importDeclarations - The import declarations needed for the plugin
+	* @param reason - The reason why the structure is invalid
+	*/
 	static invalidViteConfig(filePath, pluginCall, importDeclarations, reason) {
 		return new CodemodException(reason, {
 			filePath,
 			instructions: `Add the following code to "${filePath}":\n\n${this.#formatVitePlugin(pluginCall, importDeclarations)}`
 		});
 	}
+	/**
+	* Creates an exception when tests/bootstrap.ts file is missing
+	*
+	* @param filePath - The path to the missing file
+	* @param pluginCall - The plugin call that was being added
+	* @param importDeclarations - The import declarations needed for the plugin
+	*/
 	static missingJapaBootstrap(filePath, pluginCall, importDeclarations) {
 		const code = this.#formatJapaPlugin(pluginCall, importDeclarations);
 		return new CodemodException(`Could not find source file at path: "${filePath}"`, {
@@ -103,30 +211,64 @@ var CodemodException = class CodemodException extends Error {
 			instructions: `Add the following code to "${filePath}":\n\n${code}`
 		});
 	}
+	/**
+	* Creates an exception when tests/bootstrap.ts structure is invalid
+	*
+	* @param filePath - The path to the file being modified
+	* @param pluginCall - The plugin call that was being added
+	* @param importDeclarations - The import declarations needed for the plugin
+	* @param reason - The reason why the structure is invalid
+	*/
 	static invalidJapaBootstrap(filePath, pluginCall, importDeclarations, reason) {
 		return new CodemodException(reason, {
 			filePath,
 			instructions: `Add the following code to "${filePath}":\n\n${this.#formatJapaPlugin(pluginCall, importDeclarations)}`
 		});
 	}
+	/**
+	* Creates an exception when adonisrc.ts file is missing
+	*
+	* @param filePath - The path to the missing file
+	* @param codeToAdd - The code that should be added manually
+	*/
 	static missingRcFile(filePath, codeToAdd) {
 		return new CodemodException(`Could not find source file at path: "${filePath}"`, {
 			filePath,
 			instructions: `Add the following code to "${filePath}":\n\n${codeToAdd}`
 		});
 	}
+	/**
+	* Creates an exception when adonisrc.ts structure is invalid
+	*
+	* @param filePath - The path to the file being modified
+	* @param codeToAdd - The code that should be added manually
+	* @param reason - The reason why the structure is invalid
+	*/
 	static invalidRcFile(filePath, codeToAdd, reason) {
 		return new CodemodException(reason, {
 			filePath,
 			instructions: `Add the following code to "${filePath}":\n\n${codeToAdd}`
 		});
 	}
+	/**
+	* Creates an exception when a file required for transformation is not found.
+	*
+	* @param filePath - The path to the missing file
+	* @param codeToAdd - The code that should be added manually
+	*/
 	static E_CODEMOD_FILE_NOT_FOUND(filePath, codeToAdd) {
 		return new CodemodException(`Could not find source file at path: "${filePath}"`, {
 			filePath,
 			instructions: `Add the following code to "${filePath}":\n\n${codeToAdd}`
 		});
 	}
+	/**
+	* Creates an exception when the file structure doesn't match expected patterns.
+	*
+	* @param message - Description of what structure was expected
+	* @param filePath - The path to the file being modified
+	* @param codeToAdd - The code that should be added manually
+	*/
 	static E_CODEMOD_INVALID_STRUCTURE(message, filePath, codeToAdd) {
 		return new CodemodException(message, {
 			filePath,
@@ -134,4 +276,5 @@ var CodemodException = class CodemodException extends Error {
 		});
 	}
 };
+//#endregion
 export { CodemodException as t };