@adonisjs/vite 0.0.1-2 → 0.0.1-4

package/build/configure.d.ts

@@ -1,3 +1,5 @@
 import type Configure from '@adonisjs/core/commands/configure';
+/**
+ * Configures the package
+ */
 export declare function configure(command: Configure): Promise<void>;
-//# sourceMappingURL=configure.d.ts.map

package/build/configure.js

@@ -1,12 +1,23 @@
+/*
+ * @adonisjs/vite
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 import { join } from 'node:path';
 import { fileURLToPath } from 'node:url';
+/**
+ * Configures the package
+ */
 export async function configure(command) {
     const stubDestination = join(fileURLToPath(command.app.appRoot), 'vite.config.js');
     await command.publishStub('vite/vite_config.stub', {
         destination: stubDestination,
     });
     await command.updateRcFile((rcFile) => {
-        rcFile.addProvider('@adonisjs/vite/providers/vite_provider');
+        rcFile.addProvider('@adonisjs/vite/vite_provider');
     });
     const packagesToInstall = [{ name: 'vite', isDevDependency: true }];
     command.listPackagesToInstall(packagesToInstall);

package/build/index.d.ts

@@ -2,4 +2,3 @@ import './src/backend/types/extended.js';
 export { configure } from './configure.js';
 export { stubsRoot } from './stubs/index.js';
 export { Vite } from './src/backend/vite.js';
-//# sourceMappingURL=index.d.ts.map

package/build/index.js

@@ -1,3 +1,11 @@
+/*
+ * @adonisjs/vite
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 import './src/backend/types/extended.js';
 export { configure } from './configure.js';
 export { stubsRoot } from './stubs/index.js';

package/build/providers/vite_provider.d.ts

@@ -1,10 +1,11 @@
-import '@adonisjs/view';
-import { ApplicationService } from '@adonisjs/core/types';
+import type { ApplicationService } from '@adonisjs/core/types';
 export default class ViteServiceProvider {
     #private;
     protected app: ApplicationService;
     constructor(app: ApplicationService);
     register(): void;
+    /**
+     * Extend the view globals with vite tags and globals
+     */
     boot(): Promise<void>;
 }
-//# sourceMappingURL=vite_provider.d.ts.map

package/build/providers/vite_provider.js

