summaryrefslogtreecommitdiff
path: root/packages/astro/components/Shiki.js
blob: 1a2a4b1568e242941b8521988385938a99635632 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
import { getHighlighter as getShikiHighlighter } from 'shiki';
import { themes } from './shiki-themes.js';
import { languages } from './shiki-languages.js';

// Caches Promise<Highlighter> for reuse when the same theme and langs are provided
const _resolvedHighlighters = new Map();

/** @type {Promise<any>} */
let _allLanguages;

function stringify(opts) {
	// Always sort keys before stringifying to make sure objects match regardless of parameter ordering
	return JSON.stringify(opts, Object.keys(opts).sort());
}

/**
 * @param {import('shiki').HighlighterOptions} opts
 * @returns {Promise<import('shiki').HighlighterOptions>}
 */
export async function resolveHighlighterOptions(opts) {
	const resolvedThemes = [];
	if (opts.theme && opts.theme in themes) {
		resolvedThemes.push(await themes[opts.theme]());
	} else if (Object.keys(opts.theme).length) {
		resolvedThemes.push(opts.theme);
	}

	let resolvedLanguages;
	if (opts.langs) {
		resolvedLanguages = opts.langs;
	} else {
		if (!_allLanguages) {
			_allLanguages = (await Promise.all(Object.values(languages).map((fn) => fn()))).filter(
				Boolean
			);
		}
		resolvedLanguages = await _allLanguages;
	}

	/** @type {import('shiki').HighlighterOptions} */
	const highlighterOptions = {
		...opts,
		themes: resolvedThemes,
		langs: resolvedLanguages,
	};

	// Do not pass through the theme as that will attempt to load it, even if it's included in themes
	delete highlighterOptions['theme'];

	return highlighterOptions;
}

/**
 * @param {import('shiki').HighlighterOptions} opts
 * @returns {Promise<import('shiki').Highlighter>}
 */
async function resolveHighlighter(opts) {
	const highlighterOptions = await resolveHighlighterOptions(opts);

	// Start the async getHighlighter call and cache the Promise
	const highlighter = getShikiHighlighter(highlighterOptions).then((hl) => {
		hl.setColorReplacements({
			'#000001': 'var(--astro-code-color-text)',
			'#000002': 'var(--astro-code-color-background)',
			'#000004': 'var(--astro-code-token-constant)',
			'#000005': 'var(--astro-code-token-string)',
			'#000006': 'var(--astro-code-token-comment)',
			'#000007': 'var(--astro-code-token-keyword)',
			'#000008': 'var(--astro-code-token-parameter)',
			'#000009': 'var(--astro-code-token-function)',
			'#000010': 'var(--astro-code-token-string-expression)',
			'#000011': 'var(--astro-code-token-punctuation)',
			'#000012': 'var(--astro-code-token-link)',
		});
		return hl;
	});

	return highlighter;
}

/**
 * @param {import('shiki').HighlighterOptions} opts
 * @returns {Promise<import('shiki').Highlighter>}
 */
export function getHighlighter(opts) {
	const key = stringify(opts);

	// Highlighter has already been requested, reuse the same instance
	if (_resolvedHighlighters.has(key)) {
		return _resolvedHighlighters.get(key);
	}

	const highlighter = resolveHighlighter(opts);
	_resolvedHighlighters.set(key, highlighter);

	return highlighter;
}