Skip to content

Add a "Quick Fix" option to quickly ignore slither warnings. #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add a "Quick Fix" option to quickly ignore slither warnings. #22

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
38 changes: 37 additions & 1 deletion src/slitherDiagnostics.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,41 @@ export class SlitherDiagnosticProvider implements vscode.CodeActionProvider {
// Initialize our file->result map to pair workspace results with diagnostics.
this.fileDiagnosticMap = new Map<string, vscode.Diagnostic[]>();
this.fileResultMap = new Map<string, slitherResults.SlitherResult[]>();
this.provideCodeActions = (document, range, context, token) => {
const ignoreActions: vscode.CodeAction[] = [];

for (const diagnostic of context.diagnostics) {
const diagnosticCode = diagnostic.code;
// Ignore non-slither diagnostics
if (
typeof diagnosticCode !== "string" ||
!diagnosticCode.startsWith("slither.")
) {
continue;
}

// Ignore diagnostics for code actions that don't match the provided range
if (!diagnostic.range.isEqual(range)) {
continue;
}

const ignoreWarning = new vscode.CodeAction(
`Ignore ${diagnosticCode}`,
vscode.CodeActionKind.QuickFix
);
const workspaceEdit = new vscode.WorkspaceEdit();
// Add slither-specific ignore syntax
const ignoreText = `//slither-disable-next-line ${diagnosticCode.substring(
8
)} \n${" ".repeat(range.start.character)}`;
workspaceEdit.insert(document.uri, range.start, ignoreText);
ignoreWarning.edit = workspaceEdit;
ignoreActions.push(ignoreWarning);

}

return ignoreActions;
};
}

public async refreshDiagnostics() {
Expand Down Expand Up @@ -70,7 +105,8 @@ export class SlitherDiagnosticProvider implements vscode.CodeActionProvider {

// Create a diagnostic
let diagnosticResult : vscode.Diagnostic = new vscode.Diagnostic(resultRange, workspaceResult.description.replace(/^\s+|\s+$/g, ''), diagnosticSeverity);

// Label the diagnostic with slither and the detector name
diagnosticResult.code = `slither.${workspaceResult.check}`
// Obtain the absolute file path
let filename_absolute = path.join(workspaceFolder, workspaceResultElement.source_mapping.filename_relative);
let filename_uri = vscode.Uri.file(filename_absolute);
Expand Down