Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions client/src/commands.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,13 @@ export function registerCommands(context: ExtensionContext, client: LanguageClie
}),

commands.registerCommand(`vscode-clle.viewFullDocumentation`, async (object: string, library: string) => {
const isDocOpened = await GenCmdDoc.openClDoc(object, library);
if (!isDocOpened) {
await window.showErrorMessage(`Documentation for ${object} command not found`);
try {
const isDocOpened = await GenCmdDoc.openClDoc(object, library);
if (!isDocOpened) {
await window.showErrorMessage(`Documentation for ${object} command not found`);
}
} catch (error) {
await window.showErrorMessage(`Failed to open documentation for ${object}/${library}`);
}
})
)
Expand Down
7 changes: 5 additions & 2 deletions client/src/extension.ts
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,11 @@ export function activate(context: ExtensionContext): CLLE {
if (displayCommandDocumentation) {
try {
return await GenCmdDoc.getCLDoc(qualifiedObject[0], qualifiedObject[1]);
} catch (e) {
console.log(e);
} catch (error) {
const errorMessage = error instanceof Error ? error.message : String(error);

// Return error object so caller knows what went wrong
return { error: errorMessage };
}
}
});
Expand Down
3 changes: 3 additions & 0 deletions client/src/gencmddoc.ts
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,9 @@ export class GenCmdDoc {
if (generateResult.code === 0) {
const html = (await content.downloadStreamfileRaw(`${toDir}/${toStmf}`)).toString();
return html;
} else {
// Throw stdout from the result when command fails
throw new Error(generateResult.stdout || `GENCMDDOC command failed with code ${generateResult.code}`);
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion server/src/data.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ export async function getFileSpec(object: string, library = '*LIBL', openId?: st
return (spec ? Files.getVariables(spec, openId) : undefined);
}

export async function getCLDocSpec(object: string, library = '*LIBL'): Promise<{ html: string, doc: CLDoc } | undefined> {
export async function getCLDocSpec(object: string, library = '*LIBL'): Promise<{ html: string, doc: CLDoc } | { error: string } | undefined> {
const validObject = object.toUpperCase();
const validLibrary = (library || `*LIBL`).toUpperCase();
return await getCLDoc(validObject, validLibrary);
Expand Down
2 changes: 1 addition & 1 deletion server/src/instance.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,6 @@ export function getFileDefinition(object: string, library?: string): Promise<Fil
return connection.sendRequest("getFileDefinition", [object, library]);
}

export function getCLDoc(object: string, library?: string): Promise<{ html: string, doc: CLDoc } | undefined> {
export function getCLDoc(object: string, library?: string): Promise<{ html: string, doc: CLDoc } | { error: string } | undefined> {
return connection.sendRequest("getCLDoc", [object, library]);
}
21 changes: 11 additions & 10 deletions server/src/providers/completion.ts
Original file line number Diff line number Diff line change
Expand Up @@ -150,17 +150,18 @@ export async function completionResolveProvider(item: CompletionItem): Promise<C

if (data && data.commandName && data.name) {
const clDoc = await getCLDocSpec(data.commandName, data.commandLibrary);

if (clDoc) {
const parameterDoc = clDoc.doc.parameters.details.find(p => p.name === data.name);
if (parameterDoc && parameterDoc.description) {
// Remove the heading pattern: ### Parameter\n\n
const description = parameterDoc.description.replace(/^###[^\n]*\n\n/, '');

item.documentation = {
kind: MarkupKind.Markdown,
value: description
};
if (!('error' in clDoc)) {
const parameterDoc = clDoc.doc.parameters.details.find(p => p.name === data.name);
if (parameterDoc && parameterDoc.description) {
// Remove the heading pattern: ### Parameter\n\n
const description = parameterDoc.description.replace(/^###[^\n]*\n\n/, '');

item.documentation = {
kind: MarkupKind.Markdown,
value: description
};
}
}
}
}
Expand Down
4 changes: 4 additions & 0 deletions server/src/providers/hover.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ export default async function hoverProvider(params: HoverParams): Promise<Hover
if (!clDoc) {
return;
}

if ('error' in clDoc) {
return;
}

// Parms in the existing statement
const currentParms = statement.getParms();
Expand Down
Loading