vike 0.4.247 → 0.4.249-commit-775a43e

package/dist/node/vite/shared/resolveVikeConfigInternal/transpileAndExecuteFile.js

@@ -0,0 +1,426 @@
+export { transpileAndExecuteFile };
+export { getConfigBuildErrorFormatted };
+export { getConfigExecutionErrorIntroMsg };
+export { isTemporaryBuildFile };
+import { build, formatMessages, version, } from 'esbuild';
+import fs from 'node:fs';
+import path from 'node:path';
+import pc from '@brillout/picocolors';
+import { import_ } from '@brillout/import';
+import { assertPosixPath, getRandomId, assertIsNotProductionRuntime, assert, assertWarning, isObject, toPosixPath, assertUsage, isPlainScriptFile, createDebug, assertFilePathAbsoluteFilesystem, assertIsImportPathNpmPackage, genPromise, isVitest, isImportPathNpmPackageOrPathAlias, isImportPathRelative, requireResolveOptionalDir, } from '../../utils.js';
+import { transformPointerImports } from './pointerImports.js';
+import sourceMapSupport from 'source-map-support';
+import { getFilePathAbsoluteUserRootDir } from '../getFilePath.js';
+assertIsNotProductionRuntime();
+installSourceMapSupport();
+const debug = createDebug('vike:pointer-imports');
+const debugEsbuildResolve = createDebug('vike:esbuild-resolve');
+if (debugEsbuildResolve.isActivated)
+    debugEsbuildResolve('esbuild version', version);
+async function transpileAndExecuteFile(filePath, userRootDir, isExtensionConfig, esbuildCache) {
+    const { filePathAbsoluteFilesystem, filePathToShowToUserResolved } = filePath;
+    assert(filePathAbsoluteFilesystem);
+    const fileExtension = getFileExtension(filePathAbsoluteFilesystem);
+    if (esbuildCache.transpileCache[filePathAbsoluteFilesystem]) {
+        return await esbuildCache.transpileCache[filePathAbsoluteFilesystem];
+    }
+    const { promise, resolve } = genPromise();
+    esbuildCache.transpileCache[filePathAbsoluteFilesystem] = promise;
+    assertUsage(isPlainScriptFile(filePathAbsoluteFilesystem), `${filePathToShowToUserResolved} has file extension .${fileExtension} but a config file can only be a JavaScript/TypeScript file`);
+    const isHeader = isHeaderFile(filePathAbsoluteFilesystem);
+    if (isHeader) {
+        assertWarning(false, `${pc.cyan('.h.js')} files are deprecated: simply renaming ${filePathToShowToUserResolved} to ${removeHeaderFileExtension(filePathToShowToUserResolved)} is usually enough, although you may occasionally need to use ${pc.cyan("with { type: 'pointer' }")} as explained at https://vike.dev/config#pointer-imports`, { onlyOnce: true });
+    }
+    let fileExports;
+    if (isExtensionConfig && !isHeader && fileExtension.endsWith('js')) {
+        // This doesn't track dependencies => we should never use this for user land configs
+        fileExports = await executeFile(filePathAbsoluteFilesystem, filePath);
+    }
+    else {
+        const transformImports = isHeader ? 'all' : true;
+        const code = await transpileFile(filePath, transformImports, userRootDir, esbuildCache);
+        fileExports = await executeTranspiledFile(filePath, code);
+    }
+    resolve({ fileExports });
+    return { fileExports };
+}
+async function transpileFile(filePath, transformImports, userRootDir, esbuildCache) {
+    const { filePathAbsoluteFilesystem, filePathToShowToUserResolved } = filePath;
+    assert(filePathAbsoluteFilesystem);
+    assertPosixPath(filePathAbsoluteFilesystem);
+    esbuildCache.vikeConfigDependencies.add(filePathAbsoluteFilesystem);
+    if (debug.isActivated)
+        debug('transpile', filePathToShowToUserResolved);
+    let { code, pointerImports } = await transpileWithEsbuild(filePath, userRootDir, transformImports, esbuildCache);
+    if (debug.isActivated)
+        debug(`code, post esbuild (${filePathToShowToUserResolved})`, code);
+    let isImportTransformed = false;
+    if (transformImports) {
+        const codeMod = transformPointerImports(code, filePathToShowToUserResolved, pointerImports);
+        if (codeMod) {
+            code = codeMod;
+            isImportTransformed = true;
+            if (debug.isActivated)
+                debug(`code, post pointer imports transform (${filePathToShowToUserResolved})`, code);
+        }
+    }
+    if (!isImportTransformed) {
+        if (debug.isActivated)
+            debug(`code, no pointer imports (${filePathToShowToUserResolved})`);
+    }
+    return code;
+}
+async function transpileWithEsbuild(filePath, userRootDir, transformImports, esbuildCache) {
+    const entryFilePath = filePath.filePathAbsoluteFilesystem;
+    const entryFileDir = path.posix.dirname(entryFilePath);
+    const options = {
+        platform: 'node',
+        entryPoints: [entryFilePath],
+        sourcemap: 'inline',
+        write: false,
+        target: ['node14.18', 'node16'],
+        outfile: path.posix.join(
+        // Needed for correct inline source map
+        entryFileDir, 
+        // `write: false` => no file is actually emitted
+        'NEVER_EMITTED.js'),
+        logLevel: 'silent',
+        format: 'esm',
+        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: true,
+        bundle: true,
+    };
+    const pointerImports = {};
+    options.plugins = [
+        // Determine whether an import should be:
+        //  - A pointer import
+        //  - Externalized
+        {
+            name: 'vike-esbuild',
+            setup(build) {
+                // https://github.com/brillout/esbuild-playground
+                build.onResolve({ filter: /.*/ }, async (args) => {
+                    if (args.kind !== 'import-statement')
+                        return;
+                    // Avoid infinite loop: https://github.com/evanw/esbuild/issues/3095#issuecomment-1546916366
+                    const useEsbuildResolver = 'useEsbuildResolver';
+                    if (args.pluginData?.[useEsbuildResolver])
+                        return;
+                    const { path, ...opts } = args;
+                    opts.pluginData = { [useEsbuildResolver]: true };
+                    let resolved = await build.resolve(path, opts);
+                    if (debugEsbuildResolve.isActivated)
+                        debugEsbuildResolve('args', args);
+                    if (debugEsbuildResolve.isActivated)
+                        debugEsbuildResolve('resolved', resolved);
+                    // Temporary workaround for https://github.com/evanw/esbuild/issues/3973
+                    // - Still required for esbuild@0.24.0 (November 2024).
+                    // - Let's try to remove this workaround again later.
+                    if (resolved.errors.length > 0) {
+                        const resolvedWithNode = requireResolveOptionalDir({
+                            importPath: path,
+                            importerDir: toPosixPath(args.resolveDir),
+                            userRootDir,
+                        });
+                        if (debugEsbuildResolve.isActivated)
+                            debugEsbuildResolve('resolvedWithNode', resolvedWithNode);
+                        if (resolvedWithNode)
+                            resolved = { path: resolvedWithNode };
+                    }
+                    if (resolved.errors && resolved.errors.length > 0) {
+                        /* We could do the following to let Node.js throw the error, but we don't because the error shown by esbuild is prettier: the Node.js error refers to the transpiled [build-f7i251e0iwnw]+config.ts.mjs whereas esbuild refers to the source +config.ts file.
+                        pointerImports[args.path] = false
+                        return { external: true }
+                        */
+                        // Let esbuild throw the error
+                        cleanEsbuildErrors(resolved.errors);
+                        return resolved;
+                    }
+                    assert(resolved.path);
+                    // Built-in modules e.g. node:fs
+                    if (resolved.path === args.path) {
+                        const isPointerImport = false;
+                        pointerImports[args.path] = isPointerImport;
+                        if (debug.isActivated)
+                            debug('onResolve() [built-in module]', { args, resolved });
+                        assert(resolved.external);
+                        return resolved;
+                    }
+                    const importPathResolved = toPosixPath(resolved.path);
+                    const importPathOriginal = args.path;
+                    // Esbuild resolves path aliases.
+                    // - Enabling us to use:
+                    //   - assertIsImportPathNpmPackage()
+                    //   - isImportPathNpmPackage(str, { cannotBePathAlias: true })
+                    assertFilePathAbsoluteFilesystem(importPathResolved);
+                    //  Should be remove this? See comment below.
+                    const isVikeExtensionImport = (path.startsWith('vike-') && path.endsWith('/config')) || importPathResolved.endsWith('+config.js');
+                    const isPointerImport = transformImports === 'all' ||
+                        // .jsx, .vue, .svg, ... => obviously not config code => pointer import
+                        !isPlainScriptFile(importPathResolved) ||
+                        // Import of a Vike extension config => make it a pointer import because we want to show nice error messages (that can display whether a config has been set by the user or by a Vike extension).
+                        //  - Should we stop doing this? (And instead let Node.js directly load Vike extensions.)
+                        //    - In principle, we can use the setting 'name' value of Vike extensions.
+                        //      - vike@0.4.162 started soft-requiring Vike extensions to set the name config.
+                        //    - In practice, it seems like it requires some (non-trivial?) refactoring.
+                        isVikeExtensionImport;
+                    assertPosixPath(importPathResolved);
+                    // `isNpmPkgImport` => `importPathOriginal` is most likely an npm package import, but it can also be a path alias that a) looks like an npm package import and b) resolves outside of `userRootDir`.
+                    const isNpmPkgImport = (() => {
+                        if (importPathResolved.includes('/node_modules/')) {
+                            // So far I can't think of a use case where this assertion would fail, but let's eventually remove it to avoid artificially restricting the user.
+                            assert(isImportPathNpmPackageOrPathAlias(importPathOriginal));
+                            return true;
+                        }
+                        // Linked npm packages
+                        if (
+                        // Assuming path aliases usually resolve inside `userRootDir`.
+                        // - This isn't always the case: https://github.com/vikejs/vike/issues/2326
+                        !importPathResolved.startsWith(userRootDir) &&
+                            // False positive if `importPathOriginal` is a path alias that a) looks like an npm package import and b) resolves outside of `userRootDir` => we then we wrongfully assume that `importPathOriginal` is an npm package import.
+                            isImportPathNpmPackageOrPathAlias(importPathOriginal)) {
+                            return true;
+                        }
+                        return false;
+                    })();
+                    const isExternal = isPointerImport ||
+                        // Performance: npm package imports can be externalized. (We could as well let esbuild transpile /node_modules/ code but it's useless as /node_modules/ code is already built. It would unnecessarily slow down transpilation.)
+                        isNpmPkgImport;
+                    if (!isExternal) {
+                        // User-land config code (i.e. not runtime code) => let esbuild transpile it
+                        assert(!isPointerImport && !isNpmPkgImport);
+                        if (debug.isActivated)
+                            debug('onResolve() [non-external]', { args, resolved, isPointerImport, isExternal });
+                        return resolved;
+                    }
+                    let importPathTranspiled;
+                    assertPosixPath(importPathOriginal);
+                    if (isImportPathRelative(importPathOriginal)) {
+                        importPathTranspiled = importPathResolved;
+                    }
+                    else {
+                        // `importPathOriginal` is either:
+                        //  - Npm package import
+                        //  - Path alias
+                        const filePathAbsoluteUserRootDir = getFilePathAbsoluteUserRootDir({
+                            filePathAbsoluteFilesystem: importPathResolved,
+                            userRootDir,
+                        });
+                        if (filePathAbsoluteUserRootDir && !isNpmPkgImport) {
+                            // `importPathOriginal` is most likely a path alias.
+                            // - We have to use esbuild's path alias resolution, because:
+                            //   - Vike doesn't resolve path aliases at all.
+                            //   - Node.js doesn't support `tsconfig.js#compilerOptions.paths`.
+                            // - Esbuild path alias resolution seems reliable, e.g. it supports `tsconfig.js#compilerOptions.paths`.
+                            importPathTranspiled = importPathResolved;
+                        }
+                        else {
+                            // `importPathOriginal` is most likely an npm package import.
+                            assertIsImportPathNpmPackage(importPathOriginal);
+                            // For improved error messages, let the resolution be handled by Vike or Node.js.
+                            importPathTranspiled = importPathOriginal;
+                        }
+                    }
+                    if (debug.isActivated)
+                        debug('onResolve() [external]', { args, resolved, importPathTranspiled, isPointerImport, isExternal });
+                    assert(isExternal);
+                    assert(
+                    // Import of runtime code => handled by Vike
+                    isPointerImport ||
+                        // Import of config code => loaded by Node.js at build-time
+                        isNpmPkgImport);
+                    pointerImports[importPathTranspiled] = isPointerImport;
+                    return { external: true, path: importPathTranspiled };
+                });
+            },
+        },
+        // Track dependencies
+        {
+            name: 'vike:dependency-tracker',
+            setup(b) {
+                b.onLoad({ filter: /./ }, (args) => {
+                    // We collect the dependency `args.path` in case the build fails (upon build error => error is thrown => no metafile)
+                    let { path } = args;
+                    path = toPosixPath(path);
+                    esbuildCache.vikeConfigDependencies.add(path);
+                    return undefined;
+                });
+                /* To exhaustively collect all dependencies upon build failure, we would also need to use onResolve().
+                 *  - Because onLoad() isn't call if the config dependency can't be resolved.
+                 *  - For example, the following breaks auto-reload (the config is stuck in its error state and the user needs to touch the importer for the config to reload):
+                 *    ```bash
+                 *    mv ./some-config-dependency.js /tmp/ && mv /tmp/some-config-dependency.js .
+                 *    ```
+                 *  - But implementing a fix is complex and isn't worth it.
+                b.onResolve(...)
+                */
+            },
+        },
+    ];
+    let result;
+    try {
+        result = await build(options);
+    }
+    catch (err) {
+        await formatBuildErr(err, filePath);
+        throw err;
+    }
+    // Track dependencies
+    assert(result.metafile);
+    Object.keys(result.metafile.inputs).forEach((filePathRelative) => {
+        filePathRelative = toPosixPath(filePathRelative);
+        assertPosixPath(userRootDir);
+        const filePathAbsoluteFilesystem = path.posix.join(userRootDir, filePathRelative);
+        esbuildCache.vikeConfigDependencies.add(filePathAbsoluteFilesystem);
+    });
+    const code = result.outputFiles[0].text;
+    assert(typeof code === 'string');
+    return { code, pointerImports };
+}
+async function executeTranspiledFile(filePath, code) {
+    const { filePathAbsoluteFilesystem } = 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
+    const filePathTmp = getTemporaryBuildFilePath(filePathAbsoluteFilesystem);
+    fs.writeFileSync(filePathTmp, code);
+    const clean = () => fs.unlinkSync(filePathTmp);
+    let fileExports = {};
+    try {
+        fileExports = await executeFile(filePathTmp, filePath);
+    }
+    finally {
+        clean();
+    }
+    return fileExports;
+}
+async function executeFile(filePathToExecuteAbsoluteFilesystem, filePathSourceFile) {
+    let fileExports = {};
+    try {
+        fileExports = await import_(filePathToExecuteAbsoluteFilesystem);
+    }
+    catch (err) {
+        triggerPrepareStackTrace(err);
+        const errIntroMsg = getErrIntroMsg('execute', filePathSourceFile);
+        assert(isObject(err));
+        execErrIntroMsg.set(err, errIntroMsg);
+        throw err;
+    }
+    // Return a plain JavaScript object:
+    //  - import() returns `[Module: null prototype] { default: { onRenderClient: '...' }}`
+    //  - We don't need this special object.
+    fileExports = { ...fileExports };
+    return fileExports;
+}
+const formatted = '_formatted';
+function getConfigBuildErrorFormatted(err) {
+    if (!isObject(err))
+        return null;
+    if (!(formatted in err))
+        return null;
+    assert(typeof err[formatted] === 'string');
+    const errMsgFormatted = err[formatted];
+    return errMsgFormatted;
+}
+async function formatBuildErr(err, filePath) {
+    assert(isObject(err) && err.errors);
+    const msgEsbuild = (await formatMessages(err.errors, {
+        kind: 'error',
+        color: true,
+    }))
+        .map((m) => m.trim())
+        .join('\n');
+    const msgIntro = getErrIntroMsg('transpile', filePath);
+    const errMsgFormatted = `${msgIntro}\n${msgEsbuild}`;
+    err[formatted] = errMsgFormatted;
+}
+const execErrIntroMsg = new WeakMap();
+function getConfigExecutionErrorIntroMsg(err) {
+    if (!isObject(err))
+        return null;
+    const errIntroMsg = execErrIntroMsg.get(err);
+    return errIntroMsg ?? null;
+}
+function getTemporaryBuildFilePath(filePathAbsoluteFilesystem) {
+    assertPosixPath(filePathAbsoluteFilesystem);
+    const dirname = path.posix.dirname(filePathAbsoluteFilesystem);
+    const filename = path.posix.basename(filePathAbsoluteFilesystem);
+    // Syntax with semicolon `build:${/*...*/}` doesn't work on Windows: https://github.com/vikejs/vike/issues/800#issuecomment-1517329455
+    const filePathTmp = path.posix.join(dirname, `${filename}.build-${getRandomId()}.mjs`);
+    assert(isTemporaryBuildFile(filePathTmp));
+    return filePathTmp;
+}
+function isTemporaryBuildFile(filePath) {
+    assertPosixPath(filePath);
+    const fileName = path.posix.basename(filePath);
+    return /\.build-[a-z0-9]{12}\.mjs$/.test(fileName);
+}
+// TO-DO/next-major-release: remove
+function isHeaderFile(filePath) {
+    assertPosixPath(filePath);
+    const fileExtensions = getFileExtensions(filePath);
+    return fileExtensions.includes('h');
+}
+function getFileExtensions(filePath) {
+    const fileExtensions = path.posix.basename(filePath).split('.').slice(1);
+    return fileExtensions;
+}
+function getFileExtension(filePath) {
+    const fileExtensions = path.posix.basename(filePath).split('.').slice(1);
+    return fileExtensions.pop();
+}
+function removeHeaderFileExtension(filePath) {
+    assertPosixPath(filePath);
+    const fileName = path.posix.basename(filePath);
+    const fileNameParts = fileName.split('.');
+    const fileNamePartsMod = fileNameParts.filter((p) => p !== 'h');
+    assert(fileNamePartsMod.length < fileNameParts.length);
+    const fileNameMod = fileNamePartsMod.join('.');
+    return path.posix.join(path.posix.dirname(filePath), fileNameMod);
+}
+// Needed for the npm package 'source-map-support'. The Error.prepareStackTrace() hook of 'source-map-support' needs to be called before the file containing the source map is removed. The clean() call above removes the transpiled file from disk but it contains the inline source map.
+function triggerPrepareStackTrace(err) {
+    if (isObject(err)) {
+        // Accessing err.stack triggers prepareStackTrace()
+        const { stack } = err;
+        // Ensure no compiler removes the line above
+        if (1 + 1 === 3)
+            console.log('I_AM_NEVER_SHOWN' + stack);
+    }
+}
+function getErrIntroMsg(operation, filePath) {
+    const { filePathToShowToUserResolved } = filePath;
+    const msg = `${pc.red(`Failed to ${operation}`)} ${pc.bold(pc.red(filePathToShowToUserResolved))} ${pc.red(`because:`)}`;
+    return msg;
+}
+function cleanEsbuildErrors(errors) {
+    errors.forEach((e) => (e.notes = e.notes.filter((note) => 
+    // Remove note:
+    // ```shell
+    // You can mark the path "#root/renderer/onRenderHtml_typo" as external to exclude it from the bundle, which will remove this error and leave the unresolved path in the bundle.
+    // ```
+    //
+    // From error:
+    // ```shell
+    // ✘ [ERROR] Could not resolve "#root/renderer/onRenderHtml_typo" [plugin vike-esbuild]
+    //
+    //    renderer/+config.h.js:1:29:
+    //      1 │ import { onRenderHtml } from "#root/renderer/onRenderHtml_typo"
+    //        ╵                              ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+    //
+    //  You can mark the path "#root/renderer/onRenderHtml_typo" as external to exclude it from the bundle, which will remove this error and leave the unresolved path in the bundle.
+    //
+    // ```
+    !note.text.includes('as external to exclude it from the bundle'))));
+}
+function installSourceMapSupport() {
+    // Don't break Vitest's source mapping
+    if (isVitest())
+        return;
+    // How about other test runners?
+    // Should we call installSourceMapSupport() lazily in transpileAndExecuteFile() instead?
+    sourceMapSupport.install();
+}

