Skip to content
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

Detect unused symbols #150

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Detect unused symbols #150

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
530c6b0
add unused variables detection support
mkslanc Jan 10, 2025
a9d22a4
Merge branch 'main' into unused-detection
mkslanc Jan 13, 2025
343592c
add option to show unused declaration
mkslanc Jan 15, 2025
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
28 changes: 14 additions & 14 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions packages/ace-linters/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@
"vscode-html-languageservice": "^5.0.6",
"vscode-css-languageservice": "^6.2.6",
"vscode-json-languageservice": "^5.4.1",
"vscode-languageserver-protocol": "^3.17.3",
"vscode-languageserver-textdocument": "^1.0.8",
"vscode-languageserver-types": "^3.17.3",
"vscode-languageserver-protocol": "^3.17.5",
"vscode-languageserver-textdocument": "^1.0.12",
"vscode-languageserver-types": "^3.17.5",
"showdown": "latest",
"luaparse": "latest",
"vscode-ws-jsonrpc": "^2.0.1",
Expand Down
107 changes: 77 additions & 30 deletions packages/ace-linters/src/language-provider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ import {MarkerGroup} from "./ace/marker_group";
import {AceRange} from "./ace/range-singleton";
import {HoverTooltip} from "./ace/hover-tooltip";
import {
DecodedSemanticTokens,
mergeTokens,
DecodedSemanticTokens, DecodedToken,
mergeTokens, OriginalSemanticTokens,
parseSemanticTokens
} from "./type-converters/lsp/semantic-tokens";
import {LightbulbWidget} from "./components/lightbulb";
Expand Down Expand Up @@ -120,7 +120,8 @@ export class LanguageProvider {
documentHighlights: true,
signatureHelp: true,
semanticTokens: false, //experimental functionality
codeActions: true
codeActions: true,
showUnusedDeclarations: true
};

this.options = options ?? {};
Expand Down Expand Up @@ -539,6 +540,9 @@ class SessionLanguageProvider {
private semanticTokensLegend?: lsp.SemanticTokensLegend;
private $provider: LanguageProvider;

private $predefinedTokens: DecodedToken[] = [];
private $firstStaleLine: undefined | number;

/**
* Constructs a new instance of the `SessionLanguageProvider` class.
*
Expand Down Expand Up @@ -605,6 +609,8 @@ class SessionLanguageProvider {
addSemanticTokenSupport(session: Ace.EditSession) {
let bgTokenizer = session.bgTokenizer;
session.setSemanticTokens = (tokens: DecodedSemanticTokens | undefined) => {
bgTokenizer.currentLine = 0;
bgTokenizer.lines = [];
bgTokenizer.semanticTokens = tokens;
}

Expand All @@ -624,7 +630,7 @@ class SessionLanguageProvider {

if (bgTokenizer.semanticTokens) {
let decodedTokens = bgTokenizer.semanticTokens.getByRow(row);
if (decodedTokens) {
if (decodedTokens && decodedTokens.length > 0) {
data.tokens = mergeTokens(data.tokens, decodedTokens);
}
}
Expand Down Expand Up @@ -723,7 +729,7 @@ class SessionLanguageProvider {
}
}

private $changeListener = (delta) => {
private $changeListener = (delta: Ace.Delta) => {
this.session.doc.version++;
if (!this.$deltaQueue) {
this.$deltaQueue = [];
Expand All @@ -748,15 +754,44 @@ class SessionLanguageProvider {
return;
}

let annotations = toAnnotations(diagnostics);
const filteredDiagnostics = diagnostics.filter((el) => !el?.data?.ignore);

let annotations = toAnnotations(filteredDiagnostics);
this.session.clearAnnotations();
if (annotations && annotations.length > 0) {
this.session.setAnnotations(annotations);
}
if (!this.state.diagnosticMarkers) {
this.state.diagnosticMarkers = new MarkerGroup(this.session);
}
this.state.diagnosticMarkers.setMarkers(diagnostics?.map((el) => toMarkerGroupItem(CommonConverter.toRange(toRange(el.range)), "language_highlight_error", el.message)));

if (this.$provider.options.functionality!.showUnusedDeclarations) {
this.setPredefinedTokens(diagnostics);
}

this.state.diagnosticMarkers.setMarkers(diagnostics?.map((el) => toMarkerGroupItem(CommonConverter.toRange(toRange(el.range)), el?.data?.ignore ? "" : "language_highlight_error", el.message)));
}

setPredefinedTokens(diagnostics: lsp.Diagnostic[]) {
this.$predefinedTokens = [];

diagnostics.forEach((el) => {
if (el.tags && el.tags.length > 0) {
if (!this.$firstStaleLine || el.range.start.line < this.$firstStaleLine) {
this.$firstStaleLine = el.range.start.line;
}
this.$predefinedTokens.push({
row: el.range.start.line,
startColumn: el.range.start.character,
length: el.range.end.character - el.range.start.character,
type: el.tags[0] === lsp.DiagnosticTag.Deprecated ? "highlight_deprecated" : "highlight_unnecessary"
});
}
});

if (!this.$provider.options.functionality!.semanticTokens) {
this.$applySemanticTokens(undefined);
}
}

setOptions<OptionsType extends ServiceOptions>(options: OptionsType) {
Expand Down Expand Up @@ -801,9 +836,11 @@ class SessionLanguageProvider {
}

getSemanticTokens() {
if (!this.$provider.options.functionality!.semanticTokens)
const showSemanticTokens = this.$provider.options.functionality!.semanticTokens;
const showUnusedDeclarations = this.$provider.options.functionality!.showUnusedDeclarations;
if (!showSemanticTokens && !showUnusedDeclarations)
return;
//TODO: improve this
//TODO: improve this
let lastRow = this.editor.renderer.getLastVisibleRow();
let visibleRange: AceRangeData = {
start: {
Expand All @@ -815,29 +852,39 @@ class SessionLanguageProvider {
column: this.session.getLine(lastRow).length
}
}
if (showSemanticTokens) {
this.$messageController.getSemanticTokens(this.comboDocumentIdentifier, fromRange(visibleRange), this.$applySemanticTokens);
} else {
this.$applySemanticTokens(undefined);
}
}

this.$messageController.getSemanticTokens(this.comboDocumentIdentifier, fromRange(visibleRange), (tokens) => {
if (!tokens) {
return;
}
let decodedTokens = parseSemanticTokens(tokens.data, this.semanticTokensLegend!.tokenTypes, this.semanticTokensLegend!.tokenModifiers);
this.session.setSemanticTokens(decodedTokens);
let bgTokenizer = this.session.bgTokenizer;

//@ts-ignore
bgTokenizer.running = setTimeout(() => {
if (bgTokenizer?.semanticTokens?.tokens && bgTokenizer?.semanticTokens?.tokens.length > 0) {
let startRow: number = bgTokenizer?.semanticTokens?.tokens[0].row;
bgTokenizer.currentLine = startRow;
bgTokenizer.lines = bgTokenizer.lines.slice(0, startRow - 1);
} else {
bgTokenizer.currentLine = 0;
bgTokenizer.lines = [];
}
bgTokenizer.$worker();
}, 20);
$applySemanticTokens = (tokens: lsp.SemanticTokens | null | undefined) => {
if (!tokens && this.$predefinedTokens.length == 0) {
this.session.setSemanticTokens(undefined);
this.$runTokenizer();
return;
}
let originalTokens: OriginalSemanticTokens | undefined;
if (tokens) {
originalTokens = {
tokens: tokens.data,
tokenTypes: this.semanticTokensLegend!.tokenTypes,
tokenModifiersLegend: this.semanticTokensLegend!.tokenModifiers
}
);
}
let decodedTokens = parseSemanticTokens(originalTokens, this.$predefinedTokens);

this.session.setSemanticTokens(decodedTokens);
this.$runTokenizer();
}

$runTokenizer() {
let bgTokenizer = this.session.bgTokenizer;
//@ts-ignore
bgTokenizer.running = setTimeout(() => {
bgTokenizer.$worker();
}, 20);
}

$applyDocumentHighlight = (documentHighlights: lsp.DocumentHighlight[]) => {
Expand Down
8 changes: 7 additions & 1 deletion packages/ace-linters/src/misc/styles.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,13 @@ export function setStyles(editor) {

.language_highlight_write {
border: solid 1px #F88;
}`, "linters.css");
}

.ace_highlight_unnecessary {
opacity: 0.5;
}

`, "linters.css");

editor.renderer["$textLayer"].dom.importCssString(`
.ace_editor.ace_autocomplete .ace_marker-layer .ace_active-line {
Expand Down
39 changes: 37 additions & 2 deletions packages/ace-linters/src/services/typescript/typescript-converters.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,52 @@ import convertKind = CommonConverter.convertKind;
import {FilterDiagnosticsOptions} from "../../types/language-service";
import {filterDiagnostics} from "../../type-converters/lsp/lsp-converters";

export function fromTsDiagnostics(diagnostics: Diagnostic[], doc: TextDocument, filterErrors: FilterDiagnosticsOptions): lsp.Diagnostic[] {
export const compilerOptionToErrorCodes: Record<string, Set<number>> = {
noUnusedLocals: new Set([
6196, // Variable 'X' is declared but never used.
6133, // 'X' is declared but its value is never read.
6192, // Class 'X' is declared but its value is never read.
6138, // Property 'X' is declared but never used.
6200, // Namespace 'X' is declared but its value is never read.
]),
noUnusedParameters: new Set([
6134, // Parameter 'X' is declared but its value is never read.
]),
};

export function fromTsDiagnostics(diagnostics: Diagnostic[], doc: TextDocument, filterErrors: FilterDiagnosticsOptions, compilerOptions?: ts.CompilerOptions | ts.CompilerOptionsWithoutEnums): lsp.Diagnostic[] {
const lspDiagnostics = diagnostics.filter((el) => !filterErrors.errorCodesToIgnore!.includes(el.code.toString())).map((el) => {
const tags: lsp.DiagnosticTag[] = [];
let ignore = false;
if (el.reportsUnnecessary) {
tags.push(lsp.DiagnosticTag.Unnecessary);
ignore = true;
}
if (el.reportsDeprecated) {
tags.push(lsp.DiagnosticTag.Deprecated);
}

let start = el.start ?? 0;
let length = el.length ?? 1; //TODO:
if (filterErrors.errorCodesToTreatAsWarning!.includes(el.code.toString())) {
el.category = DiagnosticCategory.Warning;
} else if (filterErrors.errorCodesToTreatAsInfo!.includes(el.code.toString())) {
el.category = DiagnosticCategory.Message;
}
return lsp.Diagnostic.create(lsp.Range.create(doc.positionAt(start), doc.positionAt(start + length)),
let diagnostic = lsp.Diagnostic.create(lsp.Range.create(doc.positionAt(start), doc.positionAt(start + length)),
parseMessageText(el.messageText, el.code), fromTsCategory(el.category), el.code);
diagnostic.tags = tags;
if (compilerOptions) {
if (compilerOptions.noUnusedLocals && compilerOptionToErrorCodes["noUnusedLocals"].has(el.code)) {
ignore = false;
} else if (compilerOptions.noUnusedParameters && compilerOptionToErrorCodes["noUnusedParameters"].has(el.code)) {
ignore = false;
}
}
if (ignore) {
diagnostic.data = {ignore: true};
}
return diagnostic;
});
return filterDiagnostics(lspDiagnostics, filterErrors);
}
Expand Down
4 changes: 3 additions & 1 deletion packages/ace-linters/src/services/typescript/typescript-service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,9 @@ export class TypescriptService extends BaseService<TsServiceOptions> implements
module: 99,
moduleResolution: 99,
allowSyntheticDefaultImports: true,
moduleDetection: 3
moduleDetection: 3,
noUnusedLocals: true,
noUnusedParameters: true
};

$defaultFormatOptions = {
Expand Down
Loading