@adonisjs/vite 2.0.2 → 3.0.0-1

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-1",
   "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/hooks/build_hook.js"
   },
   "scripts": {
     "clean": "del-cli build",
@@ -34,58 +34,51 @@
     "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": "tsup-node && tsc --emitDeclarationOnly --declaration",
+    "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.2",
+    "@adonisjs/core": "6.3.1",
     "@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",
-    "np": "^9.2.0",
-    "prettier": "^3.1.1",
-    "rollup": "^4.9.4",
+    "eslint": "^8.57.0",
+    "np": "^10.0.0",
+    "prettier": "^3.2.5",
     "ts-node": "^10.9.2",
-    "typescript": "^5.3.3",
-    "vite": "^5.0.11"
+    "tsup": "^8.0.2",
+    "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/core": "^6.3.0",
     "@adonisjs/shield": "^8.0.0",
     "edge.js": "^6.0.1",
-    "vite": "^5.0.11"
+    "vite": "^5.1.4"
   },
   "peerDependenciesMeta": {
-    "vite": {
-      "optional": true
-    },
     "edge.js": {
       "optional": true
     },
@@ -107,27 +100,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": {
@@ -140,7 +124,20 @@
       "tests_helpers/**"
     ]
   },
-  "directories": {
-    "test": "tests"
+  "tsup": {
+    "entry": [
+      "./index.ts",
+      "./providers/vite_provider.ts",
+      "./services/vite.ts",
+      "./src/types.ts",
+      "./src/client/main.ts",
+      "./src/hooks/build_hook.ts"
+    ],
+    "outDir": "./build",
+    "clean": true,
+    "format": "esm",
+    "dts": false,
+    "sourcemap": true,
+    "target": "esnext"
   }
 }

package/build/configure.js

@@ -1,42 +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 { stubsRoot } from './stubs/main.js';
-/**
- * Configures the package
- */
-export async function configure(command) {
-    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', {});
-    await codemods.updateRcFile((rcFile) => {
-        rcFile.addProvider('@adonisjs/vite/vite_provider');
-        rcFile.addMetaFile('public/**', false);
-    });
-    /**
-     * Prompt when `install` or `--no-install` flags are
-     * not used
-     */
-    if (shouldInstallPackages === undefined) {
-        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 }]);
-    }
-}

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/backend/define_config.js

@@ -1,23 +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 { join } from 'node:path';
-/**
- * Define the backend config for resolving vite assets
- */
-export function defineConfig(config) {
-    return {
-        buildDirectory: 'public/assets',
-        hotFile: 'public/assets/hot.json',
-        assetsUrl: '/assets',
-        manifestFile: config.buildDirectory
-            ? join(config.buildDirectory, '.vite/manifest.json')
-            : 'public/assets/.vite/manifest.json',
-        ...config,
-    };
-}

package/build/src/backend/plugins/edge.js

@@ -1,86 +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 { EdgeError } from 'edge-error';
-import debug from '../debug.js';
-/**
- * The edge plugin for vite to share vite service with edge
- * and register custom tags
- */
-export const edgePluginVite = (vite) => {
-    return (edge) => {
-        debug('sharing vite and asset globals with edge');
-        edge.global('vite', vite);
-        edge.global('asset', vite.assetPath.bind(vite));
-        debug('registering vite tags with edge');
-        edge.registerTag({
-            tagName: 'viteReactRefresh',
-            seekable: true,
-            block: false,
-            compile(parser, buffer, token) {
-                let attributes = '';
-                if (token.properties.jsArg.trim()) {
-                    /**
-                     * Converting a single argument to a SequenceExpression so that we
-                     * work around the following edge cases.
-                     *
-                     * - If someone passes an object literal to the tag, ie { nonce: 'foo' }
-                     *   it will be parsed as a LabeledStatement and not an object.
-                     * - If we wrap the object literal inside parenthesis, ie ({nonce: 'foo'})
-                     *   then we will end up messing other expressions like a variable reference
-                     *   , or a member expression and so on.
-                     * - So the best bet is to convert user supplied argument to a sequence expression
-                     *   and hence ignore it during stringification.
-                     */
-                    const jsArg = `a,${token.properties.jsArg}`;
-                    const parsed = parser.utils.transformAst(parser.utils.generateAST(jsArg, token.loc, token.filename), token.filename, parser);
-                    attributes = parser.utils.stringify(parsed.expressions[1]);
-                }
-                /**
-                 * Get HMR script
-                 */
-                buffer.writeExpression(`const __vite_hmr_script = state.vite.getReactHmrScript(${attributes})`, token.filename, token.loc.start.line);
-                /**
-                 * Check if the script exists (only in hot mode)
-                 */
-                buffer.writeStatement('if(__vite_hmr_script) {', token.filename, token.loc.start.line);
-                /**
-                 * Write output
-                 */
-                buffer.outputExpression(`__vite_hmr_script.toString()`, token.filename, token.loc.start.line, false);
-                /**
-                 * Close if block
-                 */
-                buffer.writeStatement('}', token.filename, token.loc.start.line);
-            },
-        });
-        edge.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,
-                        line: token.loc.start.line,
-                        col: token.loc.start.col,
-                    });
-                }
-                const parsed = parser.utils.transformAst(parser.utils.generateAST(token.properties.jsArg, token.loc, token.filename), token.filename, parser);
-                const entrypoints = parser.utils.stringify(parsed);
-                const methodCall = parsed.type === 'SequenceExpression'
-                    ? `generateEntryPointsTags${entrypoints}`
-                    : `generateEntryPointsTags(${entrypoints})`;
-                buffer.outputExpression(`state.vite.${methodCall}.join('\\n')`, token.filename, token.loc.start.line, false);
-            },
-        });
-    };
-};

