vike 0.4.223 → 0.4.224-commit-00ed9fe

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

@@ -1,53 +1,45 @@
 export { crawlPlusFiles };
 export { isPlusFile };
 export { getPlusFileValueConfigName };
-import { assertPosixPath, assert, scriptFileExtensions, assertIsSingleModuleInstance, assertIsNotProductionRuntime, isVersionOrAbove, isScriptFile, scriptFileExtensionList, createDebugger, deepEqual, assertUsage } from '../../../../utils.js';
+import { assertPosixPath, assert, scriptFileExtensions, assertIsSingleModuleInstance, assertIsNotProductionRuntime, isVersionOrAbove, isScriptFile, scriptFileExtensionList, createDebugger, deepEqual, assertUsage, assertFilePathAbsoluteFilesystem, assertWarning, hasProp, isNotNullish } from '../../../../utils.js';
 import path from 'path';
-import glob from 'fast-glob';
+import { glob } from 'tinyglobby';
 import { exec } from 'child_process';
 import { promisify } from 'util';
 import { isTemporaryBuildFile } from './transpileAndExecuteFile.js';
 import { getEnvVarObject } from '../../../../shared/getEnvVarObject.js';
+import pc from '@brillout/picocolors';
+import picomatch from 'picomatch';
+import { ignorePatternsBuiltIn } from './crawlPlusFiles/ignorePatternsBuiltIn.js';
 const execA = promisify(exec);
 const debug = createDebugger('vike:crawl');
 assertIsNotProductionRuntime();
 assertIsSingleModuleInstance('getVikeConfig/crawlPlusFiles.ts');
 let gitIsNotUsable = false;
-async function crawlPlusFiles(userRootDir, outDirAbsoluteFilesystem) {
+async function crawlPlusFiles(userRootDir) {
     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
-    }
-    //*/
-    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('../')));
+    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;
     assert(files);
