vike 0.4.223 → 0.4.224-commit-00ed9fe

package/dist/cjs/node/plugin/plugins/importUserCode/v1-design/getVikeConfig/assertExtensions.js

@@ -34,7 +34,7 @@ function assertExtensionName(plusFile) {
     (0, utils_js_1.assertUsage)(name, `Vike extension name missing: the config ${filePathToShowToUser} must define the setting ${picocolors_1.default.cyan('name')}`);
 }
 function assertExtensionsRequire(pageConfig) {
-    const plusFilesRelevantList = Object.values(pageConfig.plusFiles).flat(1);
+    const plusFilesRelevantList = pageConfig.plusFiles;
     // Collect extensions
     const extensions = {};
     plusFilesRelevantList.forEach((plusFile) => {
@@ -68,8 +68,8 @@ function getConfigRequireValue(plusFile) {
     const confVal = (0, getVikeConfig_js_1.getConfVal)(plusFile, 'require');
     if (!confVal)
         return null;
-    (0, utils_js_1.assert)(confVal.configValueLoaded);
-    const require = confVal.configValue;
+    (0, utils_js_1.assert)(confVal.valueIsLoaded);
+    const require = confVal.value;
     const { filePathToShowToUserResolved } = plusFile.filePath;
     (0, utils_js_1.assert)(filePathToShowToUserResolved);
     (0, utils_js_1.assertUsage)((0, isObjectOfStrings_js_1.isObjectOfStrings)(require), `The setting ${picocolors_1.default.bold('require')} defined at ${filePathToShowToUserResolved} should be an object with string values (${picocolors_1.default.bold('Record<string, string>')}).`);
@@ -79,8 +79,8 @@ function getNameValue(plusFile) {
     const confVal = (0, getVikeConfig_js_1.getConfVal)(plusFile, 'name');
     if (!confVal)
         return null;
-    (0, utils_js_1.assert)(confVal.configValueLoaded);
-    const name = confVal.configValue;
+    (0, utils_js_1.assert)(confVal.valueIsLoaded);
+    const name = confVal.value;
     const filePathToShowToUser = getFilePathToShowToUser(plusFile);
     (0, utils_js_1.assertUsage)(typeof name === 'string', `The setting ${picocolors_1.default.bold('name')} defined at ${filePathToShowToUser} should be a string.`);
     return name;

package/dist/cjs/node/plugin/plugins/importUserCode/v1-design/getVikeConfig/configDefinitionsBuiltIn.js

@@ -33,7 +33,12 @@ const configDefinitionsBuiltIn = {
         cumulative: true
     },
     route: {
-        env: { server: true, client: 'if-client-routing' },
+        env: {
+            server: true,
+            client: 'if-client-routing',
+            // For vite-plugin-vercel
+            config: true
+        },
         eager: true
     },
     guard: {
@@ -159,7 +164,7 @@ const configDefinitionsBuiltIn = {
             'string'
         ]
     },
-    viteEnvironmentAPI: {
+    vite6BuilderApp: {
         env: { config: true },
         global: true,
         type: 'boolean'

package/dist/cjs/node/plugin/plugins/importUserCode/v1-design/getVikeConfig/crawlPlusFiles/ignorePatternsBuiltIn.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ignorePatternsBuiltIn = void 0;
+exports.ignorePatternsBuiltIn = [
+    '**/node_modules/**',
+    // Ejected Vike extensions, see https://github.com/snake-py/eject
+    '**/ejected/**',
+    // Allow:
+    // ```bash
+    // +Page.js
+    // +Page.telefunc.js
+    // ```
+    '**/*.telefunc.*',
+    // https://github.com/vikejs/vike/discussions/2222
+    '**/*.generated.*'
+];

package/dist/cjs/node/plugin/plugins/importUserCode/v1-design/getVikeConfig/crawlPlusFiles.js

@@ -8,51 +8,43 @@ exports.isPlusFile = isPlusFile;
 exports.getPlusFileValueConfigName = getPlusFileValueConfigName;
 const utils_js_1 = require("../../../../utils.js");
 const path_1 = __importDefault(require("path"));
-const fast_glob_1 = __importDefault(require("fast-glob"));
+const tinyglobby_1 = require("tinyglobby");
 const child_process_1 = require("child_process");
 const util_1 = require("util");
 const transpileAndExecuteFile_js_1 = require("./transpileAndExecuteFile.js");
 const getEnvVarObject_js_1 = require("../../../../shared/getEnvVarObject.js");
+const picocolors_1 = __importDefault(require("@brillout/picocolors"));
+const picomatch_1 = __importDefault(require("picomatch"));
+const ignorePatternsBuiltIn_js_1 = require("./crawlPlusFiles/ignorePatternsBuiltIn.js");
 const execA = (0, util_1.promisify)(child_process_1.exec);
 const debug = (0, utils_js_1.createDebugger)('vike:crawl');
 (0, utils_js_1.assertIsNotProductionRuntime)();
 (0, utils_js_1.assertIsSingleModuleInstance)('getVikeConfig/crawlPlusFiles.ts');
 let gitIsNotUsable = false;
-async function crawlPlusFiles(userRootDir, outDirAbsoluteFilesystem) {
+async function crawlPlusFiles(userRootDir) {
     (0, utils_js_1.assertPosixPath)(userRootDir);
-    //*/
-    const outDirRelativeFromUserRootDir = null;
-    /*/
-    assertPosixPath(outDirAbsoluteFilesystem)
-    let outDirRelativeFromUserRootDir: string | null = path.posix.relative(userRootDir, outDirAbsoluteFilesystem)
-    if (outDirRelativeFromUserRootDir.startsWith('../')) {
-      // config.outDir is outside of config.root => it's going to be ignored anyways
-      outDirRelativeFromUserRootDir = null
-    }
-    //*/
-    (0, utils_js_1.assert)(outDirRelativeFromUserRootDir === null ||
-        /* Not true if outDirRelativeFromUserRootDir starts with a hidden directory (i.e. a directory with a name that starts with `.`)
-        !outDirRelativeFromUserRootDir.startsWith('.') &&
-        */
-        (!outDirRelativeFromUserRootDir.startsWith('./') &&
-            //
-            !outDirRelativeFromUserRootDir.startsWith('../')));
+    (0, utils_js_1.assertFilePathAbsoluteFilesystem)(userRootDir);
+    const userSettings = getUserSettings();
+    const { ignorePatterns, ignoreMatchers } = getIgnore(userSettings);
     // Crawl
-    const filesGit = !isGitCrawlDisabled() && (await gitLsFiles(userRootDir, outDirRelativeFromUserRootDir));
+    const filesGit = userSettings.git !== false && (await gitLsFiles(userRootDir, ignorePatterns, ignoreMatchers));
     const filesGitNothingFound = !filesGit || filesGit.length === 0;
-    const filesGlob = (filesGitNothingFound || debug.isActivated) && (await fastGlob(userRootDir, outDirRelativeFromUserRootDir));
+    const filesGlob = (filesGitNothingFound || debug.isActivated) && (await tinyglobby(userRootDir, ignorePatterns));
     let files = !filesGitNothingFound
         ? filesGit
-        : // Fallback to fast-glob for users that dynamically generate plus files. (Assuming that no plus file is found because of the user's .gitignore list.)
+        : // Fallback to tinyglobby for users that dynamically generate plus files. (Assuming that no plus file is found because of the user's .gitignore list.)
             filesGlob;
     (0, utils_js_1.assert)(files);
-    if (debug.isActivated)
-        (0, utils_js_1.assert)((0, utils_js_1.deepEqual)(filesGlob, filesGit), "Git and glob results aren't matching.");
+    if (debug.isActivated) {
+        (0, utils_js_1.assert)(filesGit);
+        (0, utils_js_1.assert)(filesGlob);
+        (0, utils_js_1.assertWarning)((0, utils_js_1.deepEqual)(filesGlob.slice().sort(), filesGit.slice().sort()), "Git and glob results aren't matching.", { onlyOnce: false });
+    }
     // Filter build files
     files = files.filter((filePath) => !(0, transpileAndExecuteFile_js_1.isTemporaryBuildFile)(filePath));
     // Normalize
     const plusFiles = files.map((filePath) => {
-        // Both `$ git-ls files` and fast-glob return posix paths
+        // Both `$ git-ls files` and tinyglobby return posix paths
         (0, utils_js_1.assertPosixPath)(filePath);
         (0, utils_js_1.assert)(!filePath.startsWith(userRootDir));
         const filePathAbsoluteUserRootDir = path_1.default.posix.join('/', filePath);
@@ -61,8 +53,8 @@ async function crawlPlusFiles(userRootDir, outDirAbsoluteFilesystem) {
     });
     return plusFiles;
 }
-// Same as fastGlob() but using `$ git ls-files`
-async function gitLsFiles(userRootDir, outDirRelativeFromUserRootDir) {
+// Same as tinyglobby() but using `$ git ls-files`
+async function gitLsFiles(userRootDir, ignorePatterns, ignoreMatchers) {
     if (gitIsNotUsable)
         return null;
     // Preserve UTF-8 file paths.
@@ -70,8 +62,6 @@ async function gitLsFiles(userRootDir, outDirRelativeFromUserRootDir) {
     // https://stackoverflow.com/questions/22827239/how-to-make-git-properly-display-utf-8-encoded-pathnames-in-the-console-window/22828826#22828826
     // https://stackoverflow.com/questions/15884180/how-do-i-override-git-configuration-options-by-command-line-parameters/15884261#15884261
     const preserveUTF8 = '-c core.quotepath=off';
-    const ignoreAsPatterns = getIgnoreAsPatterns(outDirRelativeFromUserRootDir);
-    const ignoreAsFilterFn = getIgnoreAsFilterFn(outDirRelativeFromUserRootDir);
     const cmd = [
         'git',
         preserveUTF8,
@@ -81,7 +71,7 @@ async function gitLsFiles(userRootDir, outDirRelativeFromUserRootDir) {
         // Performance gain is non-negligible.
         //  - https://github.com/vikejs/vike/pull/1688#issuecomment-2166206648
         //  - When node_modules/ is untracked the performance gain could be significant?
-        ...ignoreAsPatterns.map((pattern) => `--exclude="${pattern}"`),
+        ...ignorePatterns.map((pattern) => `--exclude="${pattern}"`),
         // --others --exclude-standard => list untracked files (--others) while using .gitignore (--exclude-standard)
         // --cached => list tracked files
         '--others --exclude-standard --cached'
@@ -116,7 +106,7 @@ async function gitLsFiles(userRootDir, outDirRelativeFromUserRootDir) {
         if (!path_1.default.posix.basename(filePath).startsWith('+'))
             continue;
         // We have to repeat the same exclusion logic here because the option --exclude of `$ git ls-files` only applies to untracked files. (We use --exclude only to speed up the `$ git ls-files` command.)
-        if (!ignoreAsFilterFn(filePath))
+        if (ignoreMatchers.some((m) => m(filePath)))
             continue;
         // JavaScript file?
         if (!(0, utils_js_1.isScriptFile)(filePath))
@@ -128,15 +118,15 @@ async function gitLsFiles(userRootDir, outDirRelativeFromUserRootDir) {
     }
     return files;
 }
-// Same as gitLsFiles() but using fast-glob
-async function fastGlob(userRootDir, outDirRelativeFromUserRootDir) {
+// Same as gitLsFiles() but using tinyglobby
+async function tinyglobby(userRootDir, ignorePatterns) {
     const pattern = `**/+*.${utils_js_1.scriptFileExtensions}`;
     const options = {
-        ignore: getIgnoreAsPatterns(outDirRelativeFromUserRootDir),
+        ignore: ignorePatterns,
         cwd: userRootDir,
         dot: false
     };
-    const files = await (0, fast_glob_1.default)(pattern, options);
+    const files = await (0, tinyglobby_1.glob)(pattern, options);
     // Make build deterministic, in order to get a stable generated hash for dist/client/assets/entries/entry-client-routing.${hash}.js
     // https://github.com/vikejs/vike/pull/1750
     files.sort();
@@ -147,32 +137,6 @@ async function fastGlob(userRootDir, outDirRelativeFromUserRootDir) {
     }
     return files;
 }
-// Same as getIgnoreAsFilterFn() but as glob pattern
-function getIgnoreAsPatterns(outDirRelativeFromUserRootDir) {
-    const ignoreAsPatterns = [
-        '**/node_modules/**',
-        '**/ejected/**',
-        // Allow:
-        // ```
-        // +Page.js
-        // +Page.telefunc.js
-        // ```
-        '**/*.telefunc.*'
-    ];
-    if (outDirRelativeFromUserRootDir) {
-        (0, utils_js_1.assert)(!outDirRelativeFromUserRootDir.startsWith('/'));
-        ignoreAsPatterns.push(`${outDirRelativeFromUserRootDir}/**`);
-    }
-    return ignoreAsPatterns;
-}
-// Same as getIgnoreAsPatterns() but for Array.filter()
-function getIgnoreAsFilterFn(outDirRelativeFromUserRootDir) {
-    (0, utils_js_1.assert)(outDirRelativeFromUserRootDir === null || !outDirRelativeFromUserRootDir.startsWith('/'));
-    return (file) => !file.includes('node_modules/') &&
-        !file.includes('ejected/') &&
-        !file.includes('.telefunc.') &&
-        (outDirRelativeFromUserRootDir === null || !file.startsWith(`${outDirRelativeFromUserRootDir}/`));
-}
 // Whether Git is installed and whether we can use it
 async function isGitNotUsable(userRootDir) {
     // Check Git version
@@ -227,9 +191,19 @@ async function runCmd2(cmd, cwd) {
     stderr = stderr.toString().trim();
     return { stdout, stderr };
 }
-function isGitCrawlDisabled() {
-    const crawSettings = (0, getEnvVarObject_js_1.getEnvVarObject)('VIKE_CRAWL');
-    return crawSettings?.git === false;
+function getUserSettings() {
+    const userSettings = (0, getEnvVarObject_js_1.getEnvVarObject)('VIKE_CRAWL') ?? {};
+    const wrongUsage = (settingName, settingType) => `Setting ${picocolors_1.default.cyan(settingName)} in VIKE_CRAWL should be a ${picocolors_1.default.cyan(settingType)}`;
+    (0, utils_js_1.assertUsage)((0, utils_js_1.hasProp)(userSettings, 'git', 'boolean') || (0, utils_js_1.hasProp)(userSettings, 'git', 'undefined'), wrongUsage('git', 'boolean'));
+    (0, utils_js_1.assertUsage)((0, utils_js_1.hasProp)(userSettings, 'ignore', 'string[]') ||
+        (0, utils_js_1.hasProp)(userSettings, 'ignore', 'string') ||
+        (0, utils_js_1.hasProp)(userSettings, 'ignore', 'undefined'), wrongUsage('git', 'string or an array of strings'));
+    (0, utils_js_1.assertUsage)((0, utils_js_1.hasProp)(userSettings, 'ignoreBuiltIn', 'boolean') || (0, utils_js_1.hasProp)(userSettings, 'ignoreBuiltIn', 'undefined'), wrongUsage('ignoreBuiltIn', 'boolean'));
+    const settingNames = ['git', 'ignore', 'ignoreBuiltIn'];
+    Object.keys(userSettings).forEach((name) => {
+        (0, utils_js_1.assertUsage)(settingNames.includes(name), `Unknown setting ${picocolors_1.default.bold(picocolors_1.default.red(name))} in VIKE_CRAWL`);
+    });
+    return userSettings;
 }
 function isPlusFile(filePath) {
     (0, utils_js_1.assertPosixPath)(filePath);
@@ -265,3 +239,15 @@ function assertNoUnexpectedPlusSign(filePath: string, fileName: string) {
   )
 }
 */
+function getIgnore(userSettings) {
+    const ignorePatternsSetByUser = [userSettings.ignore].flat().filter(utils_js_1.isNotNullish);
+    const { ignoreBuiltIn } = userSettings;
+    const ignorePatterns = [...(ignoreBuiltIn === false ? [] : ignorePatternsBuiltIn_js_1.ignorePatternsBuiltIn), ...ignorePatternsSetByUser];
+    const ignoreMatchers = ignorePatterns.map((p) => (0, picomatch_1.default)(p, {
+        // We must pass the same settings than tinyglobby
+        // https://github.com/SuperchupuDev/tinyglobby/blob/fcfb08a36c3b4d48d5488c21000c95a956d9797c/src/index.ts#L191-L194
+        dot: false,
+        nocase: false
+    }));
+    return { ignorePatterns, ignoreMatchers };
+}

package/dist/cjs/node/plugin/plugins/importUserCode/v1-design/getVikeConfig/filesystemRouting.js

@@ -44,6 +44,7 @@ function getLogicalPath(locationId, ignoredDirs, removeParenthesesDirs) {
     assertIsPath(logicalPath);
     return logicalPath;
 }
+// See getPlusFilesRelevant() and getPlusFilesOrdered()
 function sortAfterInheritanceOrder(locationId1, locationId2, locationIdPage) {
     assertLocationId(locationId1);
     assertLocationId(locationId2);
@@ -52,7 +53,7 @@ function sortAfterInheritanceOrder(locationId1, locationId2, locationIdPage) {
     const inheritanceRoot1 = getInheritanceRoot(locationId1);
     const inheritanceRoot2 = getInheritanceRoot(locationId2);
     const inheritanceRootPage = getInheritanceRoot(locationIdPage);
-    // sortAfterInheritanceOrder() only works if both locationId1 and locationId2 are inherited by the same page
+    // Only works if both locationId1 and locationId2 are inherited by the same page
     (0, utils_js_1.assert)(isInherited(locationId1, locationIdPage));
     (0, utils_js_1.assert)(isInherited(locationId2, locationIdPage));
     // Equivalent assertion (see isInherited() implementation)

package/dist/cjs/node/plugin/plugins/importUserCode/v1-design/getVikeConfig/getPlusFilesAll.js

@@ -11,7 +11,7 @@ const resolvePointerImport_js_1 = require("./resolvePointerImport.js");
 const getFilePath_js_1 = require("../../../../shared/getFilePath.js");
 const assertExtensions_js_1 = require("./assertExtensions.js");
 async function getPlusFilesAll(userRootDir, esbuildCache) {
-    const plusFiles = await findPlusFiles(userRootDir, null);
+    const plusFiles = await findPlusFiles(userRootDir);
     const configFiles = [];
     const valueFiles = [];
     plusFiles.forEach((f) => {
@@ -114,8 +114,8 @@ function getPlusFileFromConfigFile(configFile, isExtensionConfig, locationId, us
 function sortMakeDeterministic(plusFile1, plusFile2) {
     return plusFile1.filePath.filePathAbsoluteVite < plusFile2.filePath.filePathAbsoluteVite ? -1 : 1;
 }
-async function findPlusFiles(userRootDir, outDirRoot) {
-    const files = await (0, crawlPlusFiles_js_1.crawlPlusFiles)(userRootDir, outDirRoot);
+async function findPlusFiles(userRootDir) {
+    const files = await (0, crawlPlusFiles_js_1.crawlPlusFiles)(userRootDir);
     const plusFiles = files.map(({ filePathAbsoluteUserRootDir }) => (0, getFilePath_js_1.getFilePathResolved)({ filePathAbsoluteUserRootDir, userRootDir }));
     return plusFiles;
 }

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

@@ -15,13 +15,14 @@ const import_1 = require("@brillout/import");
 const utils_js_1 = require("../../../../utils.js");
 const transformPointerImports_js_1 = require("./transformPointerImports.js");
 const getVikeConfig_js_1 = require("../getVikeConfig.js");
-require("source-map-support/register.js");
+const source_map_support_1 = __importDefault(require("source-map-support"));
 const getFilePath_js_1 = require("../../../../shared/getFilePath.js");
 const module_1 = require("module");
-// @ts-ignore Shimmed by dist-cjs-fixup.js for CJS build.
+// @ts-ignore `file://${__filename}` is shimmed at dist/cjs by dist-cjs-fixup.js.
 const importMetaUrl = `file://${__filename}`;
 const require_ = (0, module_1.createRequire)(importMetaUrl);
 (0, utils_js_1.assertIsNotProductionRuntime)();
+installSourceMapSupport();
 const debug = (0, utils_js_1.createDebugger)('vike:pointer-imports');
 const debugEsbuildResolve = (0, utils_js_1.createDebugger)('vike:esbuild-resolve');
 if (debugEsbuildResolve.isActivated)
@@ -168,14 +169,17 @@ async function transpileWithEsbuild(filePath, userRootDir, transformImports) {
                         //      - 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;
+                    // Externalize npm package imports
                     (0, utils_js_1.assertPosixPath)(importPathResolved);
-                    const isNodeModules = importPathResolved.includes('/node_modules/');
+                    const isNpmPkgImport = importPathResolved.includes('/node_modules/') ||
+                        // Linked npm packages
+                        !importPathResolved.startsWith(userRootDir);
                     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.)
-                        isNodeModules;
+                        isNpmPkgImport;
                     if (!isExternal) {
                         // User-land config code (i.e. not runtime code) => let esbuild transpile it
-                        (0, utils_js_1.assert)(!isPointerImport && !isNodeModules);
+                        (0, utils_js_1.assert)(!isPointerImport && !isNpmPkgImport);
                         if (debug.isActivated)
                             debug('onResolved()', { args, resolved, isPointerImport, isExternal });
                         return resolved;
@@ -194,7 +198,7 @@ async function transpileWithEsbuild(filePath, userRootDir, transformImports) {
                             userRootDir
                         });
                         // We assuming that path aliases always resolve inside `userRootDir`.
-                        if (filePathAbsoluteUserRootDir && !isNodeModules) {
+                        if (filePathAbsoluteUserRootDir && !isNpmPkgImport) {
                             // `importPathOriginal` is a path alias.
                             // - We have to use esbuild's path alias resolution, because:
                             //   - Vike doesn't resolve path aliases at all.
@@ -216,7 +220,7 @@ async function transpileWithEsbuild(filePath, userRootDir, transformImports) {
                     // Import of runtime code => handled by Vike
                     isPointerImport ||
                         // Import of config code => loaded by Node.js at build-time
-                        isNodeModules);
+                        isNpmPkgImport);
                     pointerImports[importPathTranspiled] = isPointerImport;
                     return { external: true, path: importPathTranspiled };
                 });
@@ -403,3 +407,11 @@ function cleanEsbuildErrors(errors) {
     // ```
     !note.text.includes('as external to exclude it from the bundle'))));
 }
+function installSourceMapSupport() {
+    // Don't break Vitest's source mapping
+    if ((0, utils_js_1.isVitest)())
+        return;
+    // How about other test runners?
+    // Should we call installSourceMapSupport() lazily in transpileAndExecuteFile() instead?
+    source_map_support_1.default.install();
+}