vike
Version:
The Framework *You* Control - Next.js & Nuxt alternative for unprecedented flexibility and dependability.
126 lines (123 loc) • 5.85 kB
JavaScript
export { getPlusFilesAll };
import { assert } from '../../utils.js';
import { configDefinitionsBuiltIn } from './configDefinitionsBuiltIn.js';
import { getLocationId } from './filesystemRouting.js';
import { crawlPlusFiles, getPlusFileValueConfigName } from './crawlPlusFiles.js';
import { getConfigFileExport } from './getConfigFileExport.js';
import { loadConfigFile, loadValueFile } from './loadFileAtConfigTime.js';
import { resolvePointerImport } from './resolvePointerImport.js';
import { getFilePathResolved } from '../getFilePath.js';
import { assertExtensionsConventions, assertExtensionsRequire } from './assertExtensions.js';
async function getPlusFilesAll(userRootDir, esbuildCache) {
const plusFiles = await findPlusFiles(userRootDir);
const configFiles = [];
const valueFiles = [];
plusFiles.forEach((f) => {
if (getPlusFileValueConfigName(f.filePathAbsoluteFilesystem) === 'config') {
configFiles.push(f);
}
else {
valueFiles.push(f);
}
});
let plusFilesAll = {};
await Promise.all([
// Config files
...configFiles.map(async (filePath) => {
const { filePathAbsoluteUserRootDir } = filePath;
assert(filePathAbsoluteUserRootDir);
const { configFile, extendsConfigs } = await loadConfigFile(filePath, userRootDir, [], false, esbuildCache);
assert(filePath.filePathAbsoluteUserRootDir);
const locationId = getLocationId(filePathAbsoluteUserRootDir);
const plusFile = getPlusFileFromConfigFile(configFile, false, locationId, userRootDir);
plusFilesAll[locationId] = plusFilesAll[locationId] ?? [];
plusFilesAll[locationId].push(plusFile);
extendsConfigs.forEach((extendsConfig) => {
/* We purposely use the same locationId because the Vike extension's config should only apply to where it's being extended from, for example:
```js
// /pages/admin/+config.js
import vikeVue from 'vike-vue/config'
// Should only apply to /pages/admin/**
export default { extends: [vikeVue] }
```
```js
// /pages/marketing/+config.js
import vikeReact from 'vike-react/config'
// Should only apply to /pages/marketing/**
export default { extends: [vikeReact] }
```
*/
const plusFile = getPlusFileFromConfigFile(extendsConfig, true, locationId, userRootDir);
assertExtensionsConventions(plusFile);
plusFilesAll[locationId].push(plusFile);
});
}),
// Value files
...valueFiles.map(async (filePath) => {
const { filePathAbsoluteUserRootDir } = filePath;
assert(filePathAbsoluteUserRootDir);
const configName = getPlusFileValueConfigName(filePathAbsoluteUserRootDir);
assert(configName);
const locationId = getLocationId(filePathAbsoluteUserRootDir);
const plusFile = {
locationId,
filePath,
isConfigFile: false,
isNotLoaded: true,
configName,
};
plusFilesAll[locationId] = plusFilesAll[locationId] ?? [];
plusFilesAll[locationId].push(plusFile);
// We don't have access to the custom config definitions defined by the user yet.
// - If `configDef` is `undefined` => we load the file +{configName}.js later.
// - We already need to load +meta.js here (to get the custom config definitions defined by the user)
await loadValueFile(plusFile, configDefinitionsBuiltIn, userRootDir, esbuildCache);
}),
]);
// Make lists element order deterministic
Object.entries(plusFilesAll).forEach(([_locationId, plusFiles]) => {
plusFiles.sort(sortMakeDeterministic);
});
assertPlusFiles(plusFilesAll);
return plusFilesAll;
}
function assertPlusFiles(plusFilesAll) {
const plusFiles = Object.values(plusFilesAll).flat();
// The earlier we call it the better, so that +require can be used by Vike extensions to depend on new Vike features
assertExtensionsRequire(plusFiles);
}
function getPlusFileFromConfigFile(configFile, isExtensionConfig, locationId, userRootDir) {
const { fileExports, filePath, extendsFilePaths } = configFile;
const fileExportsByConfigName = {};
const pointerImportsByConfigName = {};
const fileExport = getConfigFileExport(fileExports, filePath.filePathToShowToUser);
Object.entries(fileExport).forEach(([configName, configValue]) => {
fileExportsByConfigName[configName] = configValue;
const pointerImport = resolvePointerImport(configValue, configFile.filePath, userRootDir, configName);
if (pointerImport) {
pointerImportsByConfigName[configName] = {
...pointerImport,
fileExportValueLoaded: false,
};
}
});
const plusFile = {
locationId,
filePath,
fileExportsByConfigName,
pointerImportsByConfigName,
isConfigFile: true,
isExtensionConfig,
extendsFilePaths,
};
return plusFile;
}
// Make order deterministic (no other purpose)
function sortMakeDeterministic(plusFile1, plusFile2) {
return plusFile1.filePath.filePathAbsoluteVite < plusFile2.filePath.filePathAbsoluteVite ? -1 : 1;
}
async function findPlusFiles(userRootDir) {
const files = await crawlPlusFiles(userRootDir);
const plusFiles = files.map(({ filePathAbsoluteUserRootDir }) => getFilePathResolved({ filePathAbsoluteUserRootDir, userRootDir }));
return plusFiles;
}