Archive/opengoal-vscode
1
0
Fork 0
mirror of https://github.com/open-goal/opengoal-vscode.git synced 2024-10-19 20:47:37 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

decomp: auto-gen docstring with a best effort attempt to determine param type (#335)

Browse source
This commit is contained in:
Tyler Wilding 2024-01-26 00:55:47 -05:00 committed by GitHub
parent 4cc9e61c33
commit 40a94c4e2e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 26 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
src/languages/ir2/ir2-completions.ts
View file

@ -1,5 +1,6 @@
import * as vscode from "vscode";
import { getArgumentsInSignature } from "../opengoal/opengoal-tools";
import { getFuncBodyFromPosition } from "./ir2-utils";
export class IRCompletionItemProvider implements vscode.CompletionItemProvider {
provideCompletionItems(
@ -32,9 +33,33 @@ export class IRCompletionItemProvider implements vscode.CompletionItemProvider {
position.character,
);
const funcBody = getFuncBodyFromPosition(document, position);
if (funcBody === undefined) {
return [];
}
let docstring = `"something\n`;
for (const arg of args) {
docstring += ` @param ${arg.name} something\n`;
// Determine the nature of the parameter
// _ - unused (if it doesn't show up AT ALL)
// ! - mutated (if it's involved in a set)
// ? - optional (can't easily determine this and is frankly rare)
let paramFound = false;
for (let i = 1; i < funcBody.length; i++) {
const line = funcBody[i];
if (line.includes(`(set! (-> ${arg.name}`)) {
docstring += ` @param! ${arg.name} something\n`;
paramFound = true;
break;
} else if (line.includes(arg.name)) {
paramFound = true;
}
}
if (paramFound) {
docstring += ` @param ${arg.name} something\n`;
} else {
docstring += ` @param_ ${arg.name} something\n`;
}
}
docstring += ` @returns something"`;