vike 0.4.159 → 0.4.160-commit-a1101c1

package/dist/cjs/node/plugin/plugins/importUserCode/v1-design/{transpileAndExecuteFile.js → getVikeConfig/transpileAndExecuteFile.js}

@@ -9,58 +9,74 @@ const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const picocolors_1 = __importDefault(require("@brillout/picocolors"));
 const import_1 = require("@brillout/import");
-const utils_js_1 = require("../../../utils.js");
-const replaceImportStatements_js_1 = require("./replaceImportStatements.js");
-const getVikeConfig_js_1 = require("./getVikeConfig.js");
+const utils_js_1 = require("../../../../utils.js");
+const transformImports_js_1 = require("./transformImports.js");
+const getVikeConfig_js_1 = require("../getVikeConfig.js");
 require("source-map-support/register.js");
-const assertExports_js_1 = require("../../../../../shared/page-configs/assertExports.js");
+const getConfigFileExport_js_1 = require("../getConfigFileExport.js");
 (0, utils_js_1.assertIsNotProductionRuntime)();
-async function transpileAndExecuteFile(filePath, isValueFile, userRootDir) {
-    const { code, fileImports } = await transpileFile(filePath, isValueFile, userRootDir);
-    const { fileExports } = await executeFile(filePath, code, fileImports, isValueFile);
-    return { fileExports };
+async function transpileAndExecuteFile(filePath, isValueFile, userRootDir, isConfigOfExtension = false) {
+    if (isConfigOfExtension) {
+        const fileExports = await executeFile(filePath.filePathAbsoluteFilesystem, filePath);
+        if (isHeaderFile(filePath.filePathAbsoluteFilesystem)) {
+            const filePathToShowToUser2 = getFilePathToShowToUser2(filePath);
+            (0, utils_js_1.assertWarning)(false, `${filePathToShowToUser2} is a JavaScript header file (.h.js), but JavaScript header files don't apply to the config files of extensions`, { onlyOnce: true });
+        }
+        return { fileExports };
+    }
+    else {
+        const { code, fileImportsTransformed } = await transpileFile(filePath, isValueFile, userRootDir);
+        const fileExports = await executeTranspiledFile(filePath, code, fileImportsTransformed, isValueFile);
+        return { fileExports };
+    }
 }
 exports.transpileAndExecuteFile = transpileAndExecuteFile;
 async function transpileFile(filePath, isValueFile, userRootDir) {
     const { filePathAbsoluteFilesystem } = filePath;
+    const filePathToShowToUser2 = getFilePathToShowToUser2(filePath);
     (0, utils_js_1.assertPosixPath)(filePathAbsoluteFilesystem);
     getVikeConfig_js_1.vikeConfigDependencies.add(filePathAbsoluteFilesystem);
-    let code = await transpileWithEsbuild(filePath, isValueFile, userRootDir);
-    let fileImports = null;
-    {
-        const res = transpileImports(code, filePath, isValueFile);
+    const importsAreTransformed = !isValueFile;
+    let code = await transpileWithEsbuild(filePath, userRootDir, importsAreTransformed, isValueFile);
+    let fileImportsTransformed = null;
+    if (importsAreTransformed) {
+        const res = transformImports_(code, filePath);
         if (res) {
             code = res.code;
-            fileImports = res.fileImports;
+            fileImportsTransformed = res.fileImportsTransformed;
         }
     }
-    return { code, fileImports };
-}
-function transpileImports(codeOriginal, filePath, isValueFile) {
-    // Do we need to remove the imports?
-    const { filePathAbsoluteFilesystem, filePathToShowToUser } = filePath;
-    (0, utils_js_1.assertPosixPath)(filePathAbsoluteFilesystem);
-    const isHeader = isHeaderFile(filePathAbsoluteFilesystem);
-    const isPageConfigFile = !isValueFile;
-    if (!isHeader && !isPageConfigFile) {
-        return null;
+    else {
+        if (isHeaderFile(filePathAbsoluteFilesystem)) {
+            if (isValueFile) {
+                (0, utils_js_1.assertWarning)(false, `${filePathToShowToUser2} is a JavaScript header file (.h.js), but JavaScript header files only apply to +config.h.js, see https://vike.dev/header-file`, { onlyOnce: true });
+            }
+            else {
+                (0, utils_js_1.assert)(false);
+            }
+        }
     }
-    (0, utils_js_1.assertWarning)(isPageConfigFile, `${filePathToShowToUser} is a JavaScript header file (.h.js), but JavaScript header files should only be used for +config.h.js, see https://vike.dev/header-file`, { onlyOnce: true });
-    // Remove the imports
-    const res = (0, replaceImportStatements_js_1.replaceImportStatements)(codeOriginal, filePathToShowToUser);
-    if (res.noImportStatement) {
+    return { code, fileImportsTransformed };
+}
+function transformImports_(codeOriginal, filePath) {
+    const { filePathAbsoluteFilesystem } = filePath;
+    const filePathToShowToUser2 = getFilePathToShowToUser2(filePath);
+    // Replace import statements with import strings
+    const res = (0, transformImports_js_1.transformImports)(codeOriginal, filePathToShowToUser2);
+    if (res.noTransformation) {
         return null;
     }
-    const { code, fileImports } = res;
-    if (!isHeader) {
-        const filePathCorrect = appendHeaderFileExtension(filePathToShowToUser);
-        (0, utils_js_1.assertWarning)(false, `Rename ${filePathToShowToUser} to ${filePathCorrect}, see https://vike.dev/header-file`, {
+    const { code, fileImportsTransformed } = res;
+    if (!isHeaderFile(filePathAbsoluteFilesystem)) {
+        const filePathCorrect = appendHeaderFileExtension(filePathToShowToUser2);
+        (0, utils_js_1.assertWarning)(false, `Rename ${filePathToShowToUser2} to ${filePathCorrect}, see https://vike.dev/header-file`, {
             onlyOnce: true
         });
     }
-    return { code, fileImports };
+    return { code, fileImportsTransformed };
 }
-async function transpileWithEsbuild(filePath, bundle, userRootDir) {
+async function transpileWithEsbuild(filePath, userRootDir, importsAreTransformed, isValueFile) {
+    const isConfigFile = !isValueFile;
     const entryFilePath = filePath.filePathAbsoluteFilesystem;
     const entryFileDir = path_1.default.posix.dirname(entryFilePath);
     const options = {
@@ -76,22 +92,26 @@ async function transpileWithEsbuild(filePath, bundle, userRootDir) {
         'NEVER_EMITTED.js'),
         logLevel: 'silent',
         format: 'esm',
-        bundle,
+        absWorkingDir: userRootDir,
+        // Disable tree-shaking to avoid dead-code elimination, so that unused imports aren't removed.
+        // Esbuild still sometimes removes unused imports because of TypeScript: https://github.com/evanw/esbuild/issues/3034
+        treeShaking: false,
         minify: false,
-        metafile: bundle,
-        absWorkingDir: userRootDir
+        metafile: isConfigFile,
+        // We cannot bundle imports that are meant to be transformed
+        bundle: !importsAreTransformed
     };
-    if (bundle) {
-        options.bundle = true;
+    // Track dependencies
+    if (isConfigFile) {
         options.packages = 'external';
         options.plugins = [
             {
-                name: 'vike:import-hook',
+                name: 'vike:dependency-tracker',
                 setup(b) {
                     b.onLoad({ filter: /./ }, (args) => {
+                        // We collect the dependency `args.path` in case the bulid fails (upon build error => error is thrown => no metafile)
                         let { path } = args;
                         path = (0, utils_js_1.toPosixPath)(path);
-                        // We collect the dependency args.path in case it fails to build (upon build error => error is thrown => no metafile)
                         getVikeConfig_js_1.vikeConfigDependencies.add(path);
                         return undefined;
                     });
@@ -108,11 +128,6 @@ async function transpileWithEsbuild(filePath, bundle, userRootDir) {
             }
         ];
     }
-    else {
-        // Avoid dead-code elimination to ensure unused imports aren't removed.
-        // Esbuild still sometimes removes unused imports because of TypeScript: https://github.com/evanw/esbuild/issues/3034
-        options.treeShaking = false;
-    }
     let result;
     try {
         result = await (0, esbuild_1.build)(options);
@@ -121,7 +136,8 @@ async function transpileWithEsbuild(filePath, bundle, userRootDir) {
         await formatBuildErr(err, filePath);
         throw err;
     }
-    if (bundle) {
+    // Track dependencies
+    if (isConfigFile) {
         (0, utils_js_1.assert)(result.metafile);
         Object.keys(result.metafile.inputs).forEach((filePathRelative) => {
             filePathRelative = (0, utils_js_1.toPosixPath)(filePathRelative);
@@ -134,7 +150,7 @@ async function transpileWithEsbuild(filePath, bundle, userRootDir) {
     (0, utils_js_1.assert)(typeof code === 'string');
     return code;
 }
-async function executeFile(filePath, code, fileImports, isValueFile) {
+async function executeTranspiledFile(filePath, code, fileImportsTransformed, isValueFile) {
     const { filePathAbsoluteFilesystem, filePathRelativeToUserRootDir } = filePath;
     // Alternative to using a temporary file: https://github.com/vitejs/vite/pull/13269
     //  - But seems to break source maps, so I don't think it's worth it
@@ -143,28 +159,35 @@ async function executeFile(filePath, code, fileImports, isValueFile) {
     const clean = () => fs_1.default.unlinkSync(filePathTmp);
     let fileExports = {};
     try {
-        fileExports = await (0, import_1.import_)(filePathTmp);
+        fileExports = await executeFile(filePathTmp, filePath);
+    }
+    finally {
+        clean();
+    }
+    if (fileImportsTransformed && !isValueFile) {
+        (0, utils_js_1.assert)(filePathRelativeToUserRootDir !== undefined);
+        const filePathToShowToUser2 = getFilePathToShowToUser2(filePath);
+        assertImportsAreReExported(fileImportsTransformed, fileExports, filePathToShowToUser2);
+    }
+    return fileExports;
+}
+async function executeFile(filePathToExecuteAbsoluteFilesystem, filePathSourceFile) {
+    let fileExports = {};
+    try {
+        fileExports = await (0, import_1.import_)(filePathToExecuteAbsoluteFilesystem);
     }
     catch (err) {
         triggerPrepareStackTrace(err);
-        const errIntroMsg = getErrIntroMsg('execute', filePath);
+        const errIntroMsg = getErrIntroMsg('execute', filePathSourceFile);
         (0, utils_js_1.assert)((0, utils_js_1.isObject)(err));
         execErrIntroMsg.set(err, errIntroMsg);
         throw err;
     }
-    finally {
-        clean();
-    }
-    // Return a plain JavaScript object
+    // Return a plain JavaScript object:
     //  - import() returns `[Module: null prototype] { default: { onRenderClient: '...' }}`
-    //  - We don't need this special object
+    //  - We don't need this special object.
     fileExports = { ...fileExports };
-    if (fileImports && !isValueFile) {
-        (0, utils_js_1.assert)(filePathRelativeToUserRootDir !== undefined);
-        const filePathToShowToUser = filePathRelativeToUserRootDir ?? filePathAbsoluteFilesystem;
-        assertImportsAreReExported(fileImports, fileExports, filePathToShowToUser);
-    }
-    return { fileExports };
+    return fileExports;
 }
 const formatted = '_formatted';
 function getConfigBuildErrorFormatted(err) {
@@ -196,10 +219,10 @@ function getConfigExecutionErrorIntroMsg(err) {
 }
 exports.getConfigExecutionErrorIntroMsg = getConfigExecutionErrorIntroMsg;
 const tmpPrefix = `[build-`;
-function getFilePathTmp(filePath) {
-    (0, utils_js_1.assertPosixPath)(filePath);
-    const dirname = path_1.default.posix.dirname(filePath);
-    const filename = path_1.default.posix.basename(filePath);
+function getFilePathTmp(filePathAbsoluteFilesystem) {
+    (0, utils_js_1.assertPosixPath)(filePathAbsoluteFilesystem);
+    const dirname = path_1.default.posix.dirname(filePathAbsoluteFilesystem);
+    const filename = path_1.default.posix.basename(filePathAbsoluteFilesystem);
     // Syntax with semicolon `[build:${/*...*/}]` doesn't work on Windows: https://github.com/vikejs/vike/issues/800#issuecomment-1517329455
     const tag = `${tmpPrefix}${(0, utils_js_1.getRandomId)(12)}]`;
     const filePathTmp = path_1.default.posix.join(dirname, `${tag}${filename}.mjs`);
@@ -211,29 +234,29 @@ function isTmpFile(filePath) {
     return fileName.startsWith(tmpPrefix);
 }
 exports.isTmpFile = isTmpFile;
-function assertImportsAreReExported(fileImports, fileExports, filePathToShowToUser) {
-    (0, assertExports_js_1.assertExportsOfConfigFile)(fileExports, filePathToShowToUser);
-    const exportedStrings = getExportedStrings(fileExports.default);
+function assertImportsAreReExported(fileImportsTransformed, fileExports, filePathToShowToUser2) {
+    const fileExport = (0, getConfigFileExport_js_1.getConfigFileExport)(fileExports, filePathToShowToUser2);
+    const exportedStrings = getExportedStrings(fileExport);
     Object.values(exportedStrings).forEach((exportVal) => {
         if (typeof exportVal !== 'string')
             return;
-        if (!(0, replaceImportStatements_js_1.isImportData)(exportVal))
+        if (!(0, transformImports_js_1.isImportData)(exportVal))
             return;
         const importString = exportVal;
-        fileImports.forEach((fileImport) => {
+        fileImportsTransformed.forEach((fileImport) => {
             if (fileImport.importString === importString) {
                 fileImport.isReExported = true;
             }
         });
     });
-    const fileImportsUnused = fileImports.filter((fi) => !fi.isReExported);
-    if (fileImportsUnused.length === 0)
+    const fileImportsTransformedUnused = fileImportsTransformed.filter((fi) => !fi.isReExported);
+    if (fileImportsTransformedUnused.length === 0)
         return;
-    const importStatements = (0, utils_js_1.unique)(fileImportsUnused.map((fi) => fi.importStatementCode));
-    const importNamesUnused = fileImportsUnused.map((fi) => picocolors_1.default.cyan(fi.importLocalName)).join(', ');
-    const singular = fileImportsUnused.length === 1;
-    (0, utils_js_1.assertWarning)(fileImportsUnused.length === 0, [
-        `${filePathToShowToUser} imports the following:`,
+    const importStatements = (0, utils_js_1.unique)(fileImportsTransformedUnused.map((fi) => fi.importStatementCode));
+    const importNamesUnused = fileImportsTransformedUnused.map((fi) => picocolors_1.default.cyan(fi.importLocalName)).join(', ');
+    const singular = fileImportsTransformedUnused.length === 1;
+    (0, utils_js_1.assertWarning)(fileImportsTransformedUnused.length === 0, [
+        `${filePathToShowToUser2} imports the following:`,
         ...importStatements.map((s) => picocolors_1.default.cyan(`  ${s}`)),
         `But the import${singular ? '' : 's'} ${importNamesUnused} ${singular ? "isn't" : "aren't"} re-exported at ${picocolors_1.default.cyan('export default { ... }')} and therefore ${singular ? 'has' : 'have'} no effect, see explanation at https://vike.dev/header-file`
     ].join('\n'), { onlyOnce: true });
@@ -255,6 +278,7 @@ function getExportedStrings(obj) {
     return exportedStrings;
 }
 function isHeaderFile(filePath) {
+    (0, utils_js_1.assertPosixPath)(filePath);
     const basenameParts = path_1.default.posix.basename(filePath).split('.');
     return basenameParts.includes('h');
 }
@@ -275,10 +299,19 @@ function triggerPrepareStackTrace(err) {
     }
 }
 function getErrIntroMsg(operation, filePath) {
+    const filePathToShowToUser2 = getFilePathToShowToUser2(filePath);
     const msg = [
+        // prettier ignore
         picocolors_1.default.red(`Failed to ${operation}`),
-        picocolors_1.default.bold(picocolors_1.default.red(filePath.filePathToShowToUser)),
+        picocolors_1.default.bold(picocolors_1.default.red(filePathToShowToUser2)),
         picocolors_1.default.red(`because:`)
     ].join(' ');
     return msg;
 }
+/** `filePath.filePathToShowToUser` may show the import path of a package, use `filePathToShowToUser2` instead always show a file path instead. */
+function getFilePathToShowToUser2(filePath) {
+    const { filePathAbsoluteFilesystem, filePathRelativeToUserRootDir } = filePath;
+    const filePathToShowToUser2 = filePathRelativeToUserRootDir || filePathAbsoluteFilesystem;
+    (0, utils_js_1.assert)(filePathToShowToUser2);
+    return filePathToShowToUser2;
+}