@adonisjs/vite 5.1.0 → 5.1.1

package/build/index.js

@@ -1,49 +1,73 @@
-import {
-  Vite
-} from "./chunk-ZCIGOANY.js";
-import "./chunk-ZCQTQOMI.js";
-
-// stubs/main.ts
-var stubsRoot = import.meta.dirname;
-
-// configure.ts
+import { t as Vite } from "./vite-DDpuL-Eo.js";
+import { join } from "node:path";
+//#region stubs/main.ts
+const stubsRoot = import.meta.dirname;
+//#endregion
+//#region configure.ts
+/**
+* Configures the package
+*/
 async function configure(command) {
-  const codemods = await command.createCodemods();
-  let shouldInstallPackages = command.parsedFlags.install;
-  await codemods.makeUsingStub(stubsRoot, "config/vite.stub", {});
-  await codemods.makeUsingStub(stubsRoot, "vite.config.stub", {});
-  await codemods.makeUsingStub(stubsRoot, "js_entrypoint.stub", {});
-  await codemods.updateRcFile((rcFile) => {
-    rcFile.addProvider("@adonisjs/vite/vite_provider");
-    rcFile.addMetaFile("public/**", false);
-    rcFile.addAssemblerHook("buildStarting", "@adonisjs/vite/build_hook");
-  });
-  await codemods.registerMiddleware("server", [
-    { path: "@adonisjs/vite/vite_middleware", position: "after" }
-  ]);
-  if (shouldInstallPackages === void 0) {
-    shouldInstallPackages = await command.prompt.confirm('Do you want to install "vite"?');
-  }
-  if (shouldInstallPackages) {
-    await codemods.installPackages([{ name: "vite", isDevDependency: true }]);
-  } else {
-    await codemods.listPackagesToInstall([{ name: "vite", isDevDependency: true }]);
-  }
+	const codemods = await command.createCodemods();
+	let shouldInstallPackages = command.parsedFlags.install;
+	/**
+	* Publish stubs
+	*/
+	await codemods.makeUsingStub(stubsRoot, "config/vite.stub", {});
+	await codemods.makeUsingStub(stubsRoot, "vite.config.stub", {});
+	await codemods.makeUsingStub(stubsRoot, "js_entrypoint.stub", {});
+	/**
+	* Update RC file
+	*/
+	await codemods.updateRcFile((rcFile) => {
+		rcFile.addProvider("@adonisjs/vite/vite_provider");
+		rcFile.addMetaFile("public/**", false);
+		rcFile.addAssemblerHook("buildStarting", "@adonisjs/vite/build_hook");
+	});
+	/**
+	* Add server middleware
+	*/
+	await codemods.registerMiddleware("server", [{
+		path: "@adonisjs/vite/vite_middleware",
+		position: "after"
+	}]);
+	/**
+	* Prompt when `install` or `--no-install` flags are
+	* not used
+	*/
+	if (shouldInstallPackages === void 0) shouldInstallPackages = await command.prompt.confirm("Do you want to install \"vite\"?");
+	/**
+	* Install dependency or list the command to install it
+	*/
+	if (shouldInstallPackages) await codemods.installPackages([{
+		name: "vite",
+		isDevDependency: true
+	}]);
+	else await codemods.listPackagesToInstall([{
+		name: "vite",
+		isDevDependency: true
+	}]);
 }
-
-// src/define_config.ts
-import { join } from "path";
+//#endregion
+//#region src/define_config.ts
+/**
+* Creates a complete Vite configuration by merging provided options with sensible defaults
+*
+* @param config - Partial Vite configuration options to override defaults
+*
+* @example
+* const viteConfig = defineConfig({
+*   assetsUrl: '/static',
+*   buildDirectory: 'dist'
+* })
+*/
 function defineConfig(config) {
-  return {
-    assetsUrl: "/assets",
-    buildDirectory: "public/assets",
-    manifestFile: config.buildDirectory ? join(config.buildDirectory, ".vite/manifest.json") : "public/assets/.vite/manifest.json",
-    ...config
-  };
+	return {
+		assetsUrl: "/assets",
+		buildDirectory: "public/assets",
+		manifestFile: config.buildDirectory ? join(config.buildDirectory, ".vite/manifest.json") : "public/assets/.vite/manifest.json",
+		...config
+	};
 }
