Skip to content

Only build the shadowed-variable range when reporting it #1867

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

Merged
TwitchBronBron merged 4 commits into from
Oct 15, 2026
Merged

Only build the shadowed-variable range when reporting it #1867

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1bc8798
Only build the shadowed-variable range when reporting it
TwitchBronBron Oct 2, 2026
4759367
Merge branch 'flatten-locations' into lazy-shadow-name-range
TwitchBronBron Oct 2, 2026
fc6d3c1
Merge remote-tracking branch 'origin/flatten-locations' into lazy-sha…
TwitchBronBron Oct 15, 2026
2df8d1f
Merge remote-tracking branch 'origin/flatten-locations' into lazy-sha…
TwitchBronBron Oct 15, 2026
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
23 changes: 13 additions & 10 deletions src/bscPlugin/validation/ScopeValidator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import * as path from 'path';
import { DiagnosticTag, type Range } from 'vscode-languageserver';
import { DiagnosticTag } from 'vscode-languageserver';
import { isAALiteralExpression, isAliasStatement, isArrayLiteralExpression, isArrayType, isArrayTypeLike, isAssignmentStatement, isAssociativeArrayType, isAssociativeArrayTypeLike, isBinaryExpression, isBooleanTypeLike, isBrsFile, isBuiltInType, isCallableType, isCallExpression, isCallFuncableTypeLike, isCallfuncExpression, isClassStatement, isClassType, isComponentType, isCompoundType, isDottedGetExpression, isDynamicType, isEnumMemberStatement, isEnumMemberType, isEnumType, isFunctionExpression, isFunctionParameterExpression, isInterfaceType, isIterableType, isLiteralExpression, isLiteralString, isNamespaceStatement, isNamespaceType, isNewExpression, isNumberTypeLike, isObjectType, isPrimitiveType, isReferenceType, isReturnStatement, isStringTypeLike, isTypedFunctionType, isTypeStatementType, isUnaryExpression, isUnionType, isVariableExpression, isVoidType, isXmlScope } from '../../astUtils/reflection';
import type { DiagnosticInfo } from '../../DiagnosticMessages';
import { DiagnosticMessages } from '../../DiagnosticMessages';
Expand All @@ -10,7 +10,7 @@ import type { AssignmentStatement, AugmentedAssignmentStatement, ClassStatement,
import { util } from '../../util';
import { nodes, components } from '../../roku-types';
import type { BRSComponentData } from '../../roku-types';
import type { Token } from '../../lexer/Token';
import type { Locatable, Token } from '../../lexer/Token';
import { AstNodeKind } from '../../parser/AstNode';
import type { AstNode } from '../../parser/AstNode';
import type { Expression } from '../../parser/AstNode';
Expand Down Expand Up @@ -251,7 +251,7 @@ export class ScopeValidator {
expr: assignStmt,
name: assignStmt.tokens.name.text,
type: this.getNodeTypeWrapper(file, assignStmt, { flags: SymbolTypeFlag.runtime }),
nameRange: util.getLocation(assignStmt.tokens.name)?.range
nameToken: assignStmt.tokens.name
});
});
},
Expand All @@ -276,7 +276,7 @@ export class ScopeValidator {
expr: forEachStmt,
name: forEachStmt.tokens.item.text,
type: this.getNodeTypeWrapper(file, forEachStmt, { flags: SymbolTypeFlag.runtime }),
nameRange: util.getLocation(forEachStmt.tokens.item)?.range
nameToken: forEachStmt.tokens.item
});
this.validateForEachStatement(file, forEachStmt);
});
Expand All @@ -287,7 +287,7 @@ export class ScopeValidator {
expr: funcParam,
name: funcParam.tokens.name.text,
type: this.getNodeTypeWrapper(file, funcParam, { flags: SymbolTypeFlag.runtime }),
nameRange: util.getLocation(funcParam.tokens.name)?.range
nameToken: funcParam.tokens.name
});
});
},
Expand Down Expand Up @@ -1635,7 +1635,10 @@ export class ScopeValidator {
}
}

public detectShadowedLocalVar(file: BrsFile, varDeclaration: { expr: AstNode; name: string; type: BscType; nameRange: Range }) {
/**
* Detect a local variable that shadows a function or class. `varDeclaration.nameToken` is only resolved into a range when a diagnostic is actually added
*/
public detectShadowedLocalVar(file: BrsFile, varDeclaration: { expr: AstNode; name: string; type: BscType; nameToken: Locatable }) {
const varName = varDeclaration.name;
const lowerVarName = varName.toLowerCase();
const callableContainerMap = this.event.scope.getCallableContainerMap();
Expand All @@ -1654,7 +1657,7 @@ export class ScopeValidator {
if (varIsFunction()) {
this.addMultiScopeDiagnostic({
...DiagnosticMessages.localVarFunctionShadowsParentFunction('stdlib'),
location: util.createLocationFromFileRange(file, varDeclaration.nameRange)
location: util.createLocationFromFileRange(file, util.getLocation(varDeclaration.nameToken)?.range)
});
}
} else if (callableContainerMap.has(lowerVarName) && !localVarIsInNamespace) {
Expand All @@ -1663,7 +1666,7 @@ export class ScopeValidator {
if (varIsFunction()) {
this.addMultiScopeDiagnostic({
...DiagnosticMessages.localVarFunctionShadowsParentFunction('scope'),
location: util.createLocationFromFileRange(file, varDeclaration.nameRange),
location: util.createLocationFromFileRange(file, util.getLocation(varDeclaration.nameToken)?.range),
relatedInformation: [{
message: 'Function declared here',
location: util.createLocationFromFileRange(
Expand All @@ -1675,7 +1678,7 @@ export class ScopeValidator {
} else {
this.addMultiScopeDiagnostic({
...DiagnosticMessages.localVarShadowedByScopedFunction(),
location: util.createLocationFromFileRange(file, varDeclaration.nameRange),
location: util.createLocationFromFileRange(file, util.getLocation(varDeclaration.nameToken)?.range),
relatedInformation: [{
message: 'Function declared here',
location: util.createLocationFromRange(
Expand All @@ -1692,7 +1695,7 @@ export class ScopeValidator {
if (classStmtLink && classStmtLink.item.isActive !== false) {
this.addMultiScopeDiagnostic({
...DiagnosticMessages.localVarShadowedByScopedFunction(),
location: util.createLocationFromFileRange(file, varDeclaration.nameRange),
location: util.createLocationFromFileRange(file, util.getLocation(varDeclaration.nameToken)?.range),
relatedInformation: [{
message: 'Class declared here',
location: util.createLocationFromRange(
Expand Down
Loading