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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
|
/**
* Registers gleam as a language
*
* Based off https://github.com/gleam-lang/website/blob/main/javascript/highlightjs-gleam.js
* Edited to work with minified hightlightjs core v11 (module) & match more of the syntax
*/
import hljs from "./highlight.core.min.js";
import * as regexes from "./regexes.js";
/**
* Copies an object to prevent prototype pollution
* @template {object} TObject - the object's structure
* @param {TObject} obj - The source object to copy
* @returns {TObject} - A shallow copy of the source object
*/
const cp = (obj) => ({ ...obj });
// Define operators and keywords to highlight gleam code without spawning an editor
const GLEAM_OPERATORS = [
"<<", ">>", "<-", "->", "|>", "<>", "..",
"<=", "<=.", ">=", ">=.", "==", "==.", "%", "%.",
"!=", "!=.", '<', "<.", ">", ">.", "&&", "||",
"+", "+.", "-", "-.", "/", "/.", "*", "*.", "=",
]
const GLEAM_KEYWORDS = [
"as",
"assert",
"auto",
"case",
"const",
"delegate",
"derive",
"echo",
"else",
"fn",
"if",
"implement",
"import",
"let",
"macro",
"opaque",
"panic",
"pub",
"test",
"todo",
"type",
"use",
];
/**
* HLJS modes
* Glorified regular expressions used to target & highlight code snippets
*
* Ordered by `relevance` -> more or less translates to parsing order / priority
* https://highlightjs.readthedocs.io/en/stable/language-guide.html#relevance
*
* Their `scope` maps to 1 or more css class
* https://highlightjs.readthedocs.io/en/stable/css-classes-reference.html
*/
// Relevance 0
const PUNCTUATION = {
name: "punctuation",
scope: "punctuation",
match: regexes.punctuation,
relevance: 0,
};
const VARIABLES = {
scope: "variable",
match: regexes.snakeCase,
relevance: 0,
};
/**
* TODO: fix regex to not break other selectors
*/
const FUNCTION_PARAM = {
scope: "function-param",
match: regexes.functionParam,
relevance: 0,
}
const DISCARD_NAMES = {
scope: "attribute",
begin: regexes.discardName,
relevance: 0,
};
const MODULES = {
scope: "module",
match: regexes.importModule,
relevance: 0,
}
// Relevance 1
const OPERATORS = {
scope: "operator",
begin: regexes.operator,
keywords: {
operator: GLEAM_OPERATORS.join(" "),
$pattern: /\b\S+\b/g,
},
relevance: 1,
}
const KEYWORDS = {
name: 'Gleam keywords',
scope: "keyword",
keywords: {
keyword: GLEAM_KEYWORDS.join(" "),
operator: GLEAM_OPERATORS.join(" "),
},
relevance: 1,
};
// Relevance 2
const LITERALS = {
name: "Booleans or Nil",
scope: "literal",
match: regexes.literal,
relevance: 2,
};
const NUMBERS = {
name: "Number",
scope: "number",
variants: [
{
begin: regexes.number.binary
},
{
begin: regexes.number.octal
},
{
begin: regexes.number.hex
},
{
begin: regexes.number.decOrFloat
},
{
match: regexes.number.scientific
}
],
relevance: 2,
};
// Relevance 3
const TYPES = {
name: "Types & Aliases",
scope: "type",
match: regexes.type,
relevance: 3,
}
// Relevance 4
const FUNCTION_CALL = {
name: "Function calls",
scope: "function function-name function-call",
match: regexes.functionCall,
relevance: 4,
};
const FUNCTION_DECLARATION = {
name: "function declaration",
scope: "function function-name",
beginKeywords: "fn",
end: regexes.endParenthesis,
returnEnd: true,
relevance: 4,
};
// Relevance 5
// Relevance 6
const ATTRIBUTES = {
name: "Attributes",
scope: "attribute",
match: regexes.attribute,
relevance: 6,
}
// Relevance 7
const STRINGS = {
name: "Strings",
scope: "string",
variants: [{ begin: /"/, end: /"/ }],
contains: [hljs.BACKSLASH_ESCAPE],
relevance: 7,
};
// Relevance 8
const BIT_ARRAYS = {
// bit array
begin: "<<",
end: ">>",
scope: "operator",
contains: [
{
scope: "keyword",
beginKeywords:
"binary bits bytes int float bit_string bit_array bits utf8 utf16 " +
"utf32 utf8_codepoint utf16_codepoint utf32_codepoint signed " +
"unsigned big little native unit size",
},
cp(KEYWORDS),
cp(STRINGS),
cp(VARIABLES),
cp(DISCARD_NAMES),
cp(NUMBERS),
cp(PUNCTUATION),
],
relevance: 8,
};
// Relevance 10
const COMMENTS = {
name: "Comments",
scope: "comment",
match: regexes.comment,
relevance: 10,
}
/**
* Register the Gleam lang to HLJS global exported from `./highlight.core.min.js`
*/
hljs.registerLanguage("gleam", function(hljs) {
return {
name: "Gleam",
aliases: ["gleam"],
keywords: {
keyword: KEYWORDS.keywords.keyword,
operator: OPERATORS.keywords.operator,
},
contains: [
hljs.C_LINE_COMMENT_MODE,
cp(PUNCTUATION),
cp(MODULES),
cp(DISCARD_NAMES),
cp(OPERATORS),
cp(LITERALS),
cp(NUMBERS),
cp(TYPES),
cp(FUNCTION_DECLARATION),
cp(FUNCTION_CALL),
cp(ATTRIBUTES),
cp(STRINGS),
cp(COMMENTS),
],
};
});
/**
* Wait until other scripts & css are loaded before highlighting
*/
addEventListener("DOMContentLoaded", () => {
hljs.highlightAll();
})
|