-    if (debug.isActivated)
-        assert(deepEqual(filesGlob, filesGit), "Git and glob results aren't matching.");
+    if (debug.isActivated) {
+        assert(filesGit);
+        assert(filesGlob);
+        assertWarning(deepEqual(filesGlob.slice().sort(), filesGit.slice().sort()), "Git and glob results aren't matching.", { onlyOnce: false });
+    }
     // Filter build files
     files = files.filter((filePath) => !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
         assertPosixPath(filePath);
         assert(!filePath.startsWith(userRootDir));
         const filePathAbsoluteUserRootDir = path.posix.join('/', filePath);
@@ -56,8 +48,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.
@@ -65,8 +57,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,
@@ -76,7 +66,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'
@@ -111,7 +101,7 @@ async function gitLsFiles(userRootDir, outDirRelativeFromUserRootDir) {
         if (!path.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 (!isScriptFile(filePath))
@@ -123,11 +113,11 @@ 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 = `**/+*.${scriptFileExtensions}`;
     const options = {
-        ignore: getIgnoreAsPatterns(outDirRelativeFromUserRootDir),
+        ignore: ignorePatterns,
         cwd: userRootDir,
         dot: false
     };
@@ -142,32 +132,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) {
-        assert(!outDirRelativeFromUserRootDir.startsWith('/'));
-        ignoreAsPatterns.push(`${outDirRelativeFromUserRootDir}/**`);
-    }
-    return ignoreAsPatterns;
-}
-// Same as getIgnoreAsPatterns() but for Array.filter()
-function getIgnoreAsFilterFn(outDirRelativeFromUserRootDir) {
-    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
@@ -222,9 +186,19 @@ async function runCmd2(cmd, cwd) {
     stderr = stderr.toString().trim();
     return { stdout, stderr };
 }
-function isGitCrawlDisabled() {
-    const crawSettings = getEnvVarObject('VIKE_CRAWL');
-    return crawSettings?.git === false;
+function getUserSettings() {
+    const userSettings = getEnvVarObject('VIKE_CRAWL') ?? {};
+    const wrongUsage = (settingName, settingType) => `Setting ${pc.cyan(settingName)} in VIKE_CRAWL should be a ${pc.cyan(settingType)}`;
+    assertUsage(hasProp(userSettings, 'git', 'boolean') || hasProp(userSettings, 'git', 'undefined'), wrongUsage('git', 'boolean'));
+    assertUsage(hasProp(userSettings, 'ignore', 'string[]') ||
+        hasProp(userSettings, 'ignore', 'string') ||
+        hasProp(userSettings, 'ignore', 'undefined'), wrongUsage('git', 'string or an array of strings'));
+    assertUsage(hasProp(userSettings, 'ignoreBuiltIn', 'boolean') || hasProp(userSettings, 'ignoreBuiltIn', 'undefined'), wrongUsage('ignoreBuiltIn', 'boolean'));
+    const settingNames = ['git', 'ignore', 'ignoreBuiltIn'];
+    Object.keys(userSettings).forEach((name) => {
+        assertUsage(settingNames.includes(name), `Unknown setting ${pc.bold(pc.red(name))} in VIKE_CRAWL`);
+    });
+    return userSettings;
 }
 function isPlusFile(filePath) {
     assertPosixPath(filePath);
@@ -260,3 +234,15 @@ function assertNoUnexpectedPlusSign(filePath: string, fileName: string) {
   )
 }
 */
+function getIgnore(userSettings) {
+    const ignorePatternsSetByUser = [userSettings.ignore].flat().filter(isNotNullish);
+    const { ignoreBuiltIn } = userSettings;
+    const ignorePatterns = [...(ignoreBuiltIn === false ? [] : ignorePatternsBuiltIn), ...ignorePatternsSetByUser];
+    const ignoreMatchers = ignorePatterns.map((p) => picomatch(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/esm/node/plugin/plugins/importUserCode/v1-design/getVikeConfig/filesystemRouting.js

@@ -40,6 +40,7 @@ function getLogicalPath(locationId, ignoredDirs, removeParenthesesDirs) {
     assertIsPath(logicalPath);
     return logicalPath;
 }
+// See getPlusFilesRelevant() and getPlusFilesOrdered()
 function sortAfterInheritanceOrder(locationId1, locationId2, locationIdPage) {
     assertLocationId(locationId1);
     assertLocationId(locationId2);
@@ -48,7 +49,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
     assert(isInherited(locationId1, locationIdPage));
     assert(isInherited(locationId2, locationIdPage));
     // Equivalent assertion (see isInherited() implementation)

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

@@ -9,7 +9,7 @@ import { resolvePointerImport } from './resolvePointerImport.js';
 import { getFilePathResolved } from '../../../../shared/getFilePath.js';
 import { assertExtensionsConventions } from './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) => {
@@ -112,8 +112,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 crawlPlusFiles(userRootDir, outDirRoot);
+async function findPlusFiles(userRootDir) {
+    const files = await crawlPlusFiles(userRootDir);
     const plusFiles = files.map(({ filePathAbsoluteUserRootDir }) => getFilePathResolved({ filePathAbsoluteUserRootDir, userRootDir }));
     return plusFiles;
 }

package/dist/esm/node/plugin/plugins/importUserCode/v1-design/getVikeConfig/transpileAndExecuteFile.d.ts

@@ -3,7 +3,6 @@ export { getConfigBuildErrorFormatted };
 export { getConfigExecutionErrorIntroMsg };
 export { isTemporaryBuildFile };
 export type { EsbuildCache };
-import 'source-map-support/register.js';
 import type { FilePathResolved } from '../../../../../../shared/page-configs/FilePath.js';
 type FileExports = {
     fileExports: Record<string, unknown>;

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

@@ -7,16 +7,17 @@ import fs from 'fs';
 import path from 'path';
 import pc from '@brillout/picocolors';
 import { import_ } from '@brillout/import';
-import { assertPosixPath, getRandomId, assertIsNotProductionRuntime, assert, assertWarning, isObject, toPosixPath, assertUsage, isPlainJavaScriptFile, createDebugger, assertFilePathAbsoluteFilesystem, assertIsNpmPackageImport, genPromise } from '../../../../utils.js';
+import { assertPosixPath, getRandomId, assertIsNotProductionRuntime, assert, assertWarning, isObject, toPosixPath, assertUsage, isPlainJavaScriptFile, createDebugger, assertFilePathAbsoluteFilesystem, assertIsNpmPackageImport, genPromise, isVitest } from '../../../../utils.js';
 import { transformPointerImports } from './transformPointerImports.js';
 import { vikeConfigDependencies } from '../getVikeConfig.js';
-import 'source-map-support/register.js';
+import sourceMapSupport from 'source-map-support';
 import { getFilePathAbsoluteUserRootDir } from '../../../../shared/getFilePath.js';
 import { createRequire } from 'module';
-// @ts-ignore Shimmed by dist-cjs-fixup.js for CJS build.
+// @ts-ignore import.meta.url is shimmed at dist/cjs by dist-cjs-fixup.js.
 const importMetaUrl = import.meta.url;
 const require_ = createRequire(importMetaUrl);
 assertIsNotProductionRuntime();
+installSourceMapSupport();
 const debug = createDebugger('vike:pointer-imports');
 const debugEsbuildResolve = createDebugger('vike:esbuild-resolve');
 if (debugEsbuildResolve.isActivated)
@@ -163,14 +164,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
                     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
-                        assert(!isPointerImport && !isNodeModules);
+                        assert(!isPointerImport && !isNpmPkgImport);
                         if (debug.isActivated)
                             debug('onResolved()', { args, resolved, isPointerImport, isExternal });
                         return resolved;
@@ -189,7 +193,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.
@@ -211,7 +215,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 };
                 });
@@ -398,3 +402,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 (isVitest())
+        return;
+    // How about other test runners?
+    // Should we call installSourceMapSupport() lazily in transpileAndExecuteFile() instead?
+    sourceMapSupport.install();
+}

package/dist/esm/node/plugin/plugins/importUserCode/v1-design/getVikeConfig.d.ts

@@ -5,10 +5,11 @@ export { vikeConfigDependencies };
 export { isV1Design };
 export { getConfVal };
 export { getConfigDefinitionOptional };
+export { isOverriden };
 export type { VikeConfigObject };
-import type { PageConfigGlobalBuildTime, PageConfigBuildTime } from '../../../../../shared/page-configs/PageConfig.js';
+import type { PageConfigGlobalBuildTime, ConfigValueSource, PageConfigBuildTime } from '../../../../../shared/page-configs/PageConfig.js';
 import { type ConfigDefinitions, type ConfigDefinitionInternal } from './getVikeConfig/configDefinitionsBuiltIn.js';
-import type { ResolvedConfig } from 'vite';
+import type { ResolvedConfig, UserConfig } from 'vite';
 import { type PageConfigUserFriendly, type PageConfigsUserFriendly } from '../../../../../shared/page-configs/getPageConfigUserFriendly.js';
 import { type PlusFile } from './getVikeConfig/getPlusFilesAll.js';
 type VikeConfigObject = {
@@ -23,11 +24,12 @@ declare function getVikeConfig(config: ResolvedConfig, { doNotRestartViteOnError
     doNotRestartViteOnError?: true;
 }): Promise<VikeConfigObject>;
 declare function getVikeConfig2(userRootDir: string, isDev: boolean, vikeVitePluginOptions: unknown): Promise<VikeConfigObject>;
-declare function isV1Design(config: ResolvedConfig): Promise<boolean>;
+declare function isV1Design(config: ResolvedConfig | UserConfig): boolean;
 declare function getConfigDefinitionOptional(configDefinitions: ConfigDefinitions, configName: string): ConfigDefinitionInternal | null;
 declare function getConfVal(plusFile: PlusFile, configName: string): null | {
-    configValue: unknown;
-    configValueLoaded: true;
+    value: unknown;
+    valueIsLoaded: true;
 } | {
-    configValueLoaded: false;
+    valueIsLoaded: false;
 };
+declare function isOverriden(source: ConfigValueSource, configName: string, pageConfig: PageConfigBuildTime | PageConfigGlobalBuildTime): boolean;