package/build/src/backend/types.js

@@ -1,9 +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.
- */
-export {};

package/build/src/backend/utils.js

@@ -1,36 +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.
- */
-/**
- * Returns a new array with unique items by the given key
- */
-export function uniqBy(array, key) {
-    const seen = new Set();
-    return array.filter((item) => {
-        const k = item[key];
-        return seen.has(k) ? false : seen.add(k);
-    });
-}
-/**
- * Convert Record of attributes to a valid HTML string
- */
-export function makeAttributes(attributes) {
-    return Object.keys(attributes)
-        .map((key) => {
-        const value = attributes[key];
-        if (value === true) {
-            return key;
-        }
-        if (!value) {
-            return null;
-        }
-        return `${key}="${value}"`;
-    })
-        .filter((attr) => attr !== null)
-        .join(' ');
-}

package/build/src/backend/vite.js

@@ -1,259 +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 { existsSync, readFileSync } from 'node:fs';
-import debug from './debug.js';
-import { makeAttributes, uniqBy } from './utils.js';
-/**
- * Vite class exposes the APIs to generate tags and URLs for
- * assets processed using vite.
- */
-export class Vite {
-    /**
-     * We cache the manifest file content in production
-     * to avoid reading the file multiple times
-     */
-    #manifestCache = null;
-    /**
-     * Configuration options
-     */
-    #options;
-    constructor(options) {
-        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
-     */
-    #readFileAsJSON(filePath) {
-        return JSON.parse(readFileSync(filePath, 'utf-8'));
-    }
-    /**
-     * Returns the parsed hot file content
-     */
-    #readHotFile() {
-        return this.#readFileAsJSON(this.#options.hotFile);
-    }
-    /**
-     * Get the path to an asset when running in hot mode
-     */
-    #hotAsset(asset) {
-        return this.#readHotFile().url + '/' + asset;
-    }
-    /**
-     * 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;
-    }
-    /**
-     * Create a script tag for the given path
-     */
-    #makeScriptTag(src, url, attributes) {
-        const customAttributes = this.#unwrapAttributes(src, url, this.#options.scriptAttributes);
-        return this.#generateElement({
-            tag: 'script',
-            attributes: { type: 'module', ...customAttributes, ...attributes, src: url },
-            children: [],
-        });
-    }
-    /**
-     * Create a style tag for the given path
-     */
-    #makeStyleTag(src, url, attributes) {
-        const customAttributes = this.#unwrapAttributes(src, url, this.#options.styleAttributes);
-        return this.#generateElement({
-            tag: 'link',
-            attributes: { rel: 'stylesheet', ...customAttributes, ...attributes, href: url },
-        });
-    }
-    /**
-     * Generate a HTML tag for the given asset
-     */
-    #generateTag(asset, attributes) {
-        let url = '';
-        if (this.#isRunningHot()) {
-            url = this.#hotAsset(asset);
-        }
-        else {
-            url = `${this.#options.assetsUrl}/${asset}`;
-        }
-        if (this.#isCssPath(asset)) {
-            return this.#makeStyleTag(asset, url, attributes);
-        }
-        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
-     */
-    #generateEntryPointsTagsForHotMode(entryPoints, attributes) {
-        const viteHmr = this.#getViteHmrScript(attributes);
-        const tags = entryPoints.map((entrypoint) => this.#generateTag(entrypoint, attributes));
-        return viteHmr ? [viteHmr].concat(tags) : tags;
-    }
-    /**
-     * Generate style and script tags for the given entrypoints
-     * using the manifest file
-     */
-    #generateEntryPointsTagsWithManifest(entryPoints, attributes) {
-        const manifest = this.manifest();
-        const tags = [];
-        for (const entryPoint of entryPoints) {
-            const chunk = this.#chunk(manifest, entryPoint);
-            tags.push({
-                path: chunk.file,
-                tag: this.#generateTag(chunk.file, { ...attributes, integrity: chunk.integrity }),
-            });
-            for (const css of chunk.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()) {
-            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;
-        }
-        return this.#options.assetsUrl;
-    }
-    /**
-     * Returns path to a given asset file
-     */
-    assetPath(asset) {
-        if (this.#isRunningHot()) {
-            return this.#hotAsset(asset);
-        }
-        const chunk = this.#chunk(this.manifest(), asset);
-        return `${this.#options.assetsUrl}/${chunk.file}`;
-    }
-    /**
-     * Returns the manifest file contents
-     *
-     * @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');
-        }
-        if (!this.#manifestCache) {
-            this.#manifestCache = this.#readFileAsJSON(this.#options.manifestFile);
-        }
-        return this.#manifestCache;
-    }
-    /**
-     * Returns the script needed for the HMR working with React
-     */
-    getReactHmrScript(attributes) {
-        if (!this.#isRunningHot()) {
-            return null;
-        }
-        return this.#generateElement({
-            tag: 'script',
-            attributes: {
-                type: 'module',
-                ...attributes,
-            },
-            children: [
-                '',
-                `import RefreshRuntime from '${this.#hotAsset('@react-refresh')}'`,
-                `RefreshRuntime.injectIntoGlobalHook(window)`,
-                `window.$RefreshReg$ = () => {}`,
-                `window.$RefreshSig$ = () => (type) => type`,
-                `window.__vite_plugin_react_preamble_installed__ = true`,
-                '',
-            ],
-        });
-    }
-}