Skip to content

Commit f8aff0b

Browse files
carloseberhardtcarloseberhardt
authored
feat: standardize all commands per issue #35 (#51)
## Changes Made ### Standardized 5 Commands - **openSchemaVisualizer.ts**: Added try/catch, handleError, start/finish logging - **goToDefinition.ts**: Added try/catch, handleError, enhanced logging with progress tracking - **addMaterializer.ts**: Added services import, try/catch, handleError, comprehensive logging - **openExplorer.ts**: Added services import, try/catch, handleError, detailed progress logging - **runRequest.ts**: Added try/catch wrapper to main function, enhanced error handling consistency ### Pattern Applied - ✅ Copyright header: "Copyright IBM Corp. 2025, Assisted by CursorAI" - ✅ Services import: `import { services } from "../services"` - ✅ Error handling: `import { handleError } from "../errors"` - ✅ Try/catch wrapper: Main function body wrapped with handleError - ✅ Logging: Start/finish logging using services.logger - ✅ No util imports: Commands use services instead of direct util imports ### Already Standardized (4/9) - deploy.ts ✅ - initializeProject.ts ✅ - generateOperations.ts ✅ - executeStepZenRequest.ts ✅ ## Result All 9 commands in src/commands/ now follow the standardized pattern. ## Verification - ✅ TypeScript compilation successful - ✅ ESLint passes with no issues - ✅ All 91 tests pass - ✅ No breaking changes to existing functionality Closes #35
1 parent 079d0ec commit f8aff0b

File tree

5 files changed

+386
-293
lines changed

5 files changed

+386
-293
lines changed

‎src/commands/addMaterializer.ts‎

Lines changed: 91 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
1+
/**
2+
* Copyright IBM Corp. 2025
3+
* Assisted by CursorAI
4+
*/
5+
16
import * as vscode from 'vscode';
27
import { getRootOperationsMap } from '../utils/stepzenProjectScanner';
8+
import { services } from '../services';
9+
import { handleError } from '../errors';
310

