svelte-highlight 7.21.0 → 7.22.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CodeWindow.svelte +35 -11
- package/CodeWindow.svelte.d.ts +7 -1
- package/HighlightStream.svelte +22 -0
- package/HighlightStream.svelte.d.ts +4 -1
- package/LangTag.svelte +4 -0
- package/LineNumbers.svelte +1 -0
- package/MarkdownStream.svelte +202 -0
- package/MarkdownStream.svelte.d.ts +100 -0
- package/README.md +402 -6
- package/action.d.ts +16 -2
- package/action.js +92 -5
- package/engine.d.ts +29 -1
- package/engine.js +38 -3
- package/fence.d.ts +76 -4
- package/fence.js +274 -3
- package/index.d.ts +1 -0
- package/index.js +1 -0
- package/languages/agda.js +1 -1
- package/languages/aliases.d.ts +7 -0
- package/languages/aliases.js +4 -0
- package/languages/all.js +25 -1
- package/languages/alloy.d.ts +2 -0
- package/languages/alloy.js +2 -0
- package/languages/angular.js +1 -1
- package/languages/assemblyscript.js +1 -1
- package/languages/astro.js +1 -1
- package/languages/asymptote.d.ts +2 -0
- package/languages/asymptote.js +2 -0
- package/languages/baml.js +1 -1
- package/languages/bend.js +1 -1
- package/languages/bibtex.js +1 -1
- package/languages/bicep.js +1 -1
- package/languages/bitbake.js +1 -1
- package/languages/blade.js +1 -1
- package/languages/blockdiag.d.ts +2 -0
- package/languages/blockdiag.js +2 -0
- package/languages/blueprint.js +1 -1
- package/languages/bpftrace.js +1 -1
- package/languages/bqn.js +1 -1
- package/languages/bsv.d.ts +2 -0
- package/languages/bsv.js +2 -0
- package/languages/c.js +1 -1
- package/languages/c3.js +1 -1
- package/languages/caddy.js +1 -1
- package/languages/cairo.js +1 -1
- package/languages/casbin.d.ts +2 -0
- package/languages/casbin.js +2 -0
- package/languages/cedar.js +1 -1
- package/languages/cel.js +1 -1
- package/languages/choicescript.d.ts +2 -0
- package/languages/choicescript.js +2 -0
- package/languages/cisco.js +1 -1
- package/languages/civet.js +1 -1
- package/languages/clarity.js +1 -1
- package/languages/codeql.js +1 -1
- package/languages/cql.js +1 -1
- package/languages/crontab.js +1 -1
- package/languages/csharp.js +1 -1
- package/languages/cue.js +1 -1
- package/languages/cypher.js +1 -1
- package/languages/d2.js +1 -1
- package/languages/dafny.d.ts +2 -0
- package/languages/dafny.js +2 -0
- package/languages/dart.js +1 -1
- package/languages/datalog.js +1 -1
- package/languages/dax.js +1 -1
- package/languages/dbml.d.ts +2 -0
- package/languages/dbml.js +2 -0
- package/languages/dhall.js +1 -1
- package/languages/dialog.d.ts +2 -0
- package/languages/dialog.js +2 -0
- package/languages/djot.js +1 -1
- package/languages/dotenv.js +1 -1
- package/languages/dtrace.js +1 -1
- package/languages/earthfile.js +1 -1
- package/languages/ejs.js +1 -1
- package/languages/esql.js +1 -1
- package/languages/fennel.js +1 -1
- package/languages/fish.js +1 -1
- package/languages/flux.js +1 -1
- package/languages/fstar.d.ts +2 -0
- package/languages/fstar.js +2 -0
- package/languages/gdscript.js +1 -1
- package/languages/gdshader.js +1 -1
- package/languages/gleam.js +1 -1
- package/languages/gnuplot.d.ts +2 -0
- package/languages/gnuplot.js +2 -0
- package/languages/go.js +1 -1
- package/languages/groq.js +1 -1
- package/languages/haproxy.js +1 -1
- package/languages/harlowe.d.ts +2 -0
- package/languages/harlowe.js +2 -0
- package/languages/hcl.js +1 -1
- package/languages/heex.js +3 -1
- package/languages/helm.js +1 -1
- package/languages/hlsl.js +1 -1
- package/languages/hocon.js +1 -1
- package/languages/hurl.js +1 -1
- package/languages/idris.js +1 -1
- package/languages/imba.js +1 -1
- package/languages/index.d.ts +48 -0
- package/languages/index.js +24 -0
- package/languages/ink.js +1 -1
- package/languages/java.js +1 -1
- package/languages/javascript.js +1 -1
- package/languages/jinja.js +1 -1
- package/languages/jmespath.js +1 -1
- package/languages/jq.js +1 -1
- package/languages/json5.js +1 -1
- package/languages/jsonata.js +1 -1
- package/languages/jsonnet.js +1 -1
- package/languages/just.js +1 -1
- package/languages/kcl.js +1 -1
- package/languages/kconfig.js +1 -1
- package/languages/kdl.js +1 -1
- package/languages/koka.js +1 -1
- package/languages/kotlin.js +1 -1
- package/languages/kql.js +1 -1
- package/languages/lean.js +1 -1
- package/languages/likec4.d.ts +2 -0
- package/languages/likec4.js +2 -0
- package/languages/liquid.js +2 -1
- package/languages/logql.js +1 -1
- package/languages/lookml.js +1 -1
- package/languages/luau.js +1 -1
- package/languages/markdoc.js +1 -1
- package/languages/marko.js +1 -1
- package/languages/mdx.js +2 -1
- package/languages/mermaid.js +1 -1
- package/languages/modelfile.js +1 -1
- package/languages/mojo.js +1 -1
- package/languages/move.js +1 -1
- package/languages/nextflow.d.ts +2 -0
- package/languages/nextflow.js +2 -0
- package/languages/nickel.js +1 -1
- package/languages/nomnoml.d.ts +2 -0
- package/languages/nomnoml.js +2 -0
- package/languages/nushell.js +1 -1
- package/languages/odin.js +1 -1
- package/languages/openfga.d.ts +2 -0
- package/languages/openfga.js +2 -0
- package/languages/org.js +1 -1
- package/languages/pikchr.d.ts +2 -0
- package/languages/pikchr.js +2 -0
- package/languages/pkl.js +1 -1
- package/languages/plsql.js +1 -1
- package/languages/polar.js +1 -1
- package/languages/powerquery.js +1 -1
- package/languages/promql.js +1 -1
- package/languages/prql.js +1 -1
- package/languages/purescript.js +1 -1
- package/languages/python.js +1 -1
- package/languages/racket.js +1 -1
- package/languages/raku.js +1 -1
- package/languages/regex.js +1 -1
- package/languages/roc.js +1 -1
- package/languages/ron.js +1 -1
- package/languages/rust.js +1 -1
- package/languages/semver.d.ts +2 -0
- package/languages/semver.js +2 -0
- package/languages/shaderlab.js +1 -1
- package/languages/slint.js +1 -1
- package/languages/smithy.js +1 -1
- package/languages/snort.js +1 -1
- package/languages/solidity.js +1 -1
- package/languages/spade.d.ts +2 -0
- package/languages/spade.js +2 -0
- package/languages/sparql.js +1 -1
- package/languages/spicedb.d.ts +2 -0
- package/languages/spicedb.js +2 -0
- package/languages/splunk.js +1 -1
- package/languages/structurizr.js +1 -1
- package/languages/surrealql.js +1 -1
- package/languages/svelte.js +1 -1
- package/languages/swift.js +1 -1
- package/languages/systemd.js +1 -1
- package/languages/tlaplus.d.ts +2 -0
- package/languages/tlaplus.js +2 -0
- package/languages/toml.js +1 -1
- package/languages/traceql.js +1 -1
- package/languages/tsq.js +1 -1
- package/languages/tsql.js +1 -1
- package/languages/typescript.js +1 -1
- package/languages/typespec.js +1 -1
- package/languages/url.d.ts +2 -0
- package/languages/url.js +2 -0
- package/languages/v.js +1 -1
- package/languages/vcl.js +1 -1
- package/languages/verse.js +1 -1
- package/languages/veryl.d.ts +2 -0
- package/languages/veryl.js +2 -0
- package/languages/vrl.js +1 -1
- package/languages/vue.js +1 -1
- package/languages/vyper.js +1 -1
- package/languages/wdl.d.ts +2 -0
- package/languages/wdl.js +2 -0
- package/languages/wgsl.js +1 -1
- package/languages/wit.js +1 -1
- package/languages/yara.js +1 -1
- package/languages/zig.js +1 -1
- package/package.json +30 -2
- package/search.css +16 -0
- package/search.d.ts +92 -0
- package/search.js +518 -0
- package/styles/blacklight-dark.css +1 -1
- package/styles/blacklight-dark.js +1 -1
- package/styles/cyanotype-light.css +1 -1
- package/styles/cyanotype-light.js +1 -1
- package/styles/dusk-dark.css +1 -1
- package/styles/dusk-dark.js +1 -1
- package/styles/peat-dark.css +1 -1
- package/styles/peat-dark.js +1 -1
- package/styles/thermal-dark.css +1 -1
- package/styles/thermal-dark.js +1 -1
- package/styles/wet-plate-dark.css +1 -1
- package/styles/wet-plate-dark.js +1 -1
- package/themes/blacklight-dark.css +1 -1
- package/themes/blacklight-dark.js +2 -2
- package/themes/cyanotype-light.css +1 -1
- package/themes/cyanotype-light.js +2 -2
- package/themes/dusk-dark.css +1 -1
- package/themes/dusk-dark.js +2 -2
- package/themes/peat-dark.css +1 -1
- package/themes/peat-dark.js +2 -2
- package/themes/thermal-dark.css +1 -1
- package/themes/thermal-dark.js +2 -2
- package/themes/wet-plate-dark.css +1 -1
- package/themes/wet-plate-dark.js +2 -2
- package/transformers.d.ts +44 -0
- package/transformers.js +154 -0
- package/worker.d.ts +45 -0
- package/worker.js +379 -0
package/action.js
CHANGED
|
@@ -1,21 +1,46 @@
|
|
|
1
|
+
import { loadLanguage } from "./load-language.js";
|
|
1
2
|
import { ensureRegistered, registry } from "./registry.js";
|
|
2
3
|
|
|
4
|
+
const LANGUAGE_CLASS = /(?:^|\s)language-([\w#+-]+)(?:\s|$)/;
|
|
5
|
+
|
|
3
6
|
/**
|
|
4
7
|
* Highlight an element in place with highlight.js.
|
|
5
8
|
* Omits `code` to highlight existing `textContent`.
|
|
6
9
|
*
|
|
10
|
+
* Omits `language` to resolve it from a `class="language-xxx"` token on the
|
|
11
|
+
* node itself (the Prism/highlight.js Markdown convention), loaded via
|
|
12
|
+
* `loadLanguage`. No matching class dispatches `error` and leaves the
|
|
13
|
+
* content untouched.
|
|
14
|
+
*
|
|
15
|
+
* Dispatches `highlighted` ({ html, language }) on the node after a
|
|
16
|
+
* successful highlight, and `error` ({ error }) after a failed one.
|
|
17
|
+
*
|
|
7
18
|
* @param {HTMLElement} node
|
|
8
|
-
* @param {{ language
|
|
9
|
-
* @returns {ReturnType<import("svelte/action").Action<HTMLElement, { language
|
|
19
|
+
* @param {{ language?: import("./languages").LanguageType<string>; code?: string }} [parameters]
|
|
20
|
+
* @returns {ReturnType<import("svelte/action").Action<HTMLElement, { language?: import("./languages").LanguageType<string>; code?: string }>>}
|
|
10
21
|
*/
|
|
11
|
-
export function highlight(node, parameters) {
|
|
22
|
+
export function highlight(node, parameters = {}) {
|
|
12
23
|
// Snapshot the pre-action source once: updates that omit `code` fall back
|
|
13
24
|
// to this instead of `node.textContent`, which after the first highlight
|
|
14
25
|
// pass holds the already-highlighted (and DOM-normalized) output.
|
|
15
26
|
const originalText = node.textContent ?? "";
|
|
16
27
|
|
|
17
|
-
|
|
18
|
-
|
|
28
|
+
// Guards a `loadLanguage` continuation from applying stale results if a
|
|
29
|
+
// newer `apply()` call (from `update` or a fresh `destroy`) has since
|
|
30
|
+
// superseded it.
|
|
31
|
+
let generation = 0;
|
|
32
|
+
let destroyed = false;
|
|
33
|
+
|
|
34
|
+
/**
|
|
35
|
+
* @param {import("./languages").LanguageType<string>} language
|
|
36
|
+
* @param {string | undefined} code
|
|
37
|
+
* @param {number} gen
|
|
38
|
+
*/
|
|
39
|
+
function highlightWith(language, code, gen) {
|
|
40
|
+
if (destroyed || gen !== generation) {
|
|
41
|
+
return;
|
|
42
|
+
}
|
|
43
|
+
|
|
19
44
|
const source = code ?? originalText;
|
|
20
45
|
let value;
|
|
21
46
|
|
|
@@ -29,11 +54,72 @@ export function highlight(node, parameters) {
|
|
|
29
54
|
error,
|
|
30
55
|
);
|
|
31
56
|
}
|
|
57
|
+
// Deferred: Svelte wraps `on:` listeners on this node in an effect
|
|
58
|
+
// that flushes after this action's own (synchronous) mount/update
|
|
59
|
+
// runs, so dispatching synchronously here would fire before a
|
|
60
|
+
// listener declared via `on:error` is attached.
|
|
61
|
+
queueMicrotask(() =>
|
|
62
|
+
node.dispatchEvent(new CustomEvent("error", { detail: { error } })),
|
|
63
|
+
);
|
|
32
64
|
return;
|
|
33
65
|
}
|
|
34
66
|
|
|
35
67
|
node.innerHTML = value;
|
|
36
68
|
node.classList.add("hljs");
|
|
69
|
+
// See the `error` dispatch above for why this is deferred.
|
|
70
|
+
queueMicrotask(() =>
|
|
71
|
+
node.dispatchEvent(
|
|
72
|
+
new CustomEvent("highlighted", {
|
|
73
|
+
detail: { html: value, language: language.name },
|
|
74
|
+
}),
|
|
75
|
+
),
|
|
76
|
+
);
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
/** @param {{ language?: import("./languages").LanguageType<string>; code?: string }} params */
|
|
80
|
+
function apply({ language, code } = {}) {
|
|
81
|
+
generation += 1;
|
|
82
|
+
const gen = generation;
|
|
83
|
+
|
|
84
|
+
if (language) {
|
|
85
|
+
highlightWith(language, code, gen);
|
|
86
|
+
return;
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
const match = node.getAttribute("class")?.match(LANGUAGE_CLASS);
|
|
90
|
+
|
|
91
|
+
if (!match) {
|
|
92
|
+
const error = new Error(
|
|
93
|
+
'no "language" parameter and no "language-xxx" class found',
|
|
94
|
+
);
|
|
95
|
+
if (import.meta.env?.DEV) {
|
|
96
|
+
console.warn(`[svelte-highlight] ${error.message}.`);
|
|
97
|
+
}
|
|
98
|
+
queueMicrotask(() =>
|
|
99
|
+
node.dispatchEvent(new CustomEvent("error", { detail: { error } })),
|
|
100
|
+
);
|
|
101
|
+
return;
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
const name = /** @type {string} */ (match[1]);
|
|
105
|
+
|
|
106
|
+
loadLanguage(/** @type {import("./languages").LanguageName} */ (name)).then(
|
|
107
|
+
(language) => highlightWith(language, code, gen),
|
|
108
|
+
(error) => {
|
|
109
|
+
if (destroyed || gen !== generation) {
|
|
110
|
+
return;
|
|
111
|
+
}
|
|
112
|
+
if (import.meta.env?.DEV) {
|
|
113
|
+
console.warn(
|
|
114
|
+
`[svelte-highlight] failed to load language "${name}" from class="language-${name}"; leaving content unchanged.`,
|
|
115
|
+
error,
|
|
116
|
+
);
|
|
117
|
+
}
|
|
118
|
+
queueMicrotask(() =>
|
|
119
|
+
node.dispatchEvent(new CustomEvent("error", { detail: { error } })),
|
|
120
|
+
);
|
|
121
|
+
},
|
|
122
|
+
);
|
|
37
123
|
}
|
|
38
124
|
|
|
39
125
|
apply(parameters);
|
|
@@ -41,6 +127,7 @@ export function highlight(node, parameters) {
|
|
|
41
127
|
return {
|
|
42
128
|
update: apply,
|
|
43
129
|
destroy() {
|
|
130
|
+
destroyed = true;
|
|
44
131
|
node.classList.remove("hljs");
|
|
45
132
|
node.textContent = originalText;
|
|
46
133
|
},
|
package/engine.d.ts
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
* `createHtmlRenderer`, `createRangeRenderer`, `createLineRenderer`,
|
|
8
8
|
* `Registry` and all its methods, `createRegistry`, `registerAll`,
|
|
9
9
|
* `StreamSession`, `Snapshot` (see its own doc comment for a narrower
|
|
10
|
-
* guarantee)
|
|
10
|
+
* guarantee), `UnknownLanguageError`, `TokenizerLoopError`.
|
|
11
11
|
* - **Generated data (structure versioned with the library):** `GrammarIR`,
|
|
12
12
|
* `GrammarState` (see their doc comment).
|
|
13
13
|
*
|
|
@@ -40,6 +40,12 @@ export interface GrammarState {
|
|
|
40
40
|
returnBegin?: boolean;
|
|
41
41
|
returnEnd?: boolean;
|
|
42
42
|
subLanguage?: string | string[];
|
|
43
|
+
/**
|
|
44
|
+
* Only enforced during auto-detection (`tokenizeAuto`/`highlightAuto`);
|
|
45
|
+
* inert on an explicit-language `tokenize()`/`highlight()`/`createSession()`/
|
|
46
|
+
* `resume()` call, so mid-stream text that would trip `illegal` under hljs's
|
|
47
|
+
* `ignoreIllegals: false` default is never rejected once the language is named.
|
|
48
|
+
*/
|
|
43
49
|
illegal?: string;
|
|
44
50
|
keywords?: Record<string, [string, number]>;
|
|
45
51
|
keywordPattern?: string;
|
|
@@ -194,6 +200,28 @@ export interface CompiledProgram {
|
|
|
194
200
|
ir: GrammarIR;
|
|
195
201
|
}
|
|
196
202
|
|
|
203
|
+
/**
|
|
204
|
+
* Thrown by `tokenize`, `highlight`, `tokenizeRanges`, and `createSession`
|
|
205
|
+
* when `language` isn't registered. Distinct from `LanguageLoadError`
|
|
206
|
+
* (`svelte-highlight`/`svelte-highlight/load-language`), which fires from a
|
|
207
|
+
* grammar module's dynamic `import()` failure, not a registry lookup.
|
|
208
|
+
* `resume()` does not throw this - see its own doc comment.
|
|
209
|
+
*/
|
|
210
|
+
export class UnknownLanguageError extends Error {
|
|
211
|
+
constructor(language: string);
|
|
212
|
+
language: string;
|
|
213
|
+
}
|
|
214
|
+
|
|
215
|
+
/**
|
|
216
|
+
* Thrown by the tokenizer once a parse exceeds 500,000 iterations,
|
|
217
|
+
* guarding against a grammar bug that never advances position.
|
|
218
|
+
*/
|
|
219
|
+
export class TokenizerLoopError extends Error {
|
|
220
|
+
constructor(grammarName: string, iterations: number);
|
|
221
|
+
grammarName: string;
|
|
222
|
+
iterations: number;
|
|
223
|
+
}
|
|
224
|
+
|
|
197
225
|
export interface Registry {
|
|
198
226
|
register(ir: GrammarIR): unknown;
|
|
199
227
|
get(name: string): CompiledProgram | undefined;
|
package/engine.js
CHANGED
|
@@ -131,6 +131,41 @@ export const TEXT = 0;
|
|
|
131
131
|
export const OPEN = 1;
|
|
132
132
|
export const CLOSE = 2;
|
|
133
133
|
|
|
134
|
+
/**
|
|
135
|
+
* Thrown by `tokenize`, `highlight`, `tokenizeRanges`, and `createSession`
|
|
136
|
+
* when `language` isn't registered. Distinct from `LanguageLoadError`
|
|
137
|
+
* (src/load-language.js), which fires from a grammar module's dynamic
|
|
138
|
+
* `import()` failure, not a registry lookup. `resume()` does not throw
|
|
139
|
+
* this - see its own comment.
|
|
140
|
+
*/
|
|
141
|
+
export class UnknownLanguageError extends Error {
|
|
142
|
+
/**
|
|
143
|
+
* @param {string} language
|
|
144
|
+
*/
|
|
145
|
+
constructor(language) {
|
|
146
|
+
super(`Unknown language: "${language}"`);
|
|
147
|
+
this.name = "UnknownLanguageError";
|
|
148
|
+
this.language = language;
|
|
149
|
+
}
|
|
150
|
+
}
|
|
151
|
+
|
|
152
|
+
/**
|
|
153
|
+
* Thrown by `Tokenizer#run` once a parse exceeds 500,000 iterations,
|
|
154
|
+
* guarding against a grammar bug that never advances `pos`.
|
|
155
|
+
*/
|
|
156
|
+
export class TokenizerLoopError extends Error {
|
|
157
|
+
/**
|
|
158
|
+
* @param {string} grammarName
|
|
159
|
+
* @param {number} iterations
|
|
160
|
+
*/
|
|
161
|
+
constructor(grammarName, iterations) {
|
|
162
|
+
super(`potential infinite loop (${grammarName})`);
|
|
163
|
+
this.name = "TokenizerLoopError";
|
|
164
|
+
this.grammarName = grammarName;
|
|
165
|
+
this.iterations = iterations;
|
|
166
|
+
}
|
|
167
|
+
}
|
|
168
|
+
|
|
134
169
|
/** Scope name prefix marking a sub-language boundary (`language:css`). */
|
|
135
170
|
const LANGUAGE_SCOPE_PREFIX = "language:";
|
|
136
171
|
|
|
@@ -752,7 +787,7 @@ class Tokenizer {
|
|
|
752
787
|
for (;;) {
|
|
753
788
|
this.iterations++;
|
|
754
789
|
if (this.iterations > 500000) {
|
|
755
|
-
throw new
|
|
790
|
+
throw new TokenizerLoopError(this.program.ir.name, this.iterations);
|
|
756
791
|
}
|
|
757
792
|
const found = this.nextMatch();
|
|
758
793
|
if (!found) break;
|
|
@@ -1150,7 +1185,7 @@ export function createRegistry() {
|
|
|
1150
1185
|
*/
|
|
1151
1186
|
tokenize(code, language) {
|
|
1152
1187
|
const program = this.get(language);
|
|
1153
|
-
if (!program) throw new
|
|
1188
|
+
if (!program) throw new UnknownLanguageError(language);
|
|
1154
1189
|
const tokenizer = new Tokenizer(this, program);
|
|
1155
1190
|
tokenizer.code = code;
|
|
1156
1191
|
tokenizer.run();
|
|
@@ -1316,7 +1351,7 @@ export function createRegistry() {
|
|
|
1316
1351
|
*/
|
|
1317
1352
|
createSession(language, { from } = {}) {
|
|
1318
1353
|
const program = this.get(language);
|
|
1319
|
-
if (!program) throw new
|
|
1354
|
+
if (!program) throw new UnknownLanguageError(language);
|
|
1320
1355
|
let tokenizer = new Tokenizer(this, program);
|
|
1321
1356
|
const registry = this;
|
|
1322
1357
|
let staged = "";
|
package/fence.d.ts
CHANGED
|
@@ -18,6 +18,16 @@ export interface ParsedMeta {
|
|
|
18
18
|
*/
|
|
19
19
|
export declare function parseMeta(meta: string): ParsedMeta;
|
|
20
20
|
|
|
21
|
+
/**
|
|
22
|
+
* Resolves a Markdown fence info string's language word (or a bare grammar
|
|
23
|
+
* name) to its canonical grammar name, e.g. `"ts"` or `"TypeScript"` ->
|
|
24
|
+
* `"typescript"`. Trims, lowercases, and takes only the first
|
|
25
|
+
* whitespace-delimited word, so passing a full info string like
|
|
26
|
+
* `"ts title=\"app.ts\""` works. Returns `undefined` when the word doesn't
|
|
27
|
+
* match a shipped grammar name or alias.
|
|
28
|
+
*/
|
|
29
|
+
export declare function resolveLanguageName(name: string): string | undefined;
|
|
30
|
+
|
|
21
31
|
/**
|
|
22
32
|
* Highlights a single Markdown/MDX code fence into hljs-compatible HTML,
|
|
23
33
|
* for use from framework adapters (mdsvex, markdown-it, rehype, ...) that
|
|
@@ -28,13 +38,75 @@ export declare function parseMeta(meta: string): ParsedMeta;
|
|
|
28
38
|
* `parseMeta`), wrapped in a `<pre class="hljs" data-language="...">` that
|
|
29
39
|
* carries `data-title`/`data-show-line-numbers` when `meta` sets them.
|
|
30
40
|
*
|
|
31
|
-
* `lang`
|
|
32
|
-
*
|
|
33
|
-
* `
|
|
34
|
-
*
|
|
41
|
+
* `lang` accepts either the grammar's canonical file name (e.g.
|
|
42
|
+
* `"typescript"`) or a known alias (e.g. `"ts"`) - resolved internally via
|
|
43
|
+
* `resolveLanguageName`. Rejects with `LanguageLoadError`
|
|
44
|
+
* (`Unknown language: "<lang>"`) when neither resolves to a shipped
|
|
45
|
+
* grammar.
|
|
35
46
|
*/
|
|
36
47
|
export declare function highlightFence(options: {
|
|
37
48
|
code: string;
|
|
38
49
|
lang: string;
|
|
39
50
|
meta?: string;
|
|
40
51
|
}): Promise<string>;
|
|
52
|
+
|
|
53
|
+
export interface TextSegment {
|
|
54
|
+
id: number;
|
|
55
|
+
kind: "text";
|
|
56
|
+
text: string;
|
|
57
|
+
start: number;
|
|
58
|
+
end: number;
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
export interface FenceSegment {
|
|
62
|
+
id: number;
|
|
63
|
+
kind: "fence";
|
|
64
|
+
/** `resolveLanguageName` of the info string's first word; `undefined` when absent or unrecognized. */
|
|
65
|
+
lang: string | undefined;
|
|
66
|
+
/** The fence's raw info string (trimmed), e.g. `ts title="app.ts" {1,3}`. */
|
|
67
|
+
info: string;
|
|
68
|
+
/** `parseMeta` of everything in `info` after its first word. */
|
|
69
|
+
meta: ParsedMeta;
|
|
70
|
+
/** Fence content with the opening fence's indentation stripped per line, no trailing newline. */
|
|
71
|
+
code: string;
|
|
72
|
+
/** `true` while the fence has not yet seen a closing fence line. */
|
|
73
|
+
open: boolean;
|
|
74
|
+
start: number;
|
|
75
|
+
end: number;
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
export type MarkdownSegment = TextSegment | FenceSegment;
|
|
79
|
+
|
|
80
|
+
/**
|
|
81
|
+
* Headless, streaming CommonMark fence splitter: turns a growing Markdown
|
|
82
|
+
* string into prose (`text`) and fenced-code (`fence`) segments with stable,
|
|
83
|
+
* increasing `id`s, so each fence can drive its own highlighter and survive
|
|
84
|
+
* both `append` and a regenerated buffer via `set` without losing identity.
|
|
85
|
+
*/
|
|
86
|
+
export interface FenceSplitter {
|
|
87
|
+
/**
|
|
88
|
+
* Appends `chunk` to the buffer. O(chunk): only rescans from the start of
|
|
89
|
+
* the last segment, which by construction is the only one that can
|
|
90
|
+
* change. Only the last segment object may be replaced; every earlier
|
|
91
|
+
* segment object keeps its identity, so a keyed `{#each}` never re-mounts
|
|
92
|
+
* them.
|
|
93
|
+
*/
|
|
94
|
+
append(chunk: string): void;
|
|
95
|
+
/**
|
|
96
|
+
* Replaces the whole buffer with `text`. Segments before the first point
|
|
97
|
+
* of divergence from the previous text keep their id and object identity.
|
|
98
|
+
* The first rebuilt segment reuses its old id when its `kind` and (for a
|
|
99
|
+
* fence) `info` are unchanged, so a regenerated fence keeps driving the
|
|
100
|
+
* same highlighter instance. A no-op when `text` equals the current text.
|
|
101
|
+
*/
|
|
102
|
+
set(text: string): void;
|
|
103
|
+
/** The current segments. Same array identity until the next mutation. */
|
|
104
|
+
segments(): readonly MarkdownSegment[];
|
|
105
|
+
/** The full buffer text, as last passed to `append`/`set`. */
|
|
106
|
+
text(): string;
|
|
107
|
+
/** Clears the buffer and restarts ids at 1. */
|
|
108
|
+
reset(): void;
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
/** Creates an empty {@link FenceSplitter}. */
|
|
112
|
+
export declare function createFenceSplitter(): FenceSplitter;
|
package/fence.js
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { escapeHtml, scopeToCssClass, tokenLines } from "./engine.js";
|
|
2
|
+
import { LANGUAGE_ALIASES } from "./languages/aliases.js";
|
|
2
3
|
import { loadLanguage } from "./load-language.js";
|
|
3
4
|
import { ensureRegistered, registry } from "./registry.js";
|
|
4
5
|
|
|
@@ -7,6 +8,10 @@ import { ensureRegistered, registry } from "./registry.js";
|
|
|
7
8
|
*/
|
|
8
9
|
|
|
9
10
|
const TOKEN_RE = /(\w+)="([^"]*)"|(\w+)=\{([^}]*)\}|\{([^}]*)\}|(\w+)/g;
|
|
11
|
+
const WHITESPACE_RE = /\s+/;
|
|
12
|
+
const OPENING_FENCE_RE = /^( {0,3})(`{3,}|~{3,})(.*)$/;
|
|
13
|
+
const CLOSING_FENCE_RE = /^( {0,3})(`+|~+)( *)$/;
|
|
14
|
+
const INFO_SPLIT_RE = /^(\S*)\s*([\s\S]*)$/;
|
|
10
15
|
|
|
11
16
|
/**
|
|
12
17
|
* Expands a comma-separated `1,3-5` range string into individual 1-indexed
|
|
@@ -72,6 +77,15 @@ export function parseMeta(meta) {
|
|
|
72
77
|
return result;
|
|
73
78
|
}
|
|
74
79
|
|
|
80
|
+
/**
|
|
81
|
+
* @param {string} name
|
|
82
|
+
* @returns {string | undefined}
|
|
83
|
+
*/
|
|
84
|
+
export function resolveLanguageName(name) {
|
|
85
|
+
const word = name.trim().toLowerCase().split(WHITESPACE_RE)[0] ?? "";
|
|
86
|
+
return LANGUAGE_ALIASES[word];
|
|
87
|
+
}
|
|
88
|
+
|
|
75
89
|
/** @param {string} value */
|
|
76
90
|
function escapeAttribute(value) {
|
|
77
91
|
return value.replace(/&/g, "&").replace(/"/g, """);
|
|
@@ -94,11 +108,12 @@ function renderToken(token) {
|
|
|
94
108
|
* @returns {Promise<string>}
|
|
95
109
|
*/
|
|
96
110
|
export async function highlightFence({ code, lang, meta }) {
|
|
111
|
+
const resolvedLang = resolveLanguageName(lang) ?? lang;
|
|
97
112
|
const language = await loadLanguage(
|
|
98
|
-
/** @type {import("./languages").LanguageName} */ (
|
|
113
|
+
/** @type {import("./languages").LanguageName} */ (resolvedLang),
|
|
99
114
|
);
|
|
100
115
|
ensureRegistered(language);
|
|
101
|
-
const { events } = registry.highlight(code, { language:
|
|
116
|
+
const { events } = registry.highlight(code, { language: resolvedLang });
|
|
102
117
|
const parsedMeta = meta === undefined ? undefined : parseMeta(meta);
|
|
103
118
|
|
|
104
119
|
const lines = tokenLines(events)
|
|
@@ -118,7 +133,263 @@ export async function highlightFence({ code, lang, meta }) {
|
|
|
118
133
|
: "";
|
|
119
134
|
|
|
120
135
|
return (
|
|
121
|
-
`<pre class="hljs" data-language="${escapeAttribute(
|
|
136
|
+
`<pre class="hljs" data-language="${escapeAttribute(resolvedLang)}"${titleAttr}${showLineNumbersAttr}>` +
|
|
122
137
|
`<code class="hljs">${lines}</code></pre>`
|
|
123
138
|
);
|
|
124
139
|
}
|
|
140
|
+
|
|
141
|
+
/**
|
|
142
|
+
* @param {string} line
|
|
143
|
+
* @returns {{ indent: number; char: "`" | "~"; len: number; info: string } | null}
|
|
144
|
+
*/
|
|
145
|
+
function matchOpeningFence(line) {
|
|
146
|
+
const match = OPENING_FENCE_RE.exec(line);
|
|
147
|
+
if (match === null) return null;
|
|
148
|
+
const indent = /** @type {string} */ (match[1]).length;
|
|
149
|
+
const run = /** @type {string} */ (match[2]);
|
|
150
|
+
const char = /** @type {"`" | "~"} */ (run[0]);
|
|
151
|
+
const rest = /** @type {string} */ (match[3]);
|
|
152
|
+
if (char === "`" && rest.includes("`")) return null;
|
|
153
|
+
return { indent, char, len: run.length, info: rest.trim() };
|
|
154
|
+
}
|
|
155
|
+
|
|
156
|
+
/**
|
|
157
|
+
* @param {string} line
|
|
158
|
+
* @param {"`" | "~"} char
|
|
159
|
+
* @param {number} minLen
|
|
160
|
+
* @returns {boolean}
|
|
161
|
+
*/
|
|
162
|
+
function matchClosingFence(line, char, minLen) {
|
|
163
|
+
const match = CLOSING_FENCE_RE.exec(line);
|
|
164
|
+
if (match === null) return false;
|
|
165
|
+
const run = /** @type {string} */ (match[2]);
|
|
166
|
+
return run[0] === char && run.length >= minLen;
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
/**
|
|
170
|
+
* @param {string} line
|
|
171
|
+
* @param {number} indent
|
|
172
|
+
* @returns {string}
|
|
173
|
+
*/
|
|
174
|
+
function stripIndent(line, indent) {
|
|
175
|
+
let strip = 0;
|
|
176
|
+
while (strip < indent && line[strip] === " ") strip += 1;
|
|
177
|
+
return line.slice(strip);
|
|
178
|
+
}
|
|
179
|
+
|
|
180
|
+
/**
|
|
181
|
+
* @typedef {import("./fence.d.ts").MarkdownSegment} MarkdownSegment
|
|
182
|
+
* @typedef {import("./fence.d.ts").FenceSegment} FenceSegment
|
|
183
|
+
*/
|
|
184
|
+
|
|
185
|
+
/**
|
|
186
|
+
* @param {{ char: "`" | "~"; len: number; indent: number; info: string; start: number; lines: string[] }} ctx
|
|
187
|
+
* @param {number} id
|
|
188
|
+
* @param {number} end
|
|
189
|
+
* @param {boolean} open
|
|
190
|
+
* @returns {FenceSegment}
|
|
191
|
+
*/
|
|
192
|
+
function buildFenceSegment(ctx, id, end, open) {
|
|
193
|
+
const infoMatch = /** @type {RegExpExecArray} */ (
|
|
194
|
+
INFO_SPLIT_RE.exec(ctx.info)
|
|
195
|
+
);
|
|
196
|
+
const meta = /** @type {string} */ (infoMatch[2]);
|
|
197
|
+
return {
|
|
198
|
+
id,
|
|
199
|
+
kind: "fence",
|
|
200
|
+
lang: resolveLanguageName(ctx.info),
|
|
201
|
+
info: ctx.info,
|
|
202
|
+
meta: parseMeta(meta),
|
|
203
|
+
code: ctx.lines.join("\n"),
|
|
204
|
+
open,
|
|
205
|
+
start: ctx.start,
|
|
206
|
+
end,
|
|
207
|
+
};
|
|
208
|
+
}
|
|
209
|
+
|
|
210
|
+
/**
|
|
211
|
+
* Parses `text` from `offset` onward as if `offset` were the start of a
|
|
212
|
+
* document (always begins in prose mode - valid since a segment boundary
|
|
213
|
+
* never occurs mid-fence, only at a definite open/close/EOF point).
|
|
214
|
+
* @param {string} text
|
|
215
|
+
* @param {number} offset
|
|
216
|
+
* @param {number} startId
|
|
217
|
+
* @returns {{ segments: MarkdownSegment[]; nextId: number }}
|
|
218
|
+
*/
|
|
219
|
+
function computeSegments(text, offset, startId) {
|
|
220
|
+
/** @type {MarkdownSegment[]} */
|
|
221
|
+
const segments = [];
|
|
222
|
+
let id = startId;
|
|
223
|
+
const n = text.length;
|
|
224
|
+
let i = offset;
|
|
225
|
+
/** @type {"prose" | "fence"} */
|
|
226
|
+
let mode = "prose";
|
|
227
|
+
let proseStart = offset;
|
|
228
|
+
/** @type {{ char: "`" | "~"; len: number; indent: number; info: string; start: number; lines: string[] } | null} */
|
|
229
|
+
let fenceCtx = null;
|
|
230
|
+
|
|
231
|
+
while (i < n) {
|
|
232
|
+
const lineStart = i;
|
|
233
|
+
const nlIndex = text.indexOf("\n", i);
|
|
234
|
+
const hasNewline = nlIndex !== -1;
|
|
235
|
+
const lineEnd = hasNewline ? nlIndex : n;
|
|
236
|
+
const lineEndIncl = hasNewline ? nlIndex + 1 : n;
|
|
237
|
+
const line = text.slice(lineStart, lineEnd);
|
|
238
|
+
|
|
239
|
+
if (mode === "prose") {
|
|
240
|
+
const open = matchOpeningFence(line);
|
|
241
|
+
if (open !== null) {
|
|
242
|
+
if (!hasNewline) {
|
|
243
|
+
// Opening line not yet terminated by a newline: stays prose until
|
|
244
|
+
// it is, so a half-received "```ts" never flickers into a fence.
|
|
245
|
+
break;
|
|
246
|
+
}
|
|
247
|
+
if (lineStart > proseStart) {
|
|
248
|
+
segments.push({
|
|
249
|
+
id: id++,
|
|
250
|
+
kind: "text",
|
|
251
|
+
text: text.slice(proseStart, lineStart),
|
|
252
|
+
start: proseStart,
|
|
253
|
+
end: lineStart,
|
|
254
|
+
});
|
|
255
|
+
}
|
|
256
|
+
fenceCtx = {
|
|
257
|
+
char: open.char,
|
|
258
|
+
len: open.len,
|
|
259
|
+
indent: open.indent,
|
|
260
|
+
info: open.info,
|
|
261
|
+
start: lineStart,
|
|
262
|
+
lines: [],
|
|
263
|
+
};
|
|
264
|
+
mode = "fence";
|
|
265
|
+
i = lineEndIncl;
|
|
266
|
+
continue;
|
|
267
|
+
}
|
|
268
|
+
i = lineEndIncl;
|
|
269
|
+
continue;
|
|
270
|
+
}
|
|
271
|
+
|
|
272
|
+
// mode === "fence"
|
|
273
|
+
const ctx = /** @type {NonNullable<typeof fenceCtx>} */ (fenceCtx);
|
|
274
|
+
if (hasNewline && matchClosingFence(line, ctx.char, ctx.len)) {
|
|
275
|
+
segments.push(buildFenceSegment(ctx, id++, lineEndIncl, false));
|
|
276
|
+
mode = "prose";
|
|
277
|
+
proseStart = lineEndIncl;
|
|
278
|
+
i = lineEndIncl;
|
|
279
|
+
continue;
|
|
280
|
+
}
|
|
281
|
+
// A same-line-terminated closer requires a newline (like an opener, a
|
|
282
|
+
// still-unterminated closer-looking line might grow into content or a
|
|
283
|
+
// longer/shorter run with the next chunk) - anything else is content.
|
|
284
|
+
ctx.lines.push(stripIndent(line, ctx.indent));
|
|
285
|
+
if (!hasNewline) break;
|
|
286
|
+
i = lineEndIncl;
|
|
287
|
+
}
|
|
288
|
+
|
|
289
|
+
if (mode === "fence") {
|
|
290
|
+
segments.push(
|
|
291
|
+
buildFenceSegment(
|
|
292
|
+
/** @type {NonNullable<typeof fenceCtx>} */ (fenceCtx),
|
|
293
|
+
id++,
|
|
294
|
+
n,
|
|
295
|
+
true,
|
|
296
|
+
),
|
|
297
|
+
);
|
|
298
|
+
} else if (proseStart < n) {
|
|
299
|
+
segments.push({
|
|
300
|
+
id: id++,
|
|
301
|
+
kind: "text",
|
|
302
|
+
text: text.slice(proseStart, n),
|
|
303
|
+
start: proseStart,
|
|
304
|
+
end: n,
|
|
305
|
+
});
|
|
306
|
+
}
|
|
307
|
+
|
|
308
|
+
return { segments, nextId: id };
|
|
309
|
+
}
|
|
310
|
+
|
|
311
|
+
/**
|
|
312
|
+
* @returns {import("./fence.d.ts").FenceSplitter}
|
|
313
|
+
*/
|
|
314
|
+
export function createFenceSplitter() {
|
|
315
|
+
let text = "";
|
|
316
|
+
/** @type {MarkdownSegment[]} */
|
|
317
|
+
let segments = [];
|
|
318
|
+
let nextId = 1;
|
|
319
|
+
|
|
320
|
+
return {
|
|
321
|
+
append(chunk) {
|
|
322
|
+
if (chunk === "") return;
|
|
323
|
+
text += chunk;
|
|
324
|
+
|
|
325
|
+
const last = segments[segments.length - 1];
|
|
326
|
+
const rescanFrom = last === undefined ? 0 : last.start;
|
|
327
|
+
const result = computeSegments(text, rescanFrom, nextId);
|
|
328
|
+
nextId = result.nextId;
|
|
329
|
+
|
|
330
|
+
if (result.segments.length > 0 && last !== undefined) {
|
|
331
|
+
result.segments[0] = {
|
|
332
|
+
.../** @type {MarkdownSegment} */ (result.segments[0]),
|
|
333
|
+
id: last.id,
|
|
334
|
+
};
|
|
335
|
+
}
|
|
336
|
+
|
|
337
|
+
segments =
|
|
338
|
+
last === undefined
|
|
339
|
+
? result.segments
|
|
340
|
+
: [...segments.slice(0, -1), ...result.segments];
|
|
341
|
+
},
|
|
342
|
+
|
|
343
|
+
set(newText) {
|
|
344
|
+
if (newText === text) return;
|
|
345
|
+
const oldText = text;
|
|
346
|
+
const minLen = Math.min(oldText.length, newText.length);
|
|
347
|
+
let prefixLen = 0;
|
|
348
|
+
while (prefixLen < minLen && oldText[prefixLen] === newText[prefixLen])
|
|
349
|
+
prefixLen += 1;
|
|
350
|
+
|
|
351
|
+
let m = -1;
|
|
352
|
+
for (let i = 0; i < segments.length; i += 1) {
|
|
353
|
+
const segment = /** @type {MarkdownSegment} */ (segments[i]);
|
|
354
|
+
if (segment.start <= prefixLen) m = i;
|
|
355
|
+
else break;
|
|
356
|
+
}
|
|
357
|
+
|
|
358
|
+
const kept = m < 1 ? [] : segments.slice(0, m);
|
|
359
|
+
const reuseCandidate = m === -1 ? undefined : segments[m];
|
|
360
|
+
const rebuildFrom =
|
|
361
|
+
reuseCandidate === undefined ? 0 : reuseCandidate.start;
|
|
362
|
+
|
|
363
|
+
text = newText;
|
|
364
|
+
const result = computeSegments(text, rebuildFrom, nextId);
|
|
365
|
+
nextId = result.nextId;
|
|
366
|
+
|
|
367
|
+
const first = result.segments[0];
|
|
368
|
+
if (
|
|
369
|
+
first !== undefined &&
|
|
370
|
+
reuseCandidate !== undefined &&
|
|
371
|
+
first.kind === reuseCandidate.kind &&
|
|
372
|
+
(first.kind !== "fence" ||
|
|
373
|
+
first.info === /** @type {FenceSegment} */ (reuseCandidate).info)
|
|
374
|
+
) {
|
|
375
|
+
result.segments[0] = { ...first, id: reuseCandidate.id };
|
|
376
|
+
}
|
|
377
|
+
|
|
378
|
+
segments = [...kept, ...result.segments];
|
|
379
|
+
},
|
|
380
|
+
|
|
381
|
+
segments() {
|
|
382
|
+
return segments;
|
|
383
|
+
},
|
|
384
|
+
|
|
385
|
+
text() {
|
|
386
|
+
return text;
|
|
387
|
+
},
|
|
388
|
+
|
|
389
|
+
reset() {
|
|
390
|
+
text = "";
|
|
391
|
+
segments = [];
|
|
392
|
+
nextId = 1;
|
|
393
|
+
},
|
|
394
|
+
};
|
|
395
|
+
}
|
package/index.d.ts
CHANGED
|
@@ -17,6 +17,7 @@ export { default as HighlightVirtual } from "./HighlightVirtual.svelte";
|
|
|
17
17
|
export { default as LineNumbers } from "./LineNumbers.svelte";
|
|
18
18
|
export type { LanguageName, LanguageType } from "./languages";
|
|
19
19
|
export { LanguageLoadError, loadLanguage } from "./load-language";
|
|
20
|
+
export { default as MarkdownStream } from "./MarkdownStream.svelte";
|
|
20
21
|
export {
|
|
21
22
|
dualStyle,
|
|
22
23
|
scopeClassFor,
|
package/index.js
CHANGED
|
@@ -14,6 +14,7 @@ export { default as HighlightSvelte } from "./HighlightSvelte.svelte";
|
|
|
14
14
|
export { default as HighlightVirtual } from "./HighlightVirtual.svelte";
|
|
15
15
|
export { default as LineNumbers } from "./LineNumbers.svelte";
|
|
16
16
|
export { LanguageLoadError, loadLanguage } from "./load-language.js";
|
|
17
|
+
export { default as MarkdownStream } from "./MarkdownStream.svelte";
|
|
17
18
|
export {
|
|
18
19
|
dualStyle,
|
|
19
20
|
scopeClassFor,
|