@adonisjs/vite 2.0.2 → 3.0.0-0

package/build/src/{backend/vite.js → vite.js}

@@ -6,33 +6,26 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-import { existsSync, readFileSync } from 'node:fs';
-import debug from './debug.js';
+import { readFileSync } from 'node:fs';
 import { makeAttributes, uniqBy } from './utils.js';
 /**
  * Vite class exposes the APIs to generate tags and URLs for
  * assets processed using vite.
  */
 export class Vite {
+    inDev;
     /**
      * We cache the manifest file content in production
      * to avoid reading the file multiple times
      */
-    #manifestCache = null;
-    /**
-     * Configuration options
-     */
+    #manifestCache;
     #options;
-    constructor(options) {
+    #runtime;
+    #devServer;
+    constructor(inDev, options) {
+        this.inDev = inDev;
         this.#options = options;
         this.#options.assetsUrl = (this.#options.assetsUrl || '/').replace(/\/$/, '');
-        debug('vite config %O', this.#options);
-    }
-    /**
-     * Checks if the application is running in hot mode
-     */
-    #isRunningHot() {
-        return existsSync(this.#options.hotFile);
     }
     /**
      * Reads the file contents as JSON
@@ -41,16 +34,39 @@ export class Vite {
         return JSON.parse(readFileSync(filePath, 'utf-8'));
     }
     /**
-     * Returns the parsed hot file content
+     * Generates a JSON element with a custom toString implementation
      */
-    #readHotFile() {
-        return this.#readFileAsJSON(this.#options.hotFile);
+    #generateElement(element) {
+        return {
+            ...element,
+            toString() {
+                const attributes = `${makeAttributes(element.attributes)}`;
+                if (element.tag === 'link') {
+                    return `<${element.tag} ${attributes}/>`;
+                }
+                return `<${element.tag} ${attributes}>${element.children.join('\n')}</${element.tag}>`;
+            },
+        };
     }
     /**
-     * Get the path to an asset when running in hot mode
+     * Returns the script needed for the HMR working with Vite
      */
-    #hotAsset(asset) {
-        return this.#readHotFile().url + '/' + asset;
+    #getViteHmrScript(attributes) {
+        return this.#generateElement({
+            tag: 'script',
+            attributes: {
+                type: 'module',
+                src: '/@vite/client',
+                ...attributes,
+            },
+            children: [],
+        });
+    }
+    /**
+     * Check if the given path is a CSS path
+     */
+    #isCssPath(path) {
+        return path.match(/\.(css|less|sass|scss|styl|stylus|pcss|postcss)$/) !== null;
     }
     /**
      * Unwrap attributes from the user defined function or return
@@ -63,24 +79,24 @@ export class Vite {
         return attributes;
     }
     /**
-     * Create a script tag for the given path
+     * Create a style tag for the given path
      */
-    #makeScriptTag(src, url, attributes) {
-        const customAttributes = this.#unwrapAttributes(src, url, this.#options.scriptAttributes);
+    #makeStyleTag(src, url, attributes) {
+        const customAttributes = this.#unwrapAttributes(src, url, this.#options?.styleAttributes);
         return this.#generateElement({
-            tag: 'script',
-            attributes: { type: 'module', ...customAttributes, ...attributes, src: url },
-            children: [],
+            tag: 'link',
+            attributes: { rel: 'stylesheet', ...customAttributes, ...attributes, href: url },
         });
     }
     /**
-     * Create a style tag for the given path
+     * Create a script tag for the given path
      */
-    #makeStyleTag(src, url, attributes) {
-        const customAttributes = this.#unwrapAttributes(src, url, this.#options.styleAttributes);
+    #makeScriptTag(src, url, attributes) {
+        const customAttributes = this.#unwrapAttributes(src, url, this.#options?.scriptAttributes);
         return this.#generateElement({