411
/**
512
* Adds a @materializer directive to a GraphQL field
@@ -9,84 +16,101 @@ import { getRootOperationsMap } from '../utils/stepzenProjectScanner';
916
* @returns Promise that resolves when the materializer has been added or operation is cancelled
1017
*/
1118
export async function addMaterializer() {
12-
const editor = vscode.window.activeTextEditor;
13-
if (!editor) {
14-
vscode.window.showErrorMessage('No active editor');
15-
return;
16-
}
19+
try {
20+
services.logger.info("Starting Add Materializer command");
21+
22+
const editor = vscode.window.activeTextEditor;
23+
if (!editor) {
24+
vscode.window.showErrorMessage('No active editor');
25+
services.logger.warn("Add Materializer failed: No active editor");
26+
return;
27+
}
1728

18-
const document = editor.document;
19-
const position = editor.selection.active;
20-
const line = document.lineAt(position.line);
21-
const lineText = line.text;
29+
const document = editor.document;
30+
const position = editor.selection.active;
31+
const line = document.lineAt(position.line);
32+
const lineText = line.text;
2233

23-
// Determine current indentation from the line to preserve formatting
24-
const baseIndent = lineText.substring(0, line.firstNonWhitespaceCharacterIndex);
34+
// Determine current indentation from the line to preserve formatting
35+
const baseIndent = lineText.substring(0, line.firstNonWhitespaceCharacterIndex);
2536

26-
// Extract field name and declared type from the current line
27-
const trimmed = lineText.trim();
28-
const fieldMatch = trimmed.match(/^(\w+)\s*:\s*([^\s]+)/);
29-
if (!fieldMatch) {
30-
vscode.window.showInformationMessage('Place cursor on a GraphQL field definition.');
31-
return;
32-
}
33-
const declaredType = fieldMatch[2];
37+
// Extract field name and declared type from the current line
38+
const trimmed = lineText.trim();
39+
const fieldMatch = trimmed.match(/^(\w+)\s*:\s*([^\s]+)/);
40+
if (!fieldMatch) {
41+
vscode.window.showInformationMessage('Place cursor on a GraphQL field definition.');
42+
services.logger.warn("Add Materializer failed: Not on a GraphQL field definition");
43+
return;
44+
}
45+
const declaredType = fieldMatch[2];
46+
services.logger.info(`Processing field with type: ${declaredType}`);
3447

35-
// Determine base type and whether it's a list type
36-
const isList = declaredType.startsWith('[');
37-
const baseType = declaredType.replace(/[[\]!]/g, ''); // Remove [] and ! characters
48+
// Determine base type and whether it's a list type
49+
const isList = declaredType.startsWith('[');
50+
const baseType = declaredType.replace(/[[\]!]/g, ''); // Remove [] and ! characters
3851

39-
// Find matching root operations (queries) that return the same type
40-
const ops = Object.entries(getRootOperationsMap()).filter(([_opName, info]) => {
41-
return info.returnType === baseType && info.isList === isList;
42-
});
52+
// Find matching root operations (queries) that return the same type
53+
const ops = Object.entries(getRootOperationsMap()).filter(([_opName, info]) => {
54+
return info.returnType === baseType && info.isList === isList;
55+
});
4356

44-
if (ops.length === 0) {
45-
vscode.window.showInformationMessage(
46-
`No matching StepZen queries found for type ${declaredType}`
47-
);
48-
return;
49-
}
57+
if (ops.length === 0) {
58+
vscode.window.showInformationMessage(
59+
`No matching StepZen queries found for type ${declaredType}`
60+
);
61+
services.logger.warn(`No matching StepZen queries found for type ${declaredType}`);
62+
return;
63+
}
5064

51-
// Choose operation if multiple
52-
const pickItems = ops.map(([name]) => name);
53-
const chosen = pickItems.length === 1
54-
? pickItems[0]
55-
: await vscode.window.showQuickPick(pickItems, {
56-
placeHolder: 'Select a StepZen query to materialize',
57-
});
58-
if (!chosen) {
59-
return;
60-
}
65+
services.logger.info(`Found ${ops.length} matching operations for type ${declaredType}`);
6166

62-
// Get argument names
63-
const argNames = getRootOperationsMap()[chosen].args;
67+
// Choose operation if multiple
68+
const pickItems = ops.map(([name]) => name);
69+
const chosen = pickItems.length === 1
70+
? pickItems[0]
71+
: await vscode.window.showQuickPick(pickItems, {
72+
placeHolder: 'Select a StepZen query to materialize',
73+
});
74+
if (!chosen) {
75+
services.logger.info("Add Materializer cancelled by user");
76+
return;
77+
}
6478

65-
// Build directive snippet with proper indentation
66-
const indentUnit = editor.options.insertSpaces
67-
? ' '.repeat(editor.options.tabSize as number)
68-
: '\t';
69-
const directiveIndent = baseIndent + indentUnit;
70-
const innerIndent = directiveIndent + indentUnit;
79+
services.logger.info(`Selected operation: ${chosen}`);
7180

72-
const snippetLines: string[] = [];
73-
snippetLines.push(`${directiveIndent}@materializer(`);
74-
snippetLines.push(`${innerIndent}query: "${chosen}"`);
75-
snippetLines.push(`${innerIndent}arguments: [`);
81+
// Get argument names
82+
const argNames = getRootOperationsMap()[chosen].args;
7683

77-
for (const arg of argNames) {
78-
snippetLines.push(
79-
`${innerIndent}${indentUnit}{ name: "${arg}", field: "" }`
80-
);
81-
}
84+
// Build directive snippet with proper indentation
85+
const indentUnit = editor.options.insertSpaces
86+
? ' '.repeat(editor.options.tabSize as number)
87+
: '\t';
88+
const directiveIndent = baseIndent + indentUnit;
89+
const innerIndent = directiveIndent + indentUnit;
90+
91+
const snippetLines: string[] = [];
92+
snippetLines.push(`${directiveIndent}@materializer(`);
93+
snippetLines.push(`${innerIndent}query: "${chosen}"`);
94+
snippetLines.push(`${innerIndent}arguments: [`);
95+
96+
for (const arg of argNames) {
97+
snippetLines.push(
98+
`${innerIndent}${indentUnit}{ name: "${arg}", field: "" }`
99+
);
100+
}
82101

83-
snippetLines.push(`${innerIndent}]`);
84-
snippetLines.push(`${directiveIndent})`);
102+
snippetLines.push(`${innerIndent}]`);
103+
snippetLines.push(`${directiveIndent})`);
85104

86-
// Insert snippet below current line
87-
const insertPosition = new vscode.Position(position.line + 1, 0);
88-
editor.insertSnippet(
89-
new vscode.SnippetString(snippetLines.join('\n')),
90-
insertPosition
91-
);
105+
// Insert snippet below current line
106+
const insertPosition = new vscode.Position(position.line + 1, 0);
107+
await editor.insertSnippet(
108+
new vscode.SnippetString(snippetLines.join('\n')),
109+
insertPosition
110+
);
111+
112+
services.logger.info("Add Materializer completed successfully");
113+
} catch (err) {
114+
handleError(err);
115+
}
92116
}

‎src/commands/goToDefinition.ts‎

Lines changed: 78 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
1+
/**
2+
* Copyright IBM Corp. 2025
3+
* Assisted by CursorAI
4+
*/
5+
16
import * as vscode from "vscode";
27
import { findDefinition } from "../utils/stepzenProjectScanner";
38
import { services } from "../services";
9+
import { handleError } from "../errors";
410

