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
|
/**
* Automatically generates tasks from package.json scripts.
*/
import * as vscode from "vscode";
import { BunTask } from "./tasks";
import { debugCommand } from "../debug";
/**
* Parses tasks defined in the package.json.
*/
export async function providePackageJsonTasks(): Promise<BunTask[]> {
//
const scripts: Record<string, string> = await (async () => {
try {
const file = vscode.Uri.file(vscode.workspace.workspaceFolders[0]?.uri.fsPath + "/package.json");
// Load contents of package.json, no need to check if file exists, we return null if it doesn't
const contents = await vscode.workspace.fs.readFile(file);
return JSON.parse(contents.toString()).scripts;
} catch {
return null;
}
})();
if (!scripts) return [];
return Object.entries(scripts).map(([name, script]) => {
// Prefix script with bun if it doesn't already start with bun
const shellCommand = script.startsWith("bun run ") ? script : `bun run ${script}`;
const task = new BunTask({
script,
name,
detail: `${shellCommand} - package.json`,
execution: new vscode.ShellExecution(shellCommand),
});
return task;
});
}
export function registerPackageJsonProviders(context: vscode.ExtensionContext) {
registerCodeLensProvider(context);
registerHoverProvider(context);
}
/**
* Utility function to extract the scripts from a package.json file, including their name and position in the document.
*/
function extractScriptsFromPackageJson(document: vscode.TextDocument) {
const content = document.getText();
const matches = content.match(/"scripts"\s*:\s*{([\s\S]*?)}/);
if (!matches || matches.length < 2) return null;
const startIndex = content.indexOf(matches[0]);
const endIndex = startIndex + matches[0].length;
const range = new vscode.Range(document.positionAt(startIndex), document.positionAt(endIndex));
const scripts = matches[1].split(/,\s*/).map(script => {
const elements = script.match(/"([^"\\]|\\.|\\\n)*"/g);
if (elements?.length != 2) return null;
const [name, command] = elements;
return {
name: name.replace('"', "").trim(),
command: command.replace(/(?<!\\)"/g, "").trim(),
range: new vscode.Range(
document.positionAt(startIndex + matches[0].indexOf(name)),
document.positionAt(startIndex + matches[0].indexOf(name) + name.length + command.length),
),
};
});
return {
range,
scripts,
};
}
/**
* This function registers a CodeLens provider for package.json files. It is used to display the "Run" and "Debug" buttons
* above the scripts properties in package.json (inline).
*/
function registerCodeLensProvider(context: vscode.ExtensionContext) {
context.subscriptions.push(
// Register CodeLens provider for package.json files
vscode.languages.registerCodeLensProvider(
{
language: "json",
scheme: "file",
pattern: "**/package.json",
},
{
provideCodeLenses(document: vscode.TextDocument) {
const { range } = extractScriptsFromPackageJson(document);
const codeLenses: vscode.CodeLens[] = [];
codeLenses.push(
new vscode.CodeLens(range, {
title: "$(breakpoints-view-icon) Bun: Debug",
tooltip: "Debug a script using bun",
command: "extension.bun.codelens.run",
arguments: [{ type: "debug" }],
}),
new vscode.CodeLens(range, {
title: "$(debug-start) Bun: Run",
tooltip: "Run a script using bun",
command: "extension.bun.codelens.run",
arguments: [{ type: "run" }],
}),
);
return codeLenses;
},
resolveCodeLens(codeLens) {
return codeLens;
},
},
),
// Register the commands that are executed when clicking the CodeLens buttons
vscode.commands.registerCommand("extension.bun.codelens.run", async ({ type }: { type: "debug" | "run" }) => {
const tasks = (await vscode.tasks.fetchTasks({ type: "bun" })) as BunTask[];
if (tasks.length === 0) return;
const pick = await vscode.window.showQuickPick(
tasks
.filter(task => task.detail.endsWith("package.json"))
.map(task => ({
label: task.name,
detail: task.detail,
})),
);
if (!pick) return;
const task = tasks.find(task => task.name === pick.label);
if (!task) return;
const command = type === "debug" ? "extension.bun.codelens.debug.task" : "extension.bun.codelens.run.task";
vscode.commands.executeCommand(command, {
script: task.definition.script,
name: task.name,
});
}),
);
}
function getActiveTerminal(name: string) {
return vscode.window.terminals.filter(terminal => terminal.name === name);
}
interface CommandArgs {
script: string;
name: string;
}
/**
* This function registers a Hover language feature provider for package.json files. It is used to display the
* "Run" and "Debug" buttons when hovering over a script property in package.json.
*/
function registerHoverProvider(context: vscode.ExtensionContext) {
context.subscriptions.push(
vscode.languages.registerHoverProvider("json", {
provideHover(document, position) {
const { scripts } = extractScriptsFromPackageJson(document);
return {
contents: scripts.map(script => {
if (!script.range.contains(position)) return null;
const command = encodeURI(JSON.stringify({ script: script.command, name: script.name }));
const markdownString = new vscode.MarkdownString(
`[Debug](command:extension.bun.codelens.debug.task?${command}) | [Run](command:extension.bun.codelens.run.task?${command})`,
);
markdownString.isTrusted = true;
return markdownString;
}),
};
},
}),
vscode.commands.registerCommand("extension.bun.codelens.debug.task", async ({ script, name }: CommandArgs) => {
if (script.startsWith("bun run ")) script = script.slice(8);
if (script.startsWith("bun ")) script = script.slice(4);
debugCommand(script);
}),
vscode.commands.registerCommand("extension.bun.codelens.run.task", async ({ script, name }: CommandArgs) => {
if (script.startsWith("bun run ")) script = script.slice(8);
name = `Bun Task: ${name}`;
const terminals = getActiveTerminal(name);
if (terminals.length > 0) {
terminals[0].show();
terminals[0].sendText(`bun run ${script}`);
return;
}
const terminal = vscode.window.createTerminal({ name });
terminal.show();
terminal.sendText(`bun run ${script}`);
}),
);
}
|