-            tag: 'link',
-            attributes: { rel: 'stylesheet', ...customAttributes, ...attributes, href: url },
+            tag: 'script',
+            attributes: { type: 'module', ...customAttributes, ...attributes, src: url },
+            children: [],
         });
     }
     /**
@@ -88,8 +104,8 @@ export class Vite {
      */
     #generateTag(asset, attributes) {
         let url = '';
-        if (this.#isRunningHot()) {
-            url = this.#hotAsset(asset);
+        if (this.inDev) {
+            url = `/${asset}`;
         }
         else {
             url = `${this.#options.assetsUrl}/${asset}`;
@@ -99,35 +115,6 @@ export class Vite {
         }
         return this.#makeScriptTag(asset, url, attributes);
     }
-    /**
-     * Generates a JSON element with a custom toString implementation
-     */
-    #generateElement(element) {
-        return {
-            ...element,
-            toString() {
-                const attributes = `${makeAttributes(element.attributes)}`;
-                if (element.tag === 'link') {
-                    return `<${element.tag} ${attributes}/>`;
-                }
-                return `<${element.tag} ${attributes}>${element.children.join('\n')}</${element.tag}>`;
-            },
-        };
-    }
-    /**
-     * Returns the script needed for the HMR working with Vite
-     */
-    #getViteHmrScript(attributes) {
-        return this.#generateElement({
-            tag: 'script',
-            attributes: {
-                type: 'module',
-                src: this.#hotAsset('@vite/client'),
-                ...attributes,
-            },
-            children: [],
-        });
-    }
     /**
      * Generate style and script tags for the given entrypoints
      * Also adds the @vite/client script
@@ -135,7 +122,18 @@ export class Vite {
     #generateEntryPointsTagsForHotMode(entryPoints, attributes) {
         const viteHmr = this.#getViteHmrScript(attributes);
         const tags = entryPoints.map((entrypoint) => this.#generateTag(entrypoint, attributes));
-        return viteHmr ? [viteHmr].concat(tags) : tags;
+        const result = viteHmr ? [viteHmr].concat(tags) : tags;
+        return result;
+    }
+    /**
+     * Get a chunk from the manifest file for a given file name
+     */
+    #chunk(manifest, fileName) {
+        const chunk = manifest[fileName];
+        if (!chunk) {
+            throw new Error(`Cannot find "${fileName}" chunk in the manifest file`);
+        }
+        return chunk;
     }
     /**
      * Generate style and script tags for the given entrypoints
@@ -151,69 +149,39 @@ export class Vite {
                 tag: this.#generateTag(chunk.file, { ...attributes, integrity: chunk.integrity }),
             });
             for (const css of chunk.css || []) {
-                tags.push({
-                    path: css,
-                    tag: this.#generateTag(css),
-                });
+                tags.push({ path: css, tag: this.#generateTag(css) });
             }
         }
         return uniqBy(tags, 'path')
             .sort((a) => (a.path.endsWith('.css') ? -1 : 1))
             .map((tag) => tag.tag);
     }
-    /**
-     * Get a chunk from the manifest file for a given file name
-     */
-    #chunk(manifest, fileName) {
-        const chunk = manifest[fileName];
-        if (!chunk) {
-            throw new Error(`Cannot find "${fileName}" chunk in the manifest file`);
-        }
-        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 tags for the entry points
      */
     generateEntryPointsTags(entryPoints, attributes) {
         entryPoints = Array.isArray(entryPoints) ? entryPoints : [entryPoints];
-        if (this.#isRunningHot()) {
+        if (this.inDev) {
             return this.#generateEntryPointsTagsForHotMode(entryPoints, attributes);
         }
         return this.#generateEntryPointsTagsWithManifest(entryPoints, attributes);
     }
-    /**
-     * Returns the dev server URL when running in hot
-     * mode. Otherwise an empty string
-     */
-    devUrl() {
-        if (this.#isRunningHot()) {
-            return this.#readHotFile().url;
-        }
-        return '';
-    }
     /**
      * Returns the dev server URL when running in hot
      * mode, otherwise returns the explicitly configured
      * "assets" URL
      */
     assetsUrl() {
-        if (this.#isRunningHot()) {
-            return this.#readHotFile().url;
-        }
+        if (this.inDev)
+            return this.#devServer.config.server.host;
         return this.#options.assetsUrl;
     }
     /**
      * Returns path to a given asset file
      */
     assetPath(asset) {
-        if (this.#isRunningHot()) {
-            return this.#hotAsset(asset);
+        if (this.inDev) {
+            return `/${asset}`;
         }
         const chunk = this.#chunk(this.manifest(), asset);
         return `${this.#options.assetsUrl}/${chunk.file}`;
@@ -221,22 +189,56 @@ export class Vite {
     /**
      * Returns the manifest file contents
      *
-     * @throws Will throw an exception when running in hot mode
+     * @throws Will throw an exception when running in dev
      */
     manifest() {
-        if (this.#isRunningHot()) {
-            throw new Error('Cannot read the manifest file when running in hot mode');
+        if (this.inDev) {
+            throw new Error('Cannot read the manifest file when running in dev mode');
         }
         if (!this.#manifestCache) {
             this.#manifestCache = this.#readFileAsJSON(this.#options.manifestFile);
         }
         return this.#manifestCache;
     }
+    /**
+     * Create the Vite Dev Server and runtime
+     *
+     * We lazy load the APIs to avoid loading it in production
+     * since we don't need it
+     */
+    async createDevServer() {
+        const { createViteRuntime, createServer } = await import('vite');
+        this.#devServer = await createServer({
+            server: { middlewareMode: true, hmr: { port: 3001 } },
+            appType: 'custom',
+        });
+        this.#runtime = await createViteRuntime(this.#devServer);
+    }
+    /**
+     * Stop the Vite Dev server
+     */
+    async stopDevServer() {
+        await this.#devServer?.close();
+    }
+    /**
+     * Get the Vite Dev server instance
+     * Will not be available when running in production
+     */
+    getDevServer() {
+        return this.#devServer;
+    }
+    /**
+     * Get the Vite runtime instance
+     * Will not be available when running in production
+     */
+    getRuntime() {
+        return this.#runtime;
+    }
     /**
      * Returns the script needed for the HMR working with React
      */
     getReactHmrScript(attributes) {
-        if (!this.#isRunningHot()) {
+        if (!this.inDev) {
             return null;
         }
         return this.#generateElement({
@@ -247,7 +249,7 @@ export class Vite {
             },
             children: [
                 '',
-                `import RefreshRuntime from '${this.#hotAsset('@react-refresh')}'`,
+                `import RefreshRuntime from '/@react-refresh'`,
                 `RefreshRuntime.injectIntoGlobalHook(window)`,
                 `window.$RefreshReg$ = () => {}`,
                 `window.$RefreshSig$ = () => (type) => type`,

package/build/stubs/vite.config.stub

@@ -1,5 +1,5 @@
 {{{
-  exports({ to: app.makePath('vite.config.js') })
+  exports({ to: app.makePath('vite.config.ts') })
 }}}
 import { defineConfig } from 'vite'
 import adonisjs from '@adonisjs/vite/client'

package/package.json

@@ -1,29 +1,29 @@
 {
   "name": "@adonisjs/vite",
-  "description": "Vite plugin for Adonis.js",
-  "version": "2.0.2",
+  "description": "Vite plugin for AdonisJS",
+  "version": "3.0.0-0",
   "engines": {
-    "node": ">=18.16.0"
+    "node": ">=20.6.0"
   },
   "main": "build/index.js",
   "type": "module",
   "files": [
+    "build/providers",
+    "build/services",
+    "build/src",
+    "build/stubs",
     "build/configure.js",
     "build/configure.d.ts",
     "build/index.js",
-    "build/index.d.ts",
-    "build/stubs",
-    "build/src",
-    "build/services",
-    "build/providers"
+    "build/index.d.ts"
   ],
   "exports": {
     ".": "./build/index.js",
-    "./services/main": "./build/services/vite.js",
     "./vite_provider": "./build/providers/vite_provider.js",
+    "./services/main": "./build/services/vite.js",
+    "./types": "./build/src/types.js",
     "./client": "./build/src/client/main.js",
-    "./plugins/edge": "./build/backend/plugins/edge.js",
-    "./types": "./build/src/backend/types.js"
+    "./build_hook": "./build/src/build_hook.js"
   },
   "scripts": {
     "clean": "del-cli build",
@@ -34,58 +34,50 @@
     "quick:test": "node --enable-source-maps --loader=ts-node/esm bin/test.ts",
     "pretest": "npm run lint",
     "test": "c8 npm run quick:test",
-    "precompile": "npm run lint && npm run clean ",
-    "compile": "tsc",
-    "postcompile": "npm run copy:templates",
-    "build": "npm run compile",
+    "prebuild": "npm run lint && npm run clean",
+    "build": "tsc",
+    "postbuild": "npm run copy:templates",
     "release": "np",
     "version": "npm run build",
     "prepublishOnly": "npm run build"
   },
   "devDependencies": {
-    "@adonisjs/assembler": "^7.0.0",
-    "@adonisjs/core": "^6.2.0",
+    "@adonisjs/application": "8.1.0",
+    "@adonisjs/assembler": "^7.2.1",
+    "@adonisjs/core": "6.3.0",
     "@adonisjs/eslint-config": "^1.2.1",
     "@adonisjs/prettier-config": "^1.2.1",
-    "@adonisjs/session": "^7.0.0",
-    "@adonisjs/shield": "^8.0.0",
+    "@adonisjs/shield": "^8.1.1",
     "@adonisjs/tsconfig": "^1.2.1",
-    "@commitlint/cli": "^18.4.4",
-    "@commitlint/config-conventional": "^18.4.4",
-    "@japa/assert": "^2.1.0",
-    "@japa/expect-type": "^2.0.1",
-    "@japa/file-system": "^2.1.1",
-    "@japa/runner": "^3.1.1",
-    "@swc/core": "^1.3.102",
-    "@types/node": "^20.10.7",
-    "c8": "^9.0.0",
+    "@japa/assert": "2.1.0",
+    "@japa/file-system": "^2.2.0",
+    "@japa/runner": "3.1.1",
+    "@swc/core": "^1.4.2",
+    "@types/node": "^20.11.20",
+    "c8": "^9.1.0",
     "copyfiles": "^2.4.1",
     "del-cli": "^5.1.0",
     "edge.js": "^6.0.1",
-    "eslint": "^8.56.0",
-    "husky": "^8.0.3",
+    "eslint": "^8.57.0",
     "np": "^9.2.0",
-    "prettier": "^3.1.1",
-    "rollup": "^4.9.4",
+    "prettier": "^3.2.5",
     "ts-node": "^10.9.2",
-    "typescript": "^5.3.3",
-    "vite": "^5.0.11"
+    "typescript": "~5.3.3",
+    "vite": "^5.1.4"
   },
   "dependencies": {
-    "defu": "^6.1.4",
+    "@poppinss/utils": "^6.7.2",
+    "@vavite/multibuild": "^4.1.1",
     "edge-error": "^4.0.1",
     "vite-plugin-restart": "^0.4.0"
   },
   "peerDependencies": {
-    "@adonisjs/core": "^6.2.0",
-    "@adonisjs/shield": "^8.0.0",
+    "@adonisjs/core": "^6.3.0",
+    "@adonisjs/shield": "^8.1.1",
     "edge.js": "^6.0.1",
-    "vite": "^5.0.11"
+    "vite": "^5.1.4"
   },
   "peerDependenciesMeta": {
-    "vite": {
-      "optional": true
-    },
     "edge.js": {
       "optional": true
     },
@@ -107,27 +99,18 @@
     "vite",
     "adonisjs"
   ],
-  "contributors": [
-    "virk",
-    "adonisjs"
-  ],
   "eslintConfig": {
     "extends": "@adonisjs/eslint-config/package"
   },
   "prettier": "@adonisjs/prettier-config",
-  "commitlint": {
-    "extends": [
-      "@commitlint/config-conventional"
-    ]
-  },
   "publishConfig": {
     "access": "public",
-    "tag": "latest"
+    "tag": "next"
   },
   "np": {
     "message": "chore(release): %s",
-    "tag": "latest",
-    "branch": "main",
+    "tag": "next",
+    "branch": "next",
     "anyBranch": false
   },
   "c8": {
@@ -139,8 +122,5 @@
       "tests/**",
       "tests_helpers/**"
     ]
-  },
-  "directories": {
-    "test": "tests"
   }
 }

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

@@ -1,3 +0,0 @@
-/// <reference types="node" resolution-mode="require"/>
-declare const _default: import("util").DebugLogger;
-export default _default;

package/build/src/backend/debug.js

@@ -1,10 +0,0 @@
-/*
- * @adonisjs/vite
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { debuglog } from 'node:util';
-export default debuglog('adonisjs:vite');

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

@@ -1,5 +0,0 @@
-import { ViteOptions } from './types.js';
-/**
- * Define the backend config for resolving vite assets
- */
-export declare function defineConfig(config: Partial<ViteOptions>): ViteOptions;

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

@@ -1,20 +0,0 @@
-import { ResolvedConfig, UserConfig, AliasOptions } from 'vite';
-import { PluginFullOptions } from './types.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;
-}

package/build/src/client/config_resolver.js

@@ -1,46 +0,0 @@
-/*
- * @adonisjs/vite
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { addTrailingSlash } from './utils.js';
-export class ConfigResolver {
-    static resolvedConfig;
-    /**
-     * Resolve the `config.base` value
-     */
-    static resolveBase(config, options, command) {
-        if (config.base) {
-            return config.base;
-        }
-        if (command === 'build') {
-            return addTrailingSlash(options.assetsUrl);
-        }
-        return '/';
-    }
-    /**
-     * Resolve the `config.resolve.alias` value
-     *
-     * Basically we are merging the user defined alias with the
-     * default alias.
-     */
-    static resolveAlias(config) {
-        const defaultAlias = { '@/': `/resources/js/` };
-        if (Array.isArray(config.resolve?.alias)) {
-            return [
-                ...(config.resolve?.alias ?? []),
-                Object.entries(defaultAlias).map(([find, replacement]) => ({ find, replacement })),
-            ];
-        }
-        return { ...defaultAlias, ...config.resolve?.alias };
-    }
-    /**
-     * Resolve the `config.build.outDir` value
-     */
-    static resolveOutDir(config, options) {
-        return config.build?.outDir ?? options.buildDirectory;
-    }
-}

package/build/src/client/helpers/inertia.d.ts

@@ -1,4 +0,0 @@
-/**
- * Resolves a page component.
- */
-export declare function resolvePageComponent(name: string, pages: Record<string, any>): Promise<any>;

package/build/src/client/helpers/inertia.js

@@ -1,22 +0,0 @@
-/*
- * @adonisjs/vite
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-/**
- * Resolves a page component.
- */
-export async function resolvePageComponent(name, pages) {
-    const path = Object.keys(pages)
-        .sort((a, b) => a.length - b.length)
-        .find((filepath) => filepath.endsWith(name));
-    if (!path) {
-        throw new Error(`Page component "${name}" could not be found.`);
-    }
-    let component = typeof pages[path] === 'function' ? await pages[path]() : pages[path];
-    component = component.default ?? component;
-    return component;
-}

package/build/src/client/hot_file.d.ts

@@ -1,14 +0,0 @@
-export declare class HotFile {
-    #private;
-    constructor(path: string);
-    /**
-     * Write the hot file
-     */
-    write(data: {
-        url: string;
-    }): Promise<void>;
-    /**
-     * Delete the hot file
-     */
-    clean(): void;
-}