511
/**
612
* Implements Go to Definition functionality for GraphQL symbols
@@ -10,68 +16,82 @@ import { services } from "../services";
1016
* @returns Promise that resolves when navigation is complete or cancelled
1117
*/
1218
export async function goToDefinition() {
13-
const editor = vscode.window.activeTextEditor;
14-
if (!editor) {
15-
vscode.window.showWarningMessage("No active editor.");
16-
return;
17-
}
19+
try {
20+
services.logger.info("Starting Go to Definition command");
21+
22+
const editor = vscode.window.activeTextEditor;
23+
if (!editor) {
24+
vscode.window.showWarningMessage("No active editor.");
25+
services.logger.warn("Go to Definition failed: No active editor");
26+
return;
27+
}
1828

19-
const document = editor.document;
20-
const position = editor.selection.active;
21-
const wordRange = document.getWordRangeAtPosition(position);
22-
if (!wordRange) {
23-
vscode.window.showWarningMessage("No symbol selected.");
24-
return;
25-
}
29+
const document = editor.document;
30+
const position = editor.selection.active;
31+
const wordRange = document.getWordRangeAtPosition(position);
32+
if (!wordRange) {
33+
vscode.window.showWarningMessage("No symbol selected.");
34+
services.logger.warn("Go to Definition failed: No symbol selected");
35+
return;
36+
}
2637

27-
const token = document.getText(wordRange);
28-
const locations = findDefinition(token);
29-
if (!locations || locations.length === 0) {
30-
vscode.window.showWarningMessage(`No definition found for "${token}".`);
31-
services.logger.warn(`No definition found for "${token}".`);
32-
return;
33-
}
38+
const token = document.getText(wordRange);
39+
services.logger.info(`Searching for definition of symbol: "${token}"`);
40+
41+
const locations = findDefinition(token);
42+
if (!locations || locations.length === 0) {
43+
vscode.window.showWarningMessage(`No definition found for "${token}".`);
44+
services.logger.warn(`No definition found for "${token}".`);
45+
return;
46+
}
3447

35-
// Single location found - jump directly to it
36-
if (locations.length === 1) {
37-
const loc = locations[0];
38-
services.logger.info(`Found "${token}" in ${loc.filePath}.`);
39-
const uri = vscode.Uri.file(loc.filePath);
40-
const pos = new vscode.Position(loc.line, loc.character);
41-
const doc = await vscode.workspace.openTextDocument(uri);
42-
await vscode.window.showTextDocument(doc, {
43-
selection: new vscode.Range(pos, pos),
44-
});
45-
return;
46-
}
48+
// Single location found - jump directly to it
49+
if (locations.length === 1) {
50+
const loc = locations[0];
51+
services.logger.info(`Found "${token}" in ${loc.filePath}.`);
52+
const uri = vscode.Uri.file(loc.filePath);
53+
const pos = new vscode.Position(loc.line, loc.character);
54+
const doc = await vscode.workspace.openTextDocument(uri);
55+
await vscode.window.showTextDocument(doc, {
56+
selection: new vscode.Range(pos, pos),
57+
});
58+
services.logger.info("Go to Definition completed successfully");
59+
return;
60+
}
4761

48-
// Multiple locations found - offer a quick-pick list for user selection
49-
// Log message for debugging
50-
services.logger.info(
51-
`Multiple definitions for "${token}" found. Prompting user to select one.`,
52-
);
53-
const pick = await vscode.window.showQuickPick(
54-
locations.map((loc) => {
55-
const rel = vscode.workspace.asRelativePath(loc.filePath);
56-
const container = loc.container ?? "<type>"; // null for type-level symbols
57-
return {
58-
label: `${container} — ${rel}`,
59-
description: `line ${loc.line + 1}`,
60-
loc,
61-
} as const;
62-
}),
63-
{
64-
placeHolder: `Multiple definitions for "${token}" found…`,
65-
},
66-
);
62+
// Multiple locations found - offer a quick-pick list for user selection
63+
// Log message for debugging
64+
services.logger.info(
65+
`Multiple definitions for "${token}" found. Prompting user to select one.`,
66+
);
67+
const pick = await vscode.window.showQuickPick(
68+
locations.map((loc) => {
69+
const rel = vscode.workspace.asRelativePath(loc.filePath);
70+
const container = loc.container ?? "<type>"; // null for type-level symbols
71+
return {
72+
label: `${container} — ${rel}`,
73+
description: `line ${loc.line + 1}`,
74+
loc,
75+
} as const;
76+
}),
77+
{
78+
placeHolder: `Multiple definitions for "${token}" found…`,
79+
},
80+
);
6781

68-
if (pick) {
69-
const loc = pick.loc as (typeof locations)[number];
70-
const uri = vscode.Uri.file(loc.filePath);
71-
const pos = new vscode.Position(loc.line, loc.character);
72-
const doc = await vscode.workspace.openTextDocument(uri);
73-
await vscode.window.showTextDocument(doc, {
74-
selection: new vscode.Range(pos, pos),
75-
});
82+
if (pick) {
83+
const loc = pick.loc as (typeof locations)[number];
84+
const uri = vscode.Uri.file(loc.filePath);
85+
const pos = new vscode.Position(loc.line, loc.character);
86+
const doc = await vscode.workspace.openTextDocument(uri);
87+
await vscode.window.showTextDocument(doc, {
88+
selection: new vscode.Range(pos, pos),
89+
});
90+
services.logger.info("Go to Definition completed successfully");
91+
} else {
92+
services.logger.info("Go to Definition cancelled by user");
93+
}
94+
} catch (err) {
95+
handleError(err);
7696
}
7797
}

0 commit comments

Comments
 (0)