@cypress/vite-dev-server 3.3.1 → 4.0.0

package/dist/dynamic-import.d.ts

@@ -0,0 +1 @@
+export declare const dynamicImport: <T>(module: string) => Promise<T>;

package/dist/dynamic-import.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dynamicImport = void 0;
+// tsc will compile `import(...)` calls to require unless a different tsconfig.module value
+// is used (e.g. module=node16). To change this, we would also have to change the ts-node behavior when requiring the
+// Cypress config file. This hack for keeping dynamic imports from being converted works across all
+// of our supported node versions
+const _dynamicImport = new Function('specifier', 'return import(specifier)');
+const dynamicImport = (module) => _dynamicImport(module);
+exports.dynamicImport = dynamicImport;

package/dist/plugins/cypress.js

@@ -3,12 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Cypress = void 0;
 const tslib_1 = require("tslib");
 const debug_1 = tslib_1.__importDefault(require("debug"));
-const pathe_1 = require("pathe");
 const node_html_parser_1 = require("node-html-parser");
 const fs_1 = tslib_1.__importDefault(require("fs"));
 const path_1 = tslib_1.__importDefault(require("path"));
 const debug = (0, debug_1.default)('cypress:vite-dev-server:plugins:cypress');
-const INIT_FILEPATH = (0, pathe_1.resolve)(__dirname, '../../client/initCypressTests.js');
+const INIT_FILEPATH = path_1.default.resolve(__dirname, '../../client/initCypressTests.js');
 const HMR_DEPENDENCY_LOOKUP_MAX_ITERATION = 50;
 function getSpecsPathsSet(specs) {
     return new Set(specs.map((spec) => spec.absolute));
@@ -44,7 +43,7 @@ const Cypress = (options, vite) => {
             const scriptTagsToInject = root.childNodes.filter((node) => {
                 return node instanceof node_html_parser_1.HTMLElement && node.rawTagName === 'script';
             });
-            const indexHtmlPath = (0, pathe_1.resolve)(projectRoot, indexHtmlFile);
+            const indexHtmlPath = path_1.default.resolve(projectRoot, indexHtmlFile);
             debug('resolved the indexHtmlPath as', indexHtmlPath, 'from', indexHtmlFile);
             let indexHtmlContent = await fs_1.default.promises.readFile(indexHtmlPath, { encoding: 'utf8' });
             // Inject the script tags
@@ -75,7 +74,7 @@ const Cypress = (options, vite) => {
         handleHotUpdate: ({ server, file }) => {
             debug('handleHotUpdate - file', file);
             // If the user provided IndexHtml is changed, do a full-reload
-            if (vite.normalizePath(file) === (0, pathe_1.resolve)(projectRoot, indexHtmlFile)) {
+            if (vite.normalizePath(file) === path_1.default.resolve(projectRoot, indexHtmlFile)) {
                 server.ws.send({
                     type: 'full-reload',
                 });

package/dist/plugins/index.d.ts

@@ -1,3 +1,2 @@
-export * from './inspect';
 export * from './cypress';
 export * from './sourcemap';

package/dist/plugins/index.js

@@ -1,6 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./inspect"), exports);
 tslib_1.__exportStar(require("./cypress"), exports);
 tslib_1.__exportStar(require("./sourcemap"), exports);

package/dist/resolveConfig.js

@@ -8,45 +8,57 @@ const tslib_1 = require("tslib");
  * You can find it here https://github.com/vitest-dev/vitest/blob/main/packages/vitest/src/node/create.ts
  */
 const debug_1 = tslib_1.__importDefault(require("debug"));
-const local_pkg_1 = require("local-pkg");
-const pathe_1 = require("pathe");
 const path_1 = tslib_1.__importDefault(require("path"));
 const constants_1 = require("./constants");
 const index_1 = require("./plugins/index");
+const dynamic_import_1 = require("./dynamic-import");
 const debug = (0, debug_1.default)('cypress:vite-dev-server:resolve-config');
 const createViteDevServerConfig = async (config, vite) => {
-    const { specs, cypressConfig, viteConfig: viteOverrides } = config;
-    const root = cypressConfig.projectRoot;
-    const { default: findUp } = await (0, local_pkg_1.importModule)('find-up');
-    const configFile = await findUp(constants_1.configFiles, { cwd: root });
-    // INFO logging, a lot is logged here.
-    // debug('all dev-server options are', options)
-    if (configFile) {
-        debug('resolved config file at', configFile, 'using root', root);
-    }
-    else if (viteOverrides) {
-        debug(`Couldn't find a Vite config file, however we received a custom viteConfig`, viteOverrides);
+    const { viteConfig: inlineViteConfig, cypressConfig: { projectRoot } } = config;
+    let resolvedOverrides = {};
+    if (inlineViteConfig) {
+        debug(`Received a custom viteConfig`, inlineViteConfig);
+        if (typeof inlineViteConfig === 'function') {
+            resolvedOverrides = await inlineViteConfig();
+        }
+        else if (typeof inlineViteConfig === 'object') {
+            resolvedOverrides = inlineViteConfig;
+        }
+        // Set "configFile: false" to disable auto resolution of <project-root>/vite.config.js
+        resolvedOverrides = Object.assign({ configFile: false }, resolvedOverrides);
     }
     else {
-        if (config.onConfigNotFound) {
-            config.onConfigNotFound('vite', root, constants_1.configFiles);
-            // The config process will be killed from the parent, but we want to early exit so we don't get
-            // any additional errors related to not having a config
-            process.exit(0);
-        }
-        else {
-            throw new Error(`Your component devServer config for vite is missing a required viteConfig property, since we could not automatically detect one.\n Please add one to your ${config.cypressConfig.configFile}`);
+        const { findUp } = await (0, dynamic_import_1.dynamicImport)('find-up');
+        const configFile = await findUp(constants_1.configFiles, { cwd: projectRoot });
+        if (!configFile) {
+            if (config.onConfigNotFound) {
+                config.onConfigNotFound('vite', projectRoot, constants_1.configFiles);
+                // The config process will be killed from the parent, but we want to early exit so we don't get
+                // any additional errors related to not having a config
+                process.exit(0);
+            }
+            else {
+                throw new Error(`Your component devServer config for vite is missing a required viteConfig property, since we could not automatically detect one.\n Please add one to your ${config.cypressConfig.configFile}`);
+            }
         }
+        debug('Resolved config file at', configFile, 'using root', projectRoot);
+        resolvedOverrides = { configFile };
     }
+    const finalConfig = vite.mergeConfig(resolvedOverrides, makeCypressViteConfig(config, vite));
+    debug('The resolved server config is', JSON.stringify(finalConfig, null, 2));
+    return finalConfig;
+};
+exports.createViteDevServerConfig = createViteDevServerConfig;
+function makeCypressViteConfig(config, vite) {
+    const { cypressConfig: { projectRoot, devServerPublicPathRoute, supportFile, cypressBinaryRoot, isTextTerminal, }, specs, } = config;
     // Vite caches its output in the .vite directory in the node_modules where vite lives.
     // So we want to find that node_modules path and ensure it's added to the "allow" list
     const vitePathNodeModules = path_1.default.dirname(path_1.default.dirname(require.resolve(`vite/package.json`, {
-        paths: [root],
+        paths: [projectRoot],
     })));
-    const viteBaseConfig = {
-        root,
-        base: `${cypressConfig.devServerPublicPathRoute}/`,
-        configFile,
+    return {
+        root: projectRoot,
+        base: `${devServerPublicPathRoute}/`,
         optimizeDeps: {
             esbuildOptions: {
                 incremental: true,
@@ -67,42 +79,22 @@ const createViteDevServerConfig = async (config, vite) => {
                 ],
             },
             entries: [
-                ...specs.map((s) => (0, pathe_1.relative)(root, s.relative)),
-                ...(cypressConfig.supportFile ? [(0, pathe_1.resolve)(root, cypressConfig.supportFile)] : []),
+                ...specs.map((s) => path_1.default.relative(projectRoot, s.relative)),
+                ...(supportFile ? [path_1.default.resolve(projectRoot, supportFile)] : []),
             ].filter((v) => v != null),
         },
-        server: {
-            fs: {
+        server: Object.assign({ fs: {
                 allow: [
-                    root,
+                    projectRoot,
                     vitePathNodeModules,
-                    cypressConfig.cypressBinaryRoot,
+                    cypressBinaryRoot,
                 ],
-            },
-            host: '127.0.0.1',
-        },
+            }, host: '127.0.0.1' }, (isTextTerminal
+            ? { watch: { ignored: '**/*' }, hmr: false }
+            : {})),
         plugins: [
             (0, index_1.Cypress)(config, vite),
-            (0, index_1.CypressInspect)(config),
             (0, index_1.CypressSourcemap)(config, vite),
-        ].filter((p) => p != null),
+        ],
     };
-    if (config.cypressConfig.isTextTerminal) {
-        viteBaseConfig.server = Object.assign(Object.assign({}, (viteBaseConfig.server || {})), { 
-            // Disable file watching and HMR when executing tests in `run` mode
-            watch: {
-                ignored: '**/*',
-            }, hmr: false });
-    }
-    let resolvedOverrides = {};
-    if (typeof viteOverrides === 'function') {
-        resolvedOverrides = await viteOverrides();
-    }
-    else if (typeof viteOverrides === 'object') {
-        resolvedOverrides = viteOverrides;
-    }
-    const finalConfig = vite.mergeConfig(viteBaseConfig, resolvedOverrides);
-    debug('The resolved server config is', JSON.stringify(finalConfig, null, 2));
-    return finalConfig;
-};
-exports.createViteDevServerConfig = createViteDevServerConfig;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cypress/vite-dev-server",
-  "version": "3.3.1",
+  "version": "4.0.0",
   "description": "Launches Vite Dev Server for Component Testing",
   "main": "index.js",
   "scripts": {
@@ -17,9 +17,7 @@
   "dependencies": {
     "debug": "4.3.3",
     "find-up": "6.3.0",
-    "local-pkg": "0.4.1",
-    "node-html-parser": "5.3.3",
-    "pathe": "0.2.0"
+    "node-html-parser": "5.3.3"
   },
   "devDependencies": {
     "chai": "^4.3.6",

package/dist/plugins/inspect.d.ts

@@ -1,3 +0,0 @@
-import type { PluginOption } from 'vite';
-import type { ViteDevServerConfig } from '../devServer';
-export declare const CypressInspect: (config: ViteDevServerConfig) => PluginOption | null;

package/dist/plugins/inspect.js

@@ -1,27 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CypressInspect = void 0;
-const tslib_1 = require("tslib");
-const debug_1 = tslib_1.__importDefault(require("debug"));
-const debug = (0, debug_1.default)('cypress:vite-dev-server:plugins:inspect');
-const CypressInspect = (config) => {
-    var _a;
-    if (!process.env.CYPRESS_INTERNAL_VITE_INSPECT) {
-        debug('skipping vite inspect because CYPRESS_INTERNAL_VITE_INSPECT is not set');
-        return null;
-    }
-    let Inspect;
-    try {
-        const inspectPluginPath = require.resolve('vite-plugin-inspect', { paths: [config.cypressConfig.projectRoot] });
-        const inspectModule = require(inspectPluginPath);
-        Inspect = (_a = inspectModule.default) !== null && _a !== void 0 ? _a : inspectModule;
-        debug('inspect was found', Inspect);
-    }
-    catch (err) {
-        debug(`Tried to import the inspect plugin 'vite-plugin-inspect'. It's an optional peerDependency so install it if you'd like.`);
-        debug(err);
-        return null;
-    }
-    return Object.assign(Object.assign({}, Inspect()), { name: 'cypress:inspect' });
-};
-exports.CypressInspect = CypressInspect;