@@ -1,17 +1,29 @@
-import '@adonisjs/view';
-import { Vite } from '../src/backend/vite.js';
+/*
+ * @adonisjs/vite
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 import { EdgeError } from 'edge-error';
 export default class ViteServiceProvider {
     app;
     constructor(app) {
         this.app = app;
     }
+    /**
+     * Inject the script needed for Vite HMR
+     */
     #registerViteTag(view) {
         view.registerTag({
             tagName: 'vite',
             seekable: true,
             block: false,
             compile(parser, buffer, token) {
+                /**
+                 * Ensure an argument is defined
+                 */
                 if (!token.properties.jsArg.trim()) {
                     throw new EdgeError('Missing entrypoint name', 'E_RUNTIME_EXCEPTION', {
                         filename: token.filename,
@@ -25,6 +37,9 @@ export default class ViteServiceProvider {
             },
         });
     }
+    /**
+     * Inject a script needed for the HMR working with React
+     */
     #registerViteReactTag(view) {
         view.registerTag({
             tagName: 'viteReactRefresh',
@@ -36,13 +51,21 @@ export default class ViteServiceProvider {
         });
     }
     register() {
-        this.app.container.singleton('vite', async () => new Vite(this.app));
+        this.app.container.singleton('vite', async () => {
+            const { Vite } = await import('../src/backend/vite.js');
+            return new Vite(this.app);
+        });
     }
+    /**
+     * Extend the view globals with vite tags and globals
+     */
     async boot() {
-        const view = await this.app.container.make('view');
-        const vite = await this.app.container.make('vite');
-        view.global('vite', vite);
-        this.#registerViteTag(view);
-        this.#registerViteReactTag(view);
+        this.app.container.resolving('view', async (view) => {
+            const vite = await this.app.container.make('vite');
+            view.global('vite', vite);
+            view.global('asset', vite.assetPath.bind(vite));
+            this.#registerViteTag(view);
+            this.#registerViteReactTag(view);
+        });
     }
 }

package/build/services/vite.d.ts

@@ -1,4 +1,3 @@
 import { Vite } from '../index.js';
 declare let vite: Vite;
 export { vite as default };
-//# sourceMappingURL=vite.d.ts.map

package/build/services/vite.js

@@ -1,5 +1,17 @@
+/*
+ * @adonisjs/vite
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 import app from '@adonisjs/core/services/app';
 let vite;
+/**
+ * Returns a singleton instance of Vite class
+ * from the container
+ */
 await app.booted(async () => {
     vite = await app.container.make('vite');
 });

package/build/src/backend/types/extended.d.ts

@@ -1,7 +1,9 @@
 import { Vite } from '../vite.js';
+/**
+ * Extend the container bindings
+ */
 declare module '@adonisjs/core/types' {
     interface ContainerBindings {
         vite: Vite;
     }
 }
-//# sourceMappingURL=extended.d.ts.map

package/build/src/backend/types/extended.js

@@ -1 +1,9 @@
+/*
+ * @adonisjs/vite
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 export {};

package/build/src/backend/types/main.d.ts

@@ -1,9 +1,18 @@
+/**
+ * Content of the hotfile
+ */
 export type HotFile = {
     url: string;
 };
+/**
+ * Parameters passed to the setAttributes callback
+ */
 export type SetAttributesCallbackParams = {
     src: string;
     url: string;
 };
+/**
+ * Attributes to be set on the script/style tags.
+ * Can be either a record or a callback that returns a record.
+ */
 export type SetAttributes = Record<string, string | boolean> | ((params: SetAttributesCallbackParams) => Record<string, string | boolean>);
-//# sourceMappingURL=main.d.ts.map

package/build/src/backend/types/main.js

@@ -1 +1,9 @@
+/*
+ * @adonisjs/vite
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 export {};

package/build/src/backend/utils.d.ts

@@ -1,2 +1,4 @@
+/**
+ * Returns a new array with unique items by the given key
+ */
 export declare function uniqBy<T>(array: T[], key: keyof T): T[];
-//# sourceMappingURL=utils.d.ts.map

package/build/src/backend/utils.js

@@ -1,3 +1,14 @@
+/*
+ * @adonisjs/vite
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+/**
+ * Returns a new array with unique items by the given key
+ */
 export function uniqBy(array, key) {
     const seen = new Set();
     return array.filter((item) => {

package/build/src/backend/vite.d.ts

@@ -5,15 +5,56 @@ export declare class Vite {
     #private;
     private application;
     constructor(application: ApplicationService);
+    /**
+     * Generate tags for the entry points
+     */
     generateEntryPointsTags(entryPoints: string[] | string): string;
+    /**
+     * Returns path to a given asset file
+     */
     assetPath(asset: string): string;
+    /**
+     * Returns the manifest file content
+     *
+     * @throws Will throw an exception when running in hot mode
+     */
     manifest(): Manifest;
+    /**
+     * Returns the script needed for the HMR working with React
+     *
+     * This method is called automatically when using edge tag `@viteReactRefresh`
+     */
     getReactHmrScript(): string;
+    /**
+     * Set the path to the hotfile
+     *
+     * You must also set the `hotFile` option in the vite plugin config
+     */
     setHotFilePath(path: string): this;
+    /**
+     * Set the manifest filename
+     *
+     * You must also set the `build.manifest` option in your vite configuration
+     */
     setManifestFilename(name: string): this;
+    /**
+     * Set the build directory. Subdirectory of the AdonisJs public directory
+     *
+     * You must also set the `buildDirectory` option in the vite plugin config
+     */
     setBuildDirectory(path: string): this;
+    /**
+     * Set the assets url
+     *
+     * You must also set the `assetsUrl` option in the vite plugin config
+     */
     setAssetsUrl(url: string): this;
+    /**
+     * Include additional attributes to each script tag generated
+     */
     setScriptAttributes(attributes: SetAttributes): this;
+    /**
+     * Include additional attributes to each style tag generated
+     */
     setStyleAttributes(attributes: SetAttributes): this;
 }
-//# sourceMappingURL=vite.d.ts.map

package/build/src/backend/vite.js

@@ -1,44 +1,101 @@
+/*
+ * @adonisjs/vite
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 import { join } from 'node:path';
 import { fileURLToPath } from 'node:url';
 import { existsSync, readFileSync } from 'node:fs';
 import { uniqBy } from './utils.js';
 export class Vite {
     application;
+    /**
+     * Path to the build directory
+     *
+     * @default 'public/assets'
+     */
     #buildDirectory;
+    /**
+     * Path to the hotfile
+     *
+     * @default 'public/assets/hot.json'
+     */
     #hotFile;
+    /**
+     * Manifest file name
+     */
     #manifestFilename = 'manifest.json';
+    /**
+     * Assets URL
+     */
     #assetsUrl = '';
+    /**
+     * We cache the manifest file content in production
+     * to avoid reading the file multiple times
+     */
     #manifestCache = null;
+    /**
+     * Attributes to be set on the style tags
+     */
     #styleAttributes = {};
+    /**
+     * Attributes to be set on the script tags
+     */
     #scriptAttributes = {};
     constructor(application) {
         this.application = application;
         this.#buildDirectory = this.application.publicPath('assets');
         this.#hotFile = join(this.#buildDirectory, 'hot.json');
     }
+    /**
+     * Checks if the application is running in hot mode
+     */
     #isRunningHot() {
         return existsSync(this.#hotFile);
     }
+    /**
+     * Reads the file contents as JSON
+     */
     #readFileAsJSON(filePath) {
         return JSON.parse(readFileSync(filePath, 'utf-8'));
     }
+    /**
+     * Returns the parsed hot file content
+     */
     #readHotFile() {
         return this.#readFileAsJSON(this.#hotFile);
     }
+    /**
+     * Get the path to an asset when running in hot mode
+     */
     #hotAsset(asset) {
         return this.#readHotFile().url + '/' + asset;
     }
+    /**
+     * Returns the script needed for the HMR working with Vite
+     */
     #getViteHmrScript() {
         if (!this.#isRunningHot()) {
             return '';
         }
         return `<script type="module" src="${this.#hotAsset('@vite/client')}"></script>`;
     }
+    /**
+     * Generate style and script tags for the given entrypoints
+     * Also add the @vite/client script
+     */
     #generateEntryPointsTagsForHotmode(entryPoints) {
         const viteHmr = this.#getViteHmrScript();
         const tags = entryPoints.map((entrypoint) => this.#generateTag(entrypoint));
         return [viteHmr, ...tags].join('\n');
     }
+    /**
+     * Generate style and script tags for the given entrypoints
+     * using the manifest file
+     */
     #generateEntryPointsTagsWithManifest(entryPoints) {
         const manifest = this.manifest();
         const tags = [];
@@ -55,13 +112,9 @@ export class Vite {
             .map((preload) => preload.tag)
             .join('\n');
     }
-    generateEntryPointsTags(entryPoints) {
-        entryPoints = Array.isArray(entryPoints) ? entryPoints : [entryPoints];
-        if (this.#isRunningHot()) {
-            return this.#generateEntryPointsTagsForHotmode(entryPoints);
-        }
-        return this.#generateEntryPointsTagsWithManifest(entryPoints);
-    }
+    /**
+     * Get a chunk from the manifest file for a given file name
+     */
     #chunk(manifest, fileName) {
         const chunk = manifest[fileName];
         if (!chunk) {
@@ -69,6 +122,9 @@ export class Vite {
         }
         return chunk;
     }
+    /**
+     * Get a chunk from the manifest file for a given hashed file name
+     */
     #chunkByFile(manifest, fileName) {
         const chunk = Object.values(manifest).find((c) => c.file === fileName);
         if (!chunk) {
@@ -76,9 +132,15 @@ export class Vite {
         }
         return chunk;
     }
+    /**
+     * Check if the given path is a CSS path
+     */
     #isCssPath(path) {
         return path.match(/\.(css|less|sass|scss|styl|stylus|pcss|postcss)$/) !== null;
     }