-export {
-  Vite,
-  configure,
-  defineConfig,
-  stubsRoot
-};
+//#endregion
+export { Vite, configure, defineConfig, stubsRoot };

package/build/providers/vite_provider.js

@@ -1,141 +1,140 @@
-import {
-  Vite
-} from "../chunk-ZCIGOANY.js";
-import {
-  ViteMiddleware
-} from "../chunk-AF6PV64J.js";
-import "../chunk-ZCQTQOMI.js";
-
-// providers/vite_provider.ts
+import { t as Vite } from "../vite-DDpuL-Eo.js";
+import { t as ViteMiddleware } from "../vite_middleware-Bszg_DDr.js";
+//#region providers/vite_provider.ts
+/**
+* AdonisJS service provider for integrating Vite build tool and development server
+*
+* Handles lifecycle management of Vite integration including:
+* - Registering Vite service in the container
+* - Setting up Edge.js plugin for template integration
+* - Managing development server startup/shutdown
+* - Configuring CSP keywords for @adonisjs/shield
+*/
 var ViteProvider = class {
-  /**
-   * Creates a new ViteProvider instance
-   *
-   * @param app - The AdonisJS application service instance
-   *
-   * @example
-   * const provider = new ViteProvider(app)
-   */
-  constructor(app) {
-    this.app = app;
-  }
-  /**
-   * Flag indicating whether the Vite development server should be started
-   * Set to true when manifest file doesn't exist and running in web/test environment
-   */
-  #shouldRunViteDevServer = false;
-  /**
-   * Registers the Vite Edge.js plugin if Edge.js is available in the application
-   *
-   * Adds global helpers and custom tags (@vite, @viteReactRefresh) to Edge templates.
-   * Only registers the plugin if the application is using Edge.js.
-   *
-   * @example
-   * await provider.registerEdgePlugin()
-   * // Enables @vite('app.js') in Edge templates
-   */
-  async registerEdgePlugin() {
-    if (this.app.usingEdgeJS) {
-      const edge = await import("edge.js");
-      const vite = await this.app.container.make("vite");
-      const { edgePluginVite } = await import("../src/plugins/edge.js");
-      edge.default.use(edgePluginVite(vite));
-    }
-  }
-  /**
-   * Registers Content Security Policy keywords when @adonisjs/shield is installed
-   *
-   * Adds the '@viteUrl' keyword for CSP directives that returns the Vite assets URL
-   * when it's an HTTP/HTTPS URL, or an empty string otherwise.
-   *
-   * @example
-   * await provider.registerShieldKeywords()
-   * // Enables @viteUrl in CSP directives
-   */
-  async registerShieldKeywords() {
-    let cspKeywords = null;
-    try {
-      const shieldExports = await import("@adonisjs/shield");
-      cspKeywords = shieldExports.cspKeywords;
-    } catch {
-    }
-    if (!cspKeywords) {
-      return;
-    }
-    const vite = await this.app.container.make("vite");
-    cspKeywords.register("@viteUrl", function() {
-      const assetsURL = vite.assetsUrl();
-      if (!assetsURL || !assetsURL.startsWith("http://") || assetsURL.startsWith("https://")) {
-        return "";
-      }
-      return assetsURL;
-    });
-  }
-  /**
-   * Registers Vite service and middleware bindings in the IoC container
-   *
-   * Creates a Vite instance using configuration and determines whether
-   * the development server should run based on environment and manifest file presence.
-   *
-   * @example
-   * provider.register()
-   * // Vite service is now available via container.make('vite')
-   */
-  register() {
-    const appEnvironment = this.app.getEnvironment();
-    const vite = new Vite(this.app.config.get("vite"));
-    this.#shouldRunViteDevServer = appEnvironment === "test" || !!process.env.DEV_MODE;
-    this.app.container.singleton(Vite, () => vite);
-    this.app.container.singleton(ViteMiddleware, () => new ViteMiddleware(vite));
-    this.app.container.alias("vite", Vite);
-  }
-  /**
-   * Boots the Vite provider by registering plugins and integrations
-   *
-   * Registers Edge.js plugin and Shield CSP keywords if the respective
-   * packages are available in the application.
-   *
-   * @example
-   * await provider.boot()
-   */
-  async boot() {
-    await this.registerEdgePlugin();
-    await this.registerShieldKeywords();
-  }
-  /**
-   * Starts the Vite development server when the application is ready
-   *
-   * Only starts the server if running in development/test mode and
-   * no manifest file exists (indicating development mode).
-   *
-   * @example
-   * await provider.ready()
-   * // Dev server starts on configured port
-   */
-  async ready() {
-    if (!this.#shouldRunViteDevServer) {
-      return;
-    }
-    const vite = await this.app.container.make("vite");
-    await vite.createDevServer();
-  }
-  /**
-   * Gracefully stops the Vite development server during application shutdown
-   *
-   * Only attempts to stop the server if it was started during the ready phase.
-   * Ensures clean shutdown of the development server and its resources.
-   *
-   * @example
-   * await provider.shutdown()
-   */
-  async shutdown() {
-    if (!this.#shouldRunViteDevServer) {
-      return;
-    }
-    const vite = await this.app.container.make("vite");
-    await vite.stopDevServer();
-  }
-};
-export {
-  ViteProvider as default
+	/**
+	* Flag indicating whether the Vite development server should be started
+	* Set to true when manifest file doesn't exist and running in web/test environment
+	*/
+	#shouldRunViteDevServer = false;
+	/**
+	* Creates a new ViteProvider instance
+	*
+	* @param app - The AdonisJS application service instance
+	*
+	* @example
+	* const provider = new ViteProvider(app)
+	*/
+	constructor(app) {
+		this.app = app;
+	}
+	/**
+	* Registers the Vite Edge.js plugin if Edge.js is available in the application
+	*
+	* Adds global helpers and custom tags (@vite, @viteReactRefresh) to Edge templates.
+	* Only registers the plugin if the application is using Edge.js.
+	*
+	* @example
+	* await provider.registerEdgePlugin()
+	* // Enables @vite('app.js') in Edge templates
+	*/
+	async registerEdgePlugin() {
+		if (this.app.usingEdgeJS) {
+			const edge = await import("edge.js");
+			const vite = await this.app.container.make("vite");
+			const { edgePluginVite } = await import("../src/plugins/edge.js");
+			edge.default.use(edgePluginVite(vite));
+		}
+	}
+	/**
+	* Registers Content Security Policy keywords when @adonisjs/shield is installed
+	*
+	* Adds the '@viteUrl' keyword for CSP directives that returns the Vite assets URL
+	* when it's an HTTP/HTTPS URL, or an empty string otherwise.
+	*
+	* @example
+	* await provider.registerShieldKeywords()
+	* // Enables @viteUrl in CSP directives
+	*/
+	async registerShieldKeywords() {
+		let cspKeywords = null;
+		try {
+			cspKeywords = (await import("@adonisjs/shield")).cspKeywords;
+		} catch {}
+		if (!cspKeywords) return;
+		const vite = await this.app.container.make("vite");
+		/**
+		* Registering the @viteUrl keyword for CSP directives.
+		* Returns http URL to the dev or the CDN server, otherwise
+		* an empty string
+		*/
+		cspKeywords.register("@viteUrl", function() {
+			const assetsURL = vite.assetsUrl();
+			if (!assetsURL || !assetsURL.startsWith("http://") || assetsURL.startsWith("https://")) return "";
+			return assetsURL;
+		});
+	}
+	/**
+	* Registers Vite service and middleware bindings in the IoC container
+	*
+	* Creates a Vite instance using configuration and determines whether
+	* the development server should run based on environment and manifest file presence.
+	*
+	* @example
+	* provider.register()
+	* // Vite service is now available via container.make('vite')
+	*/
+	register() {
+		const appEnvironment = this.app.getEnvironment();
+		const vite = new Vite(this.app.config.get("vite"));
+		/**
+		* DEV_MODE is injected when the dev server is started
+		* by assembler
+		*/
+		this.#shouldRunViteDevServer = appEnvironment === "test" || !!process.env.DEV_MODE;
+		this.app.container.singleton(Vite, () => vite);
+		this.app.container.singleton(ViteMiddleware, () => new ViteMiddleware(vite));
+		this.app.container.alias("vite", Vite);
+	}
+	/**
+	* Boots the Vite provider by registering plugins and integrations
+	*
+	* Registers Edge.js plugin and Shield CSP keywords if the respective
+	* packages are available in the application.
+	*
+	* @example
+	* await provider.boot()
+	*/
+	async boot() {
+		await this.registerEdgePlugin();
+		await this.registerShieldKeywords();
+	}
+	/**
+	* Starts the Vite development server when the application is ready
+	*
+	* Only starts the server if running in development/test mode and
+	* no manifest file exists (indicating development mode).
+	*
+	* @example
+	* await provider.ready()
+	* // Dev server starts on configured port
+	*/
+	async ready() {
+		if (!this.#shouldRunViteDevServer) return;
+		await (await this.app.container.make("vite")).createDevServer();
+	}
+	/**
+	* Gracefully stops the Vite development server during application shutdown
+	*
+	* Only attempts to stop the server if it was started during the ready phase.
+	* Ensures clean shutdown of the development server and its resources.
+	*
+	* @example
+	* await provider.shutdown()
+	*/
+	async shutdown() {
+		if (!this.#shouldRunViteDevServer) return;
+		await (await this.app.container.make("vite")).stopDevServer();
+	}
 };
+//#endregion
+export { ViteProvider as default };

package/build/services/vite.js

@@ -1,9 +1,12 @@
-// services/vite.ts
 import app from "@adonisjs/core/services/app";
-var vite;
+//#region services/vite.ts
+let vite;
+/**
+* Returns a singleton instance of Vite class
+* from the container
+*/
 await app.booted(async () => {
-  vite = await app.container.make("vite");
+	vite = await app.container.make("vite");
 });
-export {
-  vite as default
-};
+//#endregion
+export { vite as default };

package/build/src/client/main.js

@@ -1,62 +1,75 @@
-import {
-  addTrailingSlash
-} from "../../chunk-ZCQTQOMI.js";
-
-// src/client/main.ts
+import { t as addTrailingSlash } from "../../utils-CdZpa_tV.js";
+import { join } from "node:path";
 import PluginRestart from "vite-plugin-restart";
-
-// src/client/config.ts
-import { join } from "path";
-function resolveBase(config2, options, command) {
-  if (config2.base) return config2.base;
-  if (command === "build") {
-    return addTrailingSlash(options.assetsUrl);
-  }
-  return "/";
+//#region src/client/config.ts
+/**
+* Resolves the base URL for Vite configuration based on command and options
+*
+* @param config - User-provided Vite configuration
+* @param options - Plugin options containing assetsUrl
+* @param command - Vite command being executed ('build' or 'serve')
+*
+* @example
+* const base = resolveBase(userConfig, { assetsUrl: '/assets' }, 'build')
+* // Returns: '/assets/' for build, '/' for serve
+*/
+function resolveBase(config, options, command) {
+	if (config.base) return config.base;
+	if (command === "build") return addTrailingSlash(options.assetsUrl);
+	return "/";
 }
+/**
+* Merges user Vite configuration with AdonisJS-specific defaults and requirements
+*
+* @param options - Plugin options containing build directory and entry points
+* @param userConfig - User-provided Vite configuration
+* @param command - Vite environment command
+*
+* @example
+* const mergedConfig = configHook(pluginOptions, userViteConfig, { command: 'build' })
+*/
 function configHook(options, userConfig, { command }) {
-  const config2 = {
-    publicDir: userConfig.publicDir ?? false,
-    base: resolveBase(userConfig, options, command),
-    /**
-     * Disable the vite dev server cors handling. Otherwise, it will
-     * override the cors settings defined by @adonisjs/cors
-     * https://github.com/adonisjs/vite/issues/13
-     */
-    server: { cors: userConfig.server?.cors ?? false },
-    build: {
-      assetsDir: "",
-      emptyOutDir: true,
-      manifest: userConfig.build?.manifest ?? true,
-      outDir: userConfig.build?.outDir ?? options.buildDirectory,
-      assetsInlineLimit: userConfig.build?.assetsInlineLimit ?? 0,
-      rollupOptions: {
-        input: options.entrypoints.map((entrypoint) => join(userConfig.root || "", entrypoint))
-      }
-    }
-  };
-  return config2;
+	return {
+		publicDir: userConfig.publicDir ?? false,
+		base: resolveBase(userConfig, options, command),
+		/**
+		* Disable the vite dev server cors handling. Otherwise, it will
+		* override the cors settings defined by @adonisjs/cors
+		* https://github.com/adonisjs/vite/issues/13
+		*/
+		server: { cors: userConfig.server?.cors ?? false },
+		build: {
+			assetsDir: "",
+			emptyOutDir: true,
+			manifest: userConfig.build?.manifest ?? true,
+			outDir: userConfig.build?.outDir ?? options.buildDirectory,
+			assetsInlineLimit: userConfig.build?.assetsInlineLimit ?? 0,
+			rollupOptions: { input: options.entrypoints.map((entrypoint) => join(userConfig.root || "", entrypoint)) }
+		}
+	};
 }
-var config = (options) => {
-  return {
-    name: "vite-plugin-adonis:config",
-    enforce: "post",
-    config: configHook.bind(null, options)
-  };
+/**
+* Update the user vite config to match the Adonis requirements
+*/
+const config = (options) => {
+	return {
+		name: "vite-plugin-adonis:config",
+		enforce: "post",
+		config: configHook.bind(null, options)
+	};
 };
-
-// src/client/main.ts
+//#endregion
+//#region src/client/main.ts
+/**
+* Vite plugin for AdonisJS
+*/
 function adonisjs(options) {
-  const fullOptions = Object.assign(
-    {
-      assetsUrl: "/assets",
-      buildDirectory: "public/assets",
-      reload: ["./resources/views/**/*.edge"]
-    },
-    options
-  );
-  return [PluginRestart({ reload: fullOptions.reload }), config(fullOptions)];
+	const fullOptions = Object.assign({
+		assetsUrl: "/assets",
+		buildDirectory: "public/assets",
+		reload: ["./resources/views/**/*.edge"]
+	}, options);
+	return [PluginRestart({ reload: fullOptions.reload }), config(fullOptions)];
 }
-export {
-  adonisjs as default
-};
+//#endregion
+export { adonisjs as default };

package/build/src/hooks/build_hook.js

@@ -1,11 +1,15 @@
-// src/hooks/build_hook.ts
 import { hooks } from "@adonisjs/core/app";
 import { createBuilder } from "vite";
+//#region src/hooks/build_hook.ts
+/**
+* This is an Assembler hook that should be executed when the application is
+* builded using the `node ace build` command.
+*
+* The hook is responsible for launching a Vite multi-build process.
+*/
 var build_hook_default = hooks.buildStarting(async (parent) => {
-  parent.ui.logger.info("building assets with vite");
-  const builder = await createBuilder({}, null);
-  await builder.buildApp();
+	parent.ui.logger.info("building assets with vite");
+	await (await createBuilder({}, null)).buildApp();
 });
-export {
-  build_hook_default as default
-};
+//#endregion
+export { build_hook_default as default };