Files
Library/node_modules/vitepress/dist/client/shared.js

244 lines
8.7 KiB
JavaScript
Raw Normal View History

2026-01-09 23:05:52 -05:00
export const EXTERNAL_URL_RE = /^(?:[a-z]+:|\/\/)/i;
export const APPEARANCE_KEY = 'vitepress-theme-appearance';
export const VP_SOURCE_KEY = '[VP_SOURCE]';
const UnpackStackView = Symbol('stack-view:unpack');
const HASH_RE = /#.*$/;
const HASH_OR_QUERY_RE = /[?#].*$/;
const INDEX_OR_EXT_RE = /(?:(^|\/)index)?\.(?:md|html)$/;
export const inBrowser = typeof document !== 'undefined';
export const notFoundPageData = {
relativePath: '404.md',
filePath: '',
title: '404',
description: 'Not Found',
headers: [],
frontmatter: { sidebar: false, layout: 'page' },
lastUpdated: 0,
isNotFound: true
};
export function isActive(currentPath, matchPath, asRegex = false) {
if (matchPath === undefined) {
return false;
}
currentPath = normalize(`/${currentPath}`);
if (asRegex) {
return new RegExp(matchPath).test(currentPath);
}
if (normalize(matchPath) !== currentPath) {
return false;
}
const hashMatch = matchPath.match(HASH_RE);
if (hashMatch) {
return (inBrowser ? location.hash : '') === hashMatch[0];
}
return true;
}
export function normalize(path) {
return decodeURI(path)
.replace(HASH_OR_QUERY_RE, '')
.replace(INDEX_OR_EXT_RE, '$1');
}
export function isExternal(path) {
return EXTERNAL_URL_RE.test(path);
}
export function getLocaleForPath(siteData, relativePath) {
return (Object.keys(siteData?.locales || {}).find((key) => key !== 'root' &&
!isExternal(key) &&
isActive(relativePath, `^/${key}/`, true)) || 'root');
}
/**
* this merges the locales data to the main data by the route
*/
export function resolveSiteDataByRoute(siteData, relativePath) {
const localeIndex = getLocaleForPath(siteData, relativePath);
const { label, link, ...localeConfig } = siteData.locales[localeIndex] ?? {};
Object.assign(localeConfig, { localeIndex });
const additionalConfigs = resolveAdditionalConfig(siteData, relativePath);
if (inBrowser && import.meta.env?.DEV) {
;
localeConfig[VP_SOURCE_KEY] = `locale config (${localeIndex})`;
reportConfigLayers(relativePath, [
...additionalConfigs,
localeConfig,
siteData
]);
}
const topLayer = {
head: mergeHead(siteData.head ?? [], localeConfig.head ?? [], ...additionalConfigs.map((data) => data.head ?? []).reverse())
};
return stackView(topLayer, ...additionalConfigs, localeConfig, siteData);
}
/**
* Create the page title string based on config.
*/
export function createTitle(siteData, pageData) {
const title = pageData.title || siteData.title;
const template = pageData.titleTemplate ?? siteData.titleTemplate;
if (typeof template === 'string' && template.includes(':title')) {
return template.replace(/:title/g, title);
}
const templateString = createTitleTemplate(siteData.title, template);
if (title === templateString.slice(3)) {
return title;
}
return `${title}${templateString}`;
}
function createTitleTemplate(siteTitle, template) {
if (template === false) {
return '';
}
if (template === true || template === undefined) {
return ` | ${siteTitle}`;
}
if (siteTitle === template) {
return '';
}
return ` | ${template}`;
}
export function mergeHead(...headArrays) {
const merged = [];
const metaKeyMap = new Map();
for (const current of headArrays) {
for (const tag of current) {
const [type, attrs] = tag;
const keyAttr = Object.entries(attrs)[0];
if (type !== 'meta' || !keyAttr) {
merged.push(tag);
continue;
}
const key = `${keyAttr[0]}=${keyAttr[1]}`;
const existingIndex = metaKeyMap.get(key);
if (existingIndex != null) {
merged[existingIndex] = tag; // replace existing tag
}
else {
metaKeyMap.set(key, merged.length);
merged.push(tag);
}
}
}
return merged;
}
// https://github.com/rollup/rollup/blob/fec513270c6ac350072425cc045db367656c623b/src/utils/sanitizeFileName.ts
const INVALID_CHAR_REGEX = /[\u0000-\u001F"#$&*+,:;<=>?[\]^`{|}\u007F]/g;
const DRIVE_LETTER_REGEX = /^[a-z]:/i;
export function sanitizeFileName(name) {
const match = DRIVE_LETTER_REGEX.exec(name);
const driveLetter = match ? match[0] : '';
return (driveLetter +
name
.slice(driveLetter.length)
.replace(INVALID_CHAR_REGEX, '_')
.replace(/(^|\/)_+(?=[^/]*$)/, '$1'));
}
export function slash(p) {
return p.replace(/\\/g, '/');
}
const KNOWN_EXTENSIONS = new Set();
export function treatAsHtml(filename) {
if (KNOWN_EXTENSIONS.size === 0) {
const extraExts = (typeof process === 'object' && process.env?.VITE_EXTRA_EXTENSIONS) ||
import.meta.env?.VITE_EXTRA_EXTENSIONS ||
'';
('3g2,3gp,aac,ai,apng,au,avif,bin,bmp,cer,class,conf,crl,css,csv,dll,' +
'doc,eps,epub,exe,gif,gz,ics,ief,jar,jpe,jpeg,jpg,js,json,jsonld,m4a,' +
'man,mid,midi,mjs,mov,mp2,mp3,mp4,mpe,mpeg,mpg,mpp,oga,ogg,ogv,ogx,' +
'opus,otf,p10,p7c,p7m,p7s,pdf,png,ps,qt,roff,rtf,rtx,ser,svg,t,tif,' +
'tiff,tr,ts,tsv,ttf,txt,vtt,wav,weba,webm,webp,woff,woff2,xhtml,xml,' +
'yaml,yml,zip' +
(extraExts && typeof extraExts === 'string' ? ',' + extraExts : ''))
.split(',')
.forEach((ext) => KNOWN_EXTENSIONS.add(ext));
}
const ext = filename.split('.').pop();
return ext == null || !KNOWN_EXTENSIONS.has(ext.toLowerCase());
}
// https://github.com/sindresorhus/escape-string-regexp/blob/ba9a4473850cb367936417e97f1f2191b7cc67dd/index.js
export function escapeRegExp(str) {
return str.replace(/[|\\{}()[\]^$+*?.]/g, '\\$&').replace(/-/g, '\\x2d');
}
/**
* @internal
*/
export function escapeHtml(str) {
return str
.replace(/</g, '&lt;')
.replace(/>/g, '&gt;')
.replace(/"/g, '&quot;')
.replace(/&(?![\w#]+;)/g, '&amp;');
}
function resolveAdditionalConfig({ additionalConfig }, path) {
if (additionalConfig === undefined)
return [];
if (typeof additionalConfig === 'function')
return additionalConfig(path) ?? [];
const configs = [];
const segments = path.split('/').slice(0, -1); // remove file name
while (segments.length) {
const key = `/${segments.join('/')}/`;
configs.push(additionalConfig[key]);
segments.pop();
}
configs.push(additionalConfig['/']);
return configs.filter((config) => config !== undefined);
}
// This helps users to understand which configuration files are active
function reportConfigLayers(path, layers) {
const summaryTitle = `Config Layers for ${path}:`;
const summary = layers.map((c, i, arr) => {
const n = i + 1;
if (n === arr.length)
return `${n}. .vitepress/config (root)`;
return `${n}. ${c?.[VP_SOURCE_KEY] ?? '(Unknown Source)'}`;
});
console.debug([summaryTitle, ''.padEnd(summaryTitle.length, '='), ...summary].join('\n'));
}
/**
* Creates a deep, merged view of multiple objects without mutating originals.
* Returns a readonly proxy behaving like a merged object of the input objects.
* Layers are merged in descending precedence, i.e. earlier layer is on top.
*/
export function stackView(..._layers) {
const layers = _layers.filter((layer) => isObject(layer));
if (layers.length <= 1)
return _layers[0];
const allKeys = new Set(layers.flatMap((layer) => Reflect.ownKeys(layer)));
const allKeysArray = [...allKeys];
return new Proxy({}, {
// TODO: optimize for performance, this is a hot path
get(_, prop) {
if (prop === UnpackStackView)
return layers;
return stackView(...layers
.map((layer) => layer[prop])
.filter((v) => v !== undefined));
},
set() {
throw new Error('StackView is read-only and cannot be mutated.');
},
has(_, prop) {
return allKeys.has(prop);
},
ownKeys() {
return allKeysArray;
},
getOwnPropertyDescriptor(_, prop) {
for (const layer of layers) {
const descriptor = Object.getOwnPropertyDescriptor(layer, prop);
if (descriptor)
return descriptor;
}
}
});
}
stackView.unpack = function (obj) {
return obj?.[UnpackStackView];
};
export function isObject(value) {
return Object.prototype.toString.call(value) === '[object Object]';
}
const shellLangs = ['shellscript', 'shell', 'bash', 'sh', 'zsh'];
export function isShell(lang) {
return shellLangs.includes(lang);
}