-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdeveloper-feedback.ts
More file actions
738 lines (645 loc) · 21.3 KB
/
developer-feedback.ts
File metadata and controls
738 lines (645 loc) · 21.3 KB
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
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
// @ts-nocheck
const { WebClient } = require("@slack/web-api");
const fs = require("fs-extra");
const path = require("path");
export class DeveloperFeedback {
constructor() {
this.slack = null;
this.initializeSlack();
this.notificationQueue = [];
this.vscodeExtensionPath = process.env.VSCODE_EXTENSION_PATH || "./vscode-extension";
}
/**
* Initialize Slack client
*/
initializeSlack() {
const slackToken = process.env.SLACK_BOT_TOKEN;
if (slackToken) {
this.slack = new WebClient(slackToken);
console.log("✅ Slack client initialized");
} else {
console.warn("⚠️ No Slack token found. Notifications will be queued.");
}
}
/**
* Send Slack notification
* @param {Object} notification - Notification object
*/
async sendSlackNotification(notification) {
if (!this.slack) {
this.notificationQueue.push(notification);
return;
}
try {
const channel = process.env.SLACK_CHANNEL || "#specsync";
const message = this.formatSlackMessage(notification);
await this.slack.chat.postMessage({
channel: channel,
...message,
});
console.log(`📢 Slack notification sent: ${notification.type}`);
} catch (error) {
console.error("Error sending Slack notification:", error);
this.notificationQueue.push(notification);
}
}
/**
* Format Slack message
* @param {Object} notification - Notification object
* @returns {Object} Formatted Slack message
*/
formatSlackMessage(notification) {
const baseMessage = {
text: notification.title,
blocks: [
{
type: "header",
text: {
type: "plain_text",
text: notification.title,
},
},
{
type: "section",
text: {
type: "mrkdwn",
text: notification.description,
},
},
],
};
// Add action buttons for spec suggestions
if (notification.type === "spec_suggestion") {
baseMessage.blocks.push({
type: "actions",
elements: [
{
type: "button",
text: {
type: "plain_text",
text: "✅ Accept",
},
style: "primary",
value: `accept_${notification.functionName}`,
},
{
type: "button",
text: {
type: "plain_text",
text: "✏️ Edit",
},
value: `edit_${notification.functionName}`,
},
{
type: "button",
text: {
type: "plain_text",
text: "❌ Ignore",
},
style: "danger",
value: `ignore_${notification.functionName}`,
},
],
});
}
// Add context for proof failures
if (notification.type === "proof_failure") {
baseMessage.blocks.push({
type: "context",
elements: [
{
type: "mrkdwn",
text: `*File:* ${notification.file}\n*Function:* ${notification.functionName}`,
},
],
});
}
return baseMessage;
}
/**
* Notify about new spec suggestion
* @param {Object} spec - Specification object
* @param {Object} context - GitHub context
*/
async notifySpecSuggestion(spec, context) {
const notification = {
type: "spec_suggestion",
title: "🤖 New SpecSync Suggestion",
description: `A new specification has been generated for \`${spec.functionName}\` with ${spec.confidence}% confidence.`,
functionName: spec.functionName,
confidence: spec.confidence,
prUrl: context.payload.pull_request?.html_url,
timestamp: new Date().toISOString(),
};
await this.sendSlackNotification(notification);
}
/**
* Notify about proof failure
* @param {Object} proofFailure - Proof failure object
* @param {Object} context - GitHub context
*/
async notifyProofFailure(proofFailure, context) {
const notification = {
type: "proof_failure",
title: "❌ Proof Validation Failed",
description: `A Lean4 proof has failed validation. Please review and fix the proof.`,
functionName: proofFailure.functionName,
file: proofFailure.file,
error: proofFailure.error,
prUrl: context.payload.pull_request?.html_url,
timestamp: new Date().toISOString(),
};
await this.sendSlackNotification(notification);
}
/**
* Notify about drift detection
* @param {Object} drift - Drift detection object
* @param {Object} context - GitHub context
*/
async notifyDriftDetection(drift, context) {
const notification = {
type: "drift_detection",
title: "⚠️ Spec Drift Detected",
description: `Specification drift detected for \`${drift.functionName}\`. The implementation may no longer satisfy the existing specification.`,
functionName: drift.functionName,
confidence: drift.confidence,
details: drift.driftDetails,
prUrl: context.payload.pull_request?.html_url,
timestamp: new Date().toISOString(),
};
await this.sendSlackNotification(notification);
}
/**
* Generate VSCode extension
* @param {string} outputPath - Output path for extension
* @returns {string} Extension path
*/
async generateVSCodeExtension(outputPath = "./vscode-extension") {
const extensionPath = path.resolve(outputPath);
// Create extension directory structure
await fs.ensureDir(extensionPath);
await fs.ensureDir(path.join(extensionPath, "src"));
await fs.ensureDir(path.join(extensionPath, "resources"));
// Generate package.json
const packageJson = this.generateExtensionPackageJson();
await fs.writeFile(
path.join(extensionPath, "package.json"),
JSON.stringify(packageJson, null, 2)
);
// Generate extension.ts
const extensionTs = this.generateExtensionTypeScript();
await fs.writeFile(path.join(extensionPath, "src/extension.ts"), extensionTs);
// Generate README
const readme = this.generateExtensionReadme();
await fs.writeFile(path.join(extensionPath, "README.md"), readme);
// Generate configuration
const config = this.generateExtensionConfig();
await fs.writeFile(path.join(extensionPath, "package.json"), JSON.stringify(config, null, 2));
console.log(`✅ VSCode extension generated at ${extensionPath}`);
return extensionPath;
}
/**
* Generate extension package.json
* @returns {Object} Package.json content
*/
generateExtensionPackageJson() {
return {
name: "specsync",
displayName: "SpecSync",
description: "Formal specification integration for VSCode",
version: "1.0.0",
publisher: "specsync",
categories: ["Other"],
activationEvents: [
"onCommand:specsync.showSpec",
"onCommand:specsync.editSpec",
"onCommand:specsync.runProof",
"onLanguage:javascript",
"onLanguage:typescript",
"onLanguage:python",
"onLanguage:java",
],
main: "./out/extension.js",
contributes: {
commands: [
{
command: "specsync.showSpec",
title: "Show Specification",
category: "SpecSync",
},
{
command: "specsync.editSpec",
title: "Edit Specification",
category: "SpecSync",
},
{
command: "specsync.runProof",
title: "Run Lean4 Proof",
category: "SpecSync",
},
],
configuration: {
title: "SpecSync",
properties: {
"specsync.apiUrl": {
type: "string",
default: "http://localhost:3000",
description: "SpecSync API URL",
},
"specsync.autoShowSpec": {
type: "boolean",
default: true,
description: "Automatically show specifications when hovering over functions",
},
},
},
},
scripts: {
"vscode:prepublish": "npm run compile",
compile: "tsc -p ./",
watch: "tsc -watch -p ./",
},
devDependencies: {
"@types/vscode": "^1.74.0",
"@types/node": "^16.11.7",
typescript: "^4.7.4",
},
};
}
/**
* Generate extension TypeScript
* @returns {string} Extension TypeScript content
*/
generateExtensionTypeScript() {
return `
import * as vscode from 'vscode';
import * as path from 'path';
export function activate(context: vscode.ExtensionContext) {
console.log('SpecSync extension is now active!');
// Register commands
let showSpec = vscode.commands.registerCommand('specsync.showSpec', () => {
showSpecification();
});
let editSpec = vscode.commands.registerCommand('specsync.editSpec', () => {
editSpecification();
});
let runProof = vscode.commands.registerCommand('specsync.runProof', () => {
runLeanProof();
});
context.subscriptions.push(showSpec, editSpec, runProof);
// Register hover provider
const hoverProvider = vscode.languages.registerHoverProvider(
['javascript', 'typescript', 'python', 'java'],
{
provideHover(document, position, token) {
return provideSpecHover(document, position);
}
}
);
context.subscriptions.push(hoverProvider);
}
export function deactivate() {}
async function showSpecification() {
const editor = vscode.window.activeTextEditor;
if (!editor) {
vscode.window.showInformationMessage('No active editor');
return;
}
const position = editor.selection.active;
const functionName = getFunctionAtPosition(editor.document, position);
if (!functionName) {
vscode.window.showInformationMessage('No function found at cursor position');
return;
}
try {
const config = vscode.workspace.getConfiguration('specsync');
const apiUrl = config.get('apiUrl', 'http://localhost:3000');
const response = await fetch(\`\${apiUrl}/api/spec/\${functionName}\`);
const spec = await response.json();
if (spec.success) {
showSpecPanel(spec.data);
} else {
vscode.window.showInformationMessage('No specification found for this function');
}
} catch (error) {
vscode.window.showErrorMessage('Failed to fetch specification');
}
}
async function editSpecification() {
const editor = vscode.window.activeTextEditor;
if (!editor) {
vscode.window.showInformationMessage('No active editor');
return;
}
const position = editor.selection.active;
const functionName = getFunctionAtPosition(editor.document, position);
if (!functionName) {
vscode.window.showInformationMessage('No function found at cursor position');
return;
}
// Open spec editing panel
const panel = vscode.window.createWebviewPanel(
'specEdit',
'Edit Specification',
vscode.ViewColumn.One,
{
enableScripts: true
}
);
panel.webview.html = generateSpecEditHTML(functionName);
}
async function runLeanProof() {
const editor = vscode.window.activeTextEditor;
if (!editor) {
vscode.window.showInformationMessage('No active editor');
return;
}
const position = editor.selection.active;
const functionName = getFunctionAtPosition(editor.document, position);
if (!functionName) {
vscode.window.showInformationMessage('No function found at cursor position');
return;
}
// Run Lean4 proof
const terminal = vscode.window.createTerminal('SpecSync Proof');
terminal.show();
terminal.sendText(\`lean --json specs/\${functionName}_spec.lean\`);
}
function getFunctionAtPosition(document: vscode.TextDocument, position: vscode.Position): string | null {
const line = document.lineAt(position.line);
const text = line.text;
// Simple function detection
const functionPatterns = [
/function\\s+(\\w+)\\s*\\(/,
/const\\s+(\\w+)\\s*=\\s*\\(/,
/def\\s+(\\w+)\\s*\\(/,
/public\\s+\\w+\\s+(\\w+)\\s*\\(/
];
for (const pattern of functionPatterns) {
const match = text.match(pattern);
if (match) {
return match[1];
}
}
return null;
}
function provideSpecHover(document: vscode.TextDocument, position: vscode.Position): vscode.Hover | null {
const functionName = getFunctionAtPosition(document, position);
if (!functionName) {
return null;
}
const config = vscode.workspace.getConfiguration('specsync');
const autoShow = config.get('autoShowSpec', true);
if (!autoShow) {
return null;
}
// Return hover with spec info
return new vscode.Hover([
'**SpecSync Specification**',
\`Function: \${functionName}\`,
'Click to view full specification'
]);
}
function showSpecPanel(spec: any) {
const panel = vscode.window.createWebviewPanel(
'specView',
'Specification',
vscode.ViewColumn.One,
{
enableScripts: true
}
);
panel.webview.html = generateSpecViewHTML(spec);
}
function generateSpecViewHTML(spec: any): string {
return \`
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Specification</title>
<style>
body { font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', sans-serif; padding: 20px; }
.spec-section { margin: 20px 0; }
.spec-title { font-weight: bold; color: #333; }
.spec-content { margin: 10px 0; padding: 10px; background: #f5f5f5; border-radius: 4px; }
.confidence { color: #666; font-size: 0.9em; }
</style>
</head>
<body>
<h2>Specification for \${spec.functionName}</h2>
<div class="confidence">Confidence: \${spec.confidence}%</div>
<div class="spec-section">
<div class="spec-title">Preconditions:</div>
<div class="spec-content">
\${spec.preconditions.map(p => \`<div>• \${p}</div>\`).join('')}
</div>
</div>
<div class="spec-section">
<div class="spec-title">Postconditions:</div>
<div class="spec-content">
\${spec.postconditions.map(p => \`<div>• \${p}</div>\`).join('')}
</div>
</div>
<div class="spec-section">
<div class="spec-title">Invariants:</div>
<div class="spec-content">
\${spec.invariants.map(i => \`<div>• \${i}</div>\`).join('')}
</div>
</div>
<div class="spec-section">
<div class="spec-title">Edge Cases:</div>
<div class="spec-content">
\${spec.edgeCases.map(e => \`<div>• \${e}</div>\`).join('')}
</div>
</div>
</body>
</html>
\`;
}
function generateSpecEditHTML(functionName: string): string {
return \`
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Edit Specification</title>
<style>
body { font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', sans-serif; padding: 20px; }
.form-group { margin: 20px 0; }
label { display: block; font-weight: bold; margin-bottom: 5px; }
textarea { width: 100%; height: 100px; padding: 10px; border: 1px solid #ccc; border-radius: 4px; }
button { padding: 10px 20px; background: #007acc; color: white; border: none; border-radius: 4px; cursor: pointer; }
button:hover { background: #005a9e; }
</style>
</head>
<body>
<h2>Edit Specification for \${functionName}</h2>
<form id="specForm">
<div class="form-group">
<label for="preconditions">Preconditions (one per line):</label>
<textarea id="preconditions" name="preconditions"></textarea>
</div>
<div class="form-group">
<label for="postconditions">Postconditions (one per line):</label>
<textarea id="postconditions" name="postconditions"></textarea>
</div>
<div class="form-group">
<label for="invariants">Invariants (one per line):</label>
<textarea id="invariants" name="invariants"></textarea>
</div>
<div class="form-group">
<label for="edgeCases">Edge Cases (one per line):</label>
<textarea id="edgeCases" name="edgeCases"></textarea>
</div>
<button type="submit">Save Specification</button>
</form>
<script>
document.getElementById('specForm').addEventListener('submit', function(e) {
e.preventDefault();
const formData = {
functionName: '\${functionName}',
preconditions: document.getElementById('preconditions').value.split('\\n').filter(line => line.trim()),
postconditions: document.getElementById('postconditions').value.split('\\n').filter(line => line.trim()),
invariants: document.getElementById('invariants').value.split('\\n').filter(line => line.trim()),
edgeCases: document.getElementById('edgeCases').value.split('\\n').filter(line => line.trim())
};
// Send to SpecSync API
fetch('/api/spec', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify(formData)
}).then(response => {
if (response.ok) {
vscode.postMessage({ command: 'specSaved' });
}
});
});
</script>
</body>
</html>
\`;
}
`;
}
/**
* Generate extension README
* @returns {string} README content
*/
generateExtensionReadme() {
return `# SpecSync VSCode Extension
This extension provides integration with SpecSync for formal specification management in VSCode.
## Features
- **Inline Specification Display**: Hover over functions to see their specifications
- **Specification Editing**: Edit preconditions, postconditions, invariants, and edge cases
- **Lean4 Proof Execution**: Run Lean4 proofs directly from VSCode
- **Real-time Updates**: Specifications update automatically when changed
## Commands
- \`SpecSync: Show Specification\` - Display specification for the function at cursor
- \`SpecSync: Edit Specification\` - Open specification editor
- \`SpecSync: Run Lean4 Proof\` - Execute Lean4 proof for current function
## Configuration
- \`specsync.apiUrl\` - SpecSync API URL (default: http://localhost:3000)
- \`specsync.autoShowSpec\` - Automatically show specifications on hover (default: true)
## Installation
1. Build the extension: \`npm run compile\`
2. Package the extension: \`vsce package\`
3. Install the .vsix file in VSCode
## Development
\`\`\`bash
npm install
npm run compile
npm run watch
\`\`\`
## Usage
1. Open a JavaScript/TypeScript/Python/Java file
2. Hover over a function to see its specification
3. Use commands to edit specifications or run proofs
4. Specifications are automatically synced with SpecSync API
`;
}
/**
* Generate extension configuration
* @returns {Object} Configuration object
*/
generateExtensionConfig() {
return {
name: "specsync",
displayName: "SpecSync",
description: "Formal specification integration for VSCode",
version: "1.0.0",
publisher: "specsync",
categories: ["Other"],
activationEvents: [
"onCommand:specsync.showSpec",
"onCommand:specsync.editSpec",
"onCommand:specsync.runProof",
],
main: "./out/extension.js",
contributes: {
commands: [
{
command: "specsync.showSpec",
title: "Show Specification",
category: "SpecSync",
},
{
command: "specsync.editSpec",
title: "Edit Specification",
category: "SpecSync",
},
{
command: "specsync.runProof",
title: "Run Lean4 Proof",
category: "SpecSync",
},
],
configuration: {
title: "SpecSync",
properties: {
"specsync.apiUrl": {
type: "string",
default: "http://localhost:3000",
description: "SpecSync API URL",
},
"specsync.autoShowSpec": {
type: "boolean",
default: true,
description: "Automatically show specifications when hovering over functions",
},
},
},
},
};
}
/**
* Process queued notifications
*/
async processQueuedNotifications() {
if (this.notificationQueue.length === 0) {
return;
}
console.log(`Processing ${this.notificationQueue.length} queued notifications...`);
for (const notification of this.notificationQueue) {
try {
await this.sendSlackNotification(notification);
} catch (error) {
console.error("Error processing queued notification:", error);
}
}
this.notificationQueue = [];
}
/**
* Get notification statistics
* @returns {Object} Notification statistics
*/
getNotificationStats() {
return {
queued: this.notificationQueue.length,
slackConnected: this.slack !== null,
lastProcessed: new Date().toISOString(),
};
}
}