+    /**
+     * Generate a HTML tag for the given asset
+     */
     #generateTag(asset) {
         let url = '';
         if (this.#isRunningHot()) {
@@ -92,12 +154,19 @@ export class Vite {
         }
         return this.#makeScriptTag(asset, url);
     }
+    /**
+     * Unwrap attributes from the user defined function or return
+     * the attributes as it is
+     */
     #unwrapAttributes(src, url, attributes) {
         if (typeof attributes === 'function') {
             return attributes({ src, url });
         }
         return attributes;
     }
+    /**
+     * Convert Record of attributes to a valid HTML string
+     */
     #makeAttributes(attributes) {
         return Object.keys(attributes)
             .map((key) => {
@@ -111,16 +180,35 @@ export class Vite {
             .filter((attr) => attr !== null)
             .join(' ');
     }
+    /**
+     * Create a script tag for the given path
+     */
     #makeScriptTag(src, url) {
         const customAttributes = this.#unwrapAttributes(src, url, this.#scriptAttributes);
         const attributes = { type: 'module', ...customAttributes };
         return `<script ${this.#makeAttributes(attributes)} src="${url}"></script>`;
     }
+    /**
+     * Create a style tag for the given path
+     */
     #makeStyleTag(src, url) {
         const customAttributes = this.#unwrapAttributes(src, url, this.#styleAttributes);
         const attributes = { rel: 'stylesheet', ...customAttributes };
         return `<link ${this.#makeAttributes(attributes)} href="${url}">`;
     }
+    /**
+     * Generate tags for the entry points
+     */
+    generateEntryPointsTags(entryPoints) {
+        entryPoints = Array.isArray(entryPoints) ? entryPoints : [entryPoints];
+        if (this.#isRunningHot()) {
+            return this.#generateEntryPointsTagsForHotmode(entryPoints);
+        }
+        return this.#generateEntryPointsTagsWithManifest(entryPoints);
+    }
+    /**
+     * Returns path to a given asset file
+     */
     assetPath(asset) {
         if (this.#isRunningHot()) {
             return this.#hotAsset(asset);
@@ -128,19 +216,35 @@ export class Vite {
         const chunk = this.#chunk(this.manifest(), asset);
         return `${this.#assetsUrl}/assets/${chunk.file}`;
     }
+    /**
+     * Returns the manifest file content
+     *
+     * @throws Will throw an exception when running in hot mode
+     */
     manifest() {
         if (this.#isRunningHot()) {
             throw new Error('Cannot read the manifest file when running in hot mode');
         }
+        /**
+         * Use in-memory cache when available
+         */
         if (this.#manifestCache) {
             return this.#manifestCache;
         }
         const manifest = this.#readFileAsJSON(join(this.#buildDirectory, this.#manifestFilename));
+        /**
+         * Cache the manifest in production to avoid re-reading the file from disk
+         */
         if (this.application.inProduction) {
             this.#manifestCache = manifest;
         }
         return manifest;
     }
+    /**
+     * Returns the script needed for the HMR working with React
+     *
+     * This method is called automatically when using edge tag `@viteReactRefresh`
+     */
     getReactHmrScript() {
         if (!this.#isRunningHot()) {
             return '';
@@ -155,26 +259,52 @@ export class Vite {
       </script>
       `;
     }
+    /**
+     * Set the path to the hotfile
+     *
+     * You must also set the `hotFile` option in the vite plugin config
+     */
     setHotFilePath(path) {
         this.#hotFile = join(fileURLToPath(this.application.appRoot), path);
         return this;
     }
+    /**
+     * Set the manifest filename
+     *
+     * You must also set the `build.manifest` option in your vite configuration
+     */
     setManifestFilename(name) {
         this.#manifestFilename = name;
         return this;
     }
+    /**
+     * Set the build directory. Subdirectory of the AdonisJs public directory
+     *
+     * You must also set the `buildDirectory` option in the vite plugin config
+     */
     setBuildDirectory(path) {
         this.#buildDirectory = this.application.publicPath(path);
         return this;
     }
+    /**
+     * Set the assets url
+     *
+     * You must also set the `assetsUrl` option in the vite plugin config
+     */
     setAssetsUrl(url) {
         this.#assetsUrl = url.endsWith('/') ? url : `${url}/`;
         return this;
     }
+    /**
+     * Include additional attributes to each script tag generated
+     */
     setScriptAttributes(attributes) {
         this.#scriptAttributes = attributes;
         return this;
     }
+    /**
+     * Include additional attributes to each style tag generated
+     */
     setStyleAttributes(attributes) {
         this.#styleAttributes = attributes;
         return this;

package/build/src/vite_plugin/config.d.ts

@@ -1,5 +1,10 @@
 import { ConfigEnv, Plugin, UserConfig } from 'vite';
 import { PluginFullOptions } from './types/index.js';
+/**
+ * Vite config hook
+ */
 export declare const configHook: (options: PluginFullOptions, userConfig: UserConfig, { command }: ConfigEnv) => UserConfig;
+/**
+ * Update the user vite config to match the Adonis requirements
+ */
 export declare const config: (options: PluginFullOptions) => Plugin;
-//# sourceMappingURL=config.d.ts.map

package/build/src/vite_plugin/config.js

@@ -1,14 +1,29 @@
+/*
+ * @adonisjs/vite
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 import { defu } from 'defu';
 import { resolveDevServerUrl } from './utils.js';
 import { HotFile } from './hot_file.js';
 import { ConfigResolver } from './config_resolver.js';
 import { join } from 'node:path';
+/**
+ * Vite config hook
+ */
 export const configHook = (options, userConfig, { command }) => {
     const config = {
         publicDir: userConfig.publicDir ?? false,
         base: ConfigResolver.resolveBase(userConfig, options, command),
         resolve: { alias: ConfigResolver.resolveAlias(userConfig) },
         server: {
+            /**
+             * Will allow to rewrite the URL to the public path
+             * in dev mode
+             */
             origin: '__adonis_vite__',
         },
         build: {
@@ -23,11 +38,17 @@ export const configHook = (options, userConfig, { command }) => {
     };
     return defu(config, userConfig);
 };
+/**
+ * Update the user vite config to match the Adonis requirements
+ */
 export const config = (options) => {
     let devServerUrl;
     return {
         name: 'vite-plugin-adonis:config',
         config: configHook.bind(null, options),
+        /**
+         * Store the dev server url for further usage when rewriting URLs
+         */
         configureServer(server) {
             const hotfile = new HotFile(options.hotFile);
             server.httpServer?.once('listening', async () => {
@@ -36,6 +57,11 @@ export const config = (options) => {
             });
             server.httpServer?.on('close', () => hotfile.clean());
         },
+        /**
+         * Rewrite URL to the public path in dev mode
+         *
+         * See : https://nystudio107.com/blog/using-vite-js-next-generation-frontend-tooling-with-craft-cms#vite-processed-assets
+         */
         transform: (code) => ({
             code: code.replace(/__adonis_vite__/g, devServerUrl),
             map: null,

package/build/src/vite_plugin/config_resolver.d.ts

@@ -2,8 +2,19 @@ import { ResolvedConfig, UserConfig, AliasOptions } from 'vite';
 import { PluginFullOptions } from './types/index.js';
 export declare class ConfigResolver {
     static resolvedConfig?: ResolvedConfig;
+    /**
+     * Resolve the `config.base` value
+     */
     static resolveBase(config: UserConfig, options: PluginFullOptions, command: 'build' | 'serve'): string;
+    /**
+     * Resolve the `config.resolve.alias` value
+     *
+     * Basically we are merging the user defined alias with the
+     * default alias.
+     */
     static resolveAlias(config: UserConfig): AliasOptions;
+    /**
+     * Resolve the `config.build.outDir` value
+     */
     static resolveOutDir(config: UserConfig, options: PluginFullOptions): string;
 }
-//# sourceMappingURL=config_resolver.d.ts.map