package/dist/node/vite/shared/resolveVikeConfigInternal.d.ts

@@ -0,0 +1,70 @@
+export { getVikeConfig };
+export type { VikeConfig };
+export { getVikeConfigInternal };
+export { getVikeConfigInternalOptional };
+export { setVikeConfigContext };
+export { isVikeConfigContextSet };
+export { reloadVikeConfig };
+export { isV1Design };
+export { getConfVal };
+export { getConfigDefinitionOptional };
+export { getVikeConfigFromCliOrEnv };
+export type { VikeConfigInternal };
+export type { PageConfigBuildTimeBeforeComputed };
+import type { PageConfigGlobalBuildTime, PageConfigBuildTime } from '../../../types/PageConfig.js';
+import { type ConfigDefinitionsInternal, type ConfigDefinitionInternal } from './resolveVikeConfigInternal/configDefinitionsBuiltIn.js';
+import { type GlobalConfigPublic } from '../../../shared-server-client/page-configs/resolveVikeConfigPublic.js';
+import { type PlusFile } from './resolveVikeConfigInternal/getPlusFilesAll.js';
+import type { PrerenderContextPublic } from '../../prerender/runPrerender.js';
+import type { ResolvedConfig, UserConfig } from 'vite';
+import { type DangerouslyUseInternals } from '../../../shared-server-client/getProxyForPublicUsage.js';
+type VikeConfigContext = {
+    userRootDir: string;
+    isDev: boolean;
+    vikeVitePluginOptions: unknown;
+};
+type PrerenderContext = {
+    isPrerenderingEnabled: boolean;
+    isPrerenderingEnabledForAllPages: boolean;
+} & ({
+    [K in keyof PrerenderContextPublic]: null;
+} | PrerenderContextPublic);
+type VikeConfigInternal = GlobalConfigPublic & {
+    _pageConfigs: PageConfigBuildTime[];
+    _pageConfigGlobal: PageConfigGlobalBuildTime;
+    _vikeConfigDependencies: Set<string>;
+    prerenderContext: PrerenderContext;
+};
+declare function reloadVikeConfig(): void;
+declare function getVikeConfigInternal(doNotRestartViteOnError?: boolean): Promise<VikeConfigInternal>;
+/**
+ * Get all the information Vike knows about the app in your Vite plugin.
+ *
+ * https://vike.dev/getVikeConfig
+ */
+declare function getVikeConfig(
+/** @deprecated the `config` argument isn't needed anymore — remove it (it doesn't have any effect) */
+_config?: ResolvedConfig | UserConfig): VikeConfig;
+type VikeConfig = Pick<VikeConfigInternal, 'config' | 'pages' | 'prerenderContext'> & {
+    /** https://vike.dev/warning/internals */
+    dangerouslyUseInternals: DangerouslyUseInternals<VikeConfigInternal>;
+};
+declare function setVikeConfigContext(vikeConfigCtx_: VikeConfigContext): void;
+declare function isVikeConfigContextSet(): boolean;
+declare function getVikeConfigInternalOptional(): Promise<null | VikeConfigInternal>;
+declare function isV1Design(): boolean;
+declare function getVikeConfigFromCliOrEnv(): {
+    vikeConfigFromCliOrEnv: {
+        [x: string]: unknown;
+    };
+    configFromCliOptions: import("../../cli/parseCli.js").CliOptions | null;
+    configFromEnvVar: Record<string, unknown> | null;
+};
+type PageConfigBuildTimeBeforeComputed = Omit<PageConfigBuildTime, 'configValuesComputed'>;
+declare function getConfigDefinitionOptional(configDefinitions: ConfigDefinitionsInternal, configName: string): ConfigDefinitionInternal | null;
+declare function getConfVal(plusFile: PlusFile, configName: string): null | {
+    value: unknown;
+    valueIsLoaded: true;
+} | {
+    valueIsLoaded: false;
+};