-
Notifications
You must be signed in to change notification settings - Fork 1
/
extension.ts
266 lines (227 loc) · 7.82 KB
/
extension.ts
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
/*---------------------------------------------------------
* Copyright (C) Microsoft Corporation. All rights reserved.
*--------------------------------------------------------*/
import path = require('path');
import * as fs from 'fs';
import * as vscode from 'vscode';
import { CodeActionKind, Disposable, Uri, env } from 'vscode';
import { EXTENSION_ROOT_DIR } from './constants';
export function openIssueReporter() {
const template = getTemplate();
const data = getData();
// TODO: add a command to open the issue reporter
vscode.commands.executeCommand('workbench.action.openIssueReporter', {
extensionId: 'ms-python.python',
issueTitle: 'title here',
body: 'body here',
command: {
template: template,
data: data,
uri: Uri.parse('https://github.com/microsoft/vscode-copilot-release').toString(),
}
});
}
function getTemplate(): string {
const templatePath = path.join(EXTENSION_ROOT_DIR, 'resources', 'report_issue_template.md');
try {
const data = fs.readFileSync(templatePath, 'utf-8');
return data;
} catch (err) {
throw new Error(`Error reading the file: ${err}`);
}
}
function getData(): string {
return 'temp data here: add some data stuff, fill in with more stuff, whoooohooo';
}
export async function activate(context: vscode.ExtensionContext) {
context.subscriptions.push(vscode.commands.registerCommand('extension.openIssueReporter', openIssueReporter));
// Custom Code Action with new ranges property
class RangedCodeAction extends vscode.CodeAction {
// Would most likely be provided by extension, by its code action edits or diagnostics
override readonly ranges = [new vscode.Range(3, 0, 3, 10), new vscode.Range(1, 0, 1, 10)];
}
// Code Action Provider
class OpenIssueReporterActionProvider implements vscode.CodeActionProvider {
static readonly providedCodeActionKinds = [
vscode.CodeActionKind.Refactor
];
provideCodeActions(document: vscode.TextDocument, range: vscode.Range | vscode.Selection, context: vscode.CodeActionContext, token: vscode.CancellationToken): vscode.ProviderResult<vscode.CodeAction[]> {
const action = new RangedCodeAction('Open Issue Reporter', OpenIssueReporterActionProvider.providedCodeActionKinds[0]);
action.command = {
command: 'extension.openIssueReporter',
title: 'Demo: Open Issue Reporter',
};
return [action];
}
}
context.subscriptions.push(vscode.languages.registerCodeActionsProvider({ scheme: 'file' }, new OpenIssueReporterActionProvider(), {
providedCodeActionKinds: OpenIssueReporterActionProvider.providedCodeActionKinds
}));
const filePath = path.join(EXTENSION_ROOT_DIR, 'resources', 'foo.txt');
const notebookSelector: vscode.DocumentSelector = {
notebookType: 'jupyter-notebook',
};
// context.subscriptions.push(registerIssueUriRequestHandler());
// context.subscriptions.push(registerIssueDataProvider());
// Notebook Level Code Action Provider
context.subscriptions.push(
vscode.languages.registerCodeActionsProvider(notebookSelector, new CleanImportProvider(), {
providedCodeActionKinds: CleanImportProvider.providedCodeActionKinds,
})
);
// Cell Level Code Action Provider
context.subscriptions.push(
vscode.languages.registerCodeActionsProvider(
notebookSelector,
new SampleCodeActionProvider(),
{
providedCodeActionKinds: SampleCodeActionProvider.providedCodeActionKinds,
}
)
);
}
/**
* Notebook Level Code Action Provider
* Takes all mentions of import "xx" and extracts them to a new top code cell.
*/
export class CleanImportProvider implements vscode.CodeActionProvider {
static readonly cleanImportKind = CodeActionKind.Notebook.append(
CodeActionKind.Source.append('cleanImports').value
);
public static readonly providedCodeActionKinds = [CleanImportProvider.cleanImportKind];
constructor() {
console.log('CREATED -- CleanImportProvider');
}
public provideCodeActions(
document: vscode.TextDocument,
_range: vscode.Range | vscode.Selection,
_context: vscode.CodeActionContext,
_token: vscode.CancellationToken
): vscode.CodeAction[] | undefined {
// console.log(`PROVIDED -- ${document.uri}`);
const notebookDocument = this.getNotebookDocument(document);
if (!notebookDocument) {
return;
}
const edits = this.extractImportsAndCreateCellEdits(notebookDocument);
if (!edits) {
return;
}
const fix = new vscode.CodeAction(
'Extract imports to new cell.',
CleanImportProvider.cleanImportKind
);
fix.edit = new vscode.WorkspaceEdit();
fix.edit.set(notebookDocument.uri, edits);
return [fix];
}
private extractImportsAndCreateCellEdits(notebookDocument: vscode.NotebookDocument) {
const nbEdits: vscode.NotebookEdit[] = [];
const importStatements: vscode.TextLine[] = [];
for (const cell of notebookDocument.getCells()) {
if (cell.kind !== vscode.NotebookCellKind.Code) {
continue;
}
let i = 0;
let nonImportText = '';
while (i < cell.document.lineCount) {
const l = cell.document.lineAt(i);
if (l) {
if (l.text.startsWith('import') || l.text.startsWith('from')) {
if (!importStatements.includes(l)) {
importStatements.push(l);
}
} else {
nonImportText += l.text + '\n';
}
}
i++;
}
// create the edit to remove the imports from the cell
const newCell = new vscode.NotebookCellData(
vscode.NotebookCellKind.Code,
nonImportText,
'python'
);
nbEdits.push(
vscode.NotebookEdit.replaceCells(
new vscode.NotebookRange(cell.index, cell.index + 1),
[newCell]
)
);
}
if (!importStatements.length) {
return;
}
// create the edit to create a new top cell containing all imports
const newCell = new vscode.NotebookCellData(
vscode.NotebookCellKind.Code,
importStatements.map((l) => l.text).join('\n') + '\n',
'python'
);
nbEdits.push(new vscode.NotebookEdit(new vscode.NotebookRange(0, 0), [newCell]));
return nbEdits;
}
private getNotebookDocument(
document: vscode.TextDocument
): vscode.NotebookDocument | undefined {
for (const nb of vscode.workspace.notebookDocuments) {
if (nb.uri.path === document.uri.path) {
return nb;
}
}
return undefined;
}
}
/**
* Cell Level Code Action Provider
* Provides code actions adding import pandas at beginning of cell(s)
* Just a test platform, no good functionality
*/
export class SampleCodeActionProvider implements vscode.CodeActionProvider {
public static readonly providedCodeActionKinds = [vscode.CodeActionKind.SourceFixAll];
provideCodeActions(
document: vscode.TextDocument,
_range: vscode.Range | vscode.Selection,
_context: vscode.CodeActionContext,
_token: vscode.CancellationToken
): vscode.CodeAction[] {
const edit = new vscode.WorkspaceEdit();
edit.insert(document.uri, new vscode.Position(0, 0), 'import pandas as pd\n');
return [
{
title: 'Fix Cell',
edit: edit,
kind: vscode.CodeActionKind.SourceFixAll,
},
];
}
}
let stringMD = 'did not properly get markdown file';
const templatePath = path.join(EXTENSION_ROOT_DIR, 'resources', 'report_issue_template.md');
fs.readFile(templatePath, 'utf-8', (err, data) => {
if (err) {
console.error(`Error reading the file: ${err}`);
} else {
// The file content is now in the 'data' variable
stringMD = data;
}
});
// function registerIssueUriRequestHandler(): Disposable {
// return env.registerIssueUriRequestHandler({
// handleIssueUrlRequest: () => Uri.parse('https://github.com/microsoft/vscode-copilot-release'),
// });
// }
// function registerIssueDataProvider(): Disposable {
// return env.registerIssueDataProvider({
// provideIssueTemplate: () => {
// return stringMD;
// ;
// },
// provideIssueData: async () => {
// // You can change the timeout here to see the loading/error state.
// await new Promise((resolve) => setTimeout(resolve, 2000));
// return 'temp data here: add some data stuff, fill in with more stuff, whoooohooo';
// },
// });
// }