xonecas.io
719
Le

lextide / files

lextide / test / bash-language-support.test.ts

4.5 KB
1import { describe, expect, test } from "bun:test";
2
3import { common, createLowlight } from "../src/index";
4import {
5	plainText,
6	simplifyChildren,
7	textsForClass,
8} from "./language-test-helpers";
9
10const lowlight = createLowlight(common);
11const BASH_SOURCE_VARIABLE = "${" + "BASH_SOURCE[0]}";
12const UPSTREAM_BUILT_IN_SAMPLE = [
13	"break",
14	"continue",
15	"getopts",
16	"hash",
17	"set",
18	"shopt",
19	"basename",
20	"dirname",
21	"printenv",
22	"readlink",
23	"sleep",
24	"whoami",
25	"yes",
26] as const;
27
28describe("bash language support", () => {
29	test("shebang_controlFlowKeywords_and_literals_are_scoped", () => {
30		const source = "#!/usr/bin/env bash\nif true; then false; fi\n";
31		const tree = lowlight.highlight("bash", source);
32
33		expect(textsForClass(tree, "hljs-meta")).toEqual(["#!/usr/bin/env bash"]);
34		expect(textsForClass(tree, "hljs-keyword")).toEqual(["if", "then", "fi"]);
35		expect(textsForClass(tree, "hljs-literal")).toEqual(["true", "false"]);
36		expect(plainText(tree)).toBe(source);
37	});
38
39	test("functionTitles_and_assignments_scopeIdentifierParts_only", () => {
40		const source = "greet() {\n  foo=1\n  arr[0]=42\n}\n";
41		const tree = lowlight.highlight("bash", source);
42
43		expect(textsForClass(tree, "hljs-title")).toEqual(["greet"]);
44		expect(textsForClass(tree, "function_")).toEqual(["greet"]);
45		expect(textsForClass(tree, "hljs-variable")).toEqual(["foo", "arr"]);
46		expect(textsForClass(tree, "hljs-number")).toEqual(["1", "0", "42"]);
47		expect(plainText(tree)).toBe(source);
48	});
49
50	test("doubleQuotedStrings_keep_variableInterpolation_nested", () => {
51		const source = 'echo "hi $USER"\n';
52		const tree = lowlight.highlight("bash", source);
53
54		expect(simplifyChildren(tree.children)).toEqual([
55			["span", ["hljs-built_in"], ["echo"]],
56			["text", " "],
57			[
58				"span",
59				["hljs-string"],
60				['"hi ', ["span", ["hljs-variable"], ["$USER"]], '"'],
61			],
62			["text", "\n"],
63		]);
64		expect(plainText(tree)).toBe(source);
65	});
66
67	test("commandSubstitutions_keep_innerCommands_and_nestedVariables_scoped", () => {
68		const source = `result=$(dirname "${BASH_SOURCE_VARIABLE}")\n`;
69		const tree = lowlight.highlight("bash", source);
70
71		expect(textsForClass(tree, "hljs-built_in")).toEqual(["dirname"]);
72		expect(textsForClass(tree, "hljs-string")).toEqual([
73			`"${BASH_SOURCE_VARIABLE}"`,
74		]);
75		expect(textsForClass(tree, "hljs-variable")).toEqual([
76			"result",
77			BASH_SOURCE_VARIABLE,
78		]);
79		expect(plainText(tree)).toBe(source);
80	});
81
82	test("hereDocs_keep_bodyAsString_without_leaking_variableScopes", () => {
83		const source = "cat <<EOF\nhello $USER\nEOF\n";
84		const tree = lowlight.highlight("bash", source);
85
86		expect(textsForClass(tree, "hljs-built_in")).toEqual(["cat"]);
87		expect(textsForClass(tree, "hljs-string")).toEqual([
88			"<<EOF\nhello $USER\nEOF",
89		]);
90		expect(textsForClass(tree, "hljs-variable")).toEqual([]);
91		expect(plainText(tree)).toBe(source);
92	});
93
94	test("upstreamBuiltInSample_is_recognized_as_built_in_commands", () => {
95		const source = `${UPSTREAM_BUILT_IN_SAMPLE.join("\n")}\n`;
96		const tree = lowlight.highlight("bash", source);
97		const builtIns = new Set(textsForClass(tree, "hljs-built_in"));
98		const missing = UPSTREAM_BUILT_IN_SAMPLE.filter(
99			(name) => !builtIns.has(name),
100		);
101
102		expect(missing).toEqual([]);
103		expect(plainText(tree)).toBe(source);
104	});
105
106	test("arithmetic_supports_basePrefixedNumbers_as_complete_number_tokens", () => {
107		const source = "echo $((16#ff + 2#10 + 1))\n";
108		const tree = lowlight.highlight("bash", source);
109
110		expect(textsForClass(tree, "hljs-built_in")).toEqual(["echo"]);
111		expect(textsForClass(tree, "hljs-number")).toEqual(["16#ff", "2#10", "1"]);
112		expect(plainText(tree)).toBe(source);
113	});
114
115	test("commandFlags_and_shellOperators_are_scoped_in_cli_pipelines", () => {
116		const source = [
117			'if [ -n "$USER" ]; then',
118			"  mkdir -p ./tmp/demo && ls --color=never ./tmp/demo | wc -l",
119			'  curl --fail https://example.com | jq -r ".title" && echo "hello $(whoami)"',
120			"fi",
121			"",
122		].join("\n");
123		const tree = lowlight.highlight("bash", source);
124
125		expect(textsForClass(tree, "hljs-keyword")).toEqual(["if", "then", "fi"]);
126		expect(textsForClass(tree, "hljs-built_in")).toEqual([
127			"mkdir",
128			"ls",
129			"wc",
130			"curl",
131			"jq",
132			"echo",
133			"whoami",
134		]);
135		expect(textsForClass(tree, "hljs-attr")).toEqual([
136			"-n",
137			"-p",
138			"--color=never",
139			"-l",
140			"--fail",
141			"-r",
142		]);
143		expect(textsForClass(tree, "hljs-operator")).toEqual([
144			"&&",
145			"|",
146			"|",
147			"&&",
148		]);
149		expect(textsForClass(tree, "hljs-variable")).toEqual(["$USER"]);
150		expect(plainText(tree)).toBe(source);
151	});
152});