refactor: migrate avoid_using_api by solid-illiaaihistov · Pull Request #304 · solid-software/solid_lints

solid-illiaaihistov · 2026-06-30T16:18:37Z

Closes #249

gemini-code-assist

Code Review

This pull request refactors the avoid_using_api lint rule to utilize the analyzer-based RuleContext and RuleVisitorRegistry instead of custom_lint APIs. It replaces AvoidUsingApiLinter with AvoidUsingApiVisitor (extending SimpleAstVisitor), introduces several AST node helper extensions in node_utils.dart, refactors path matching in path_utils.dart, and replaces old integration tests with a comprehensive unit test suite. The review feedback suggests making the rootPath parameter in _getActiveEntries nullable to align with shouldSkipFile and passing context.package?.root.path directly instead of coalescing it to an empty string.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

…sitor

solid-illiaaihistov · 2026-07-01T10:37:40Z

I found a bug related to the use of severity in this rule, and I'm working on a fix.

… multiple lint codes

…o 249-migrate-avoid_using_api

solid-danylosafonov · 2026-07-01T11:46:47Z

+        if (actualClassName != className) {
+          return;
+        }
+
+        if (node.constructorName.name?.name != expectedConstructorName) {
+          return;
+        }
+
+        if (!node.argumentList.containsNamed(namedParameter)) {
+          return;
+        }
+
+        if (matchesSource(
+          node.constructorName.type.element?.libraryUri,
+          source,
+        )) {


Suggested change

if (actualClassName != className) {

return;

}

if (node.constructorName.name?.name != expectedConstructorName) {

return;

}

if (!node.argumentList.containsNamed(namedParameter)) {

return;

}

if (matchesSource(

node.constructorName.type.element?.libraryUri,

source,

)) {

if (actualClassName == className &&

node.constructorName.name?.name == expectedConstructorName &&

node.argumentList.containsNamed(namedParameter) &&

matchesSource(

node.constructorName.type.element?.libraryUri,

source,

)) {

solid-danylosafonov · 2026-07-01T12:01:43Z

There are probably more similar refactors possible in this file that I missed

Thank you! I implemented similar improvements in other parts of this class as well.

…ethods

…ingApiVisitor to improve readability and structure

solid-danylosafonov · 2026-07-06T13:02:28Z

+    }
+  }
+
+  bool _isMemberOrClass(Element? element, String className, String source) {


seems like it can be extracted to util?

solid-danylosafonov · 2026-07-06T13:10:44Z

+      return;
+    }
+
+    reporter.atNode(node, _getLintCode(entry));


This is repeated 8 times, why don't we wrap reporter into a function when we return it from _resolveContext so it looks more like:

Suggested change

reporter.atNode(node, _getLintCode(entry));

report(node);

…ied traversal method and moving member checks to extensions

solid-danylosafonov

Also, it kinda starts looking like we could extract _checkX methods to be polymorphic extensions on node types so e.g. instead of _checkIdFromSource(node, entry), we'd have node.checkIdFromSource(entry). But I also think that checkX might not be the best name here

solid-danylosafonov · 2026-07-07T14:27:53Z

+    final resolved = _resolveContext();
+    if (resolved == null) return;
+    final (:activeEntries, :reporter) = resolved;


Probably can inline it now

Suggested change

final resolved = _resolveContext();

if (resolved == null) return;

final (:activeEntries, :reporter) = resolved;

final currentUnit = context.currentUnit;

if (currentUnit == null) return;

final activeEntries = _cachedActiveEntries ??= _getActiveEntries(

currentUnit.file.path,

context.package?.root.path,

);

final reporter = currentUnit.diagnosticReporter;

solid-danylosafonov · 2026-07-07T14:32:02Z

+      visitEntry(node, entry, (target) {
+        if (target is AstNode) {
+          reporter.atNode(target, _getLintCode(entry));
+        } else if (target is Token) {
+          reporter.atToken(target, _getLintCode(entry));
+        }
+      });


I feel like we can inline _getLintCode here

Suggested change

visitEntry(node, entry, (target) {

if (target is AstNode) {

reporter.atNode(target, _getLintCode(entry));

} else if (target is Token) {

reporter.atToken(target, _getLintCode(entry));

}

});

visitEntry(node, entry, (target) {

final severity =

entry.severity ?? parameters.severity ?? DiagnosticSeverity.INFO;

final code = LintCode(

AvoidUsingApiRule.lintName,

entry.reason ?? AvoidUsingApiRule.defaultMessage,

severity: severity,

uniqueName: AvoidUsingApiRule.getUniqueName(severity),

);

visitEntry(

node,

entry,

(target) => switch (target) {

AstNode() => reporter.atNode(target, code),

Token() => reporter.atToken(target, code),

_ => (),

},

);

});

solid-danylosafonov · 2026-07-07T14:47:07Z

+    void Function(
+      T,
+      AvoidUsingApiEntryParameters,
+      void Function(SyntacticEntity),


We actually can avoid passing it in alltogether

Suggested change

void Function(SyntacticEntity),

void _visit<T>( T node, void Function(T) visitSuper, SyntacticEntity? Function( T, AvoidUsingApiEntryParameters, ) visitEntry, ) { visitSuper(node); final currentUnit = context.currentUnit; if (currentUnit == null) return; final activeEntries = _cachedActiveEntries ??= _getActiveEntries( currentUnit.file.path, context.package?.root.path, ); final reporter = currentUnit.diagnosticReporter; for (final entry in activeEntries) { final severity = entry.severity ?? parameters.severity ?? DiagnosticSeverity.INFO; final code = LintCode( AvoidUsingApiRule.lintName, entry.reason ?? AvoidUsingApiRule.defaultMessage, severity: severity, uniqueName: AvoidUsingApiRule.getUniqueName(severity), ); final target = visitEntry(node, entry); (() => switch (target) { AstNode() => reporter.atNode(target, code), Token() => reporter.atToken(target, code), _ => (), })(); } }

solid-danylosafonov · 2026-07-07T14:47:34Z

+    final source = entry.source;
+    if (source == null) return;
+
+    final className = entry.className;
+    final identifier = entry.identifier;
+    final namedParameter = entry.namedParameter;


Suggested change

final source = entry.source;

if (source == null) return;

final className = entry.className;

final identifier = entry.identifier;

final namedParameter = entry.namedParameter;

final AvoidUsingApiEntryParameters(

:className,

:identifier,

:namedParameter,

:source,

) = entry;

if (source == null) return null;

solid-danylosafonov · 2026-07-07T14:48:50Z

+    final identifier = entry.identifier;
+    final namedParameter = entry.namedParameter;
+
+    switch ((className, identifier, namedParameter)) {


Looks like we can short circuit here

Suggested change

switch ((className, identifier, namedParameter)) {

if (className == null) return;

switch ((identifier, namedParameter)) {

…xtension methods

…meters access in node extensions

solid-danylosafonov

lgtm

…o 249-migrate-avoid_using_api

refactor: migrate avoid_using_api

3165380

solid-illiaaihistov linked an issue Jun 30, 2026 that may be closed by this pull request

Migrate avoid_using_api #249

Closed

gemini-code-assist Bot reviewed Jun 30, 2026

View reviewed changes

Comment thread lib/src/lints/avoid_using_api/visitors/avoid_using_api_visitor.dart

Comment thread lib/src/lints/avoid_using_api/visitors/avoid_using_api_visitor.dart Outdated

refactor: update rootPath parameter to nullable in avoid_using_api_vi…

82960eb

…sitor

Illia Aihistov added 3 commits July 1, 2026 14:36

fix: upgrade avoid_using_api to support per-entry severity levels and…

2dccbeb

… multiple lint codes

Merge remote-tracking branch 'upstream/analysis_server_migration' int…

8992813

…o 249-migrate-avoid_using_api

test: implement getRuleOptionsForFile in FakeAnalysisOptionsLoader

3f4e2fd

solid-danylosafonov reviewed Jul 1, 2026

View reviewed changes

Illia Aihistov added 2 commits July 1, 2026 17:07

refactor: simplify logic and reduce nesting in AvoidUsingApiVisitor m…

f818fe5

…ethods

refactor: replace conditional logic with switch expression in AvoidUs…

a1ea908

…ingApiVisitor to improve readability and structure

solid-danylosafonov reviewed Jul 6, 2026

View reviewed changes

refactor: simplify visitor logic by abstracting reporting into a unif…

1999e67

…ied traversal method and moving member checks to extensions

solid-danylosafonov reviewed Jul 7, 2026

View reviewed changes

Illia Aihistov added 2 commits July 8, 2026 13:00

refactor: simplify visitor logic by offloading API matching to node e…

b723ba1

…xtension methods

refactor: use record destructuring to simplify AvoidUsingApiEntryPara…

7e2a9b4

…meters access in node extensions

solid-danylosafonov approved these changes Jul 8, 2026

View reviewed changes

Illia Aihistov added 2 commits July 8, 2026 16:05

Merge remote-tracking branch 'upstream/analysis_server_migration' int…

0307a88

…o 249-migrate-avoid_using_api

style: wrap doc comment for NoMagicNumberRuleVisitor at 80 characters

e283942

solid-illiaaihistov merged commit b38c6d9 into solid-software:analysis_server_migration Jul 8, 2026
1 check failed

solid-illiaaihistov deleted the 249-migrate-avoid_using_api branch July 8, 2026 13:06

-    final resolved = _resolveContext();
-    if (resolved == null) return;
-    final (:activeEntries, :reporter) = resolved;
+    final currentUnit = context.currentUnit;
+    if (currentUnit == null) return;
+    final activeEntries = _cachedActiveEntries ??= _getActiveEntries(
+      currentUnit.file.path,
+      context.package?.root.path,
+    );
+    final reporter = currentUnit.diagnosticReporter;

-      visitEntry(node, entry, (target) {
-        if (target is AstNode) {
-          reporter.atNode(target, _getLintCode(entry));
-        } else if (target is Token) {
-          reporter.atToken(target, _getLintCode(entry));
-        }
-      });
+      visitEntry(node, entry, (target) {
+      final severity =
+          entry.severity ?? parameters.severity ?? DiagnosticSeverity.INFO;
+      final code = LintCode(
+        AvoidUsingApiRule.lintName,
+        entry.reason ?? AvoidUsingApiRule.defaultMessage,
+        severity: severity,
+        uniqueName: AvoidUsingApiRule.getUniqueName(severity),
+      );
+      visitEntry(
+        node,
+        entry,
+        (target) => switch (target) {
+          AstNode() => reporter.atNode(target, code),
+          Token() => reporter.atToken(target, code),
+          _ => (),
+        },
+      );
+      });

-    final source = entry.source;
-    if (source == null) return;
-    final className = entry.className;
-    final identifier = entry.identifier;
-    final namedParameter = entry.namedParameter;
+    final AvoidUsingApiEntryParameters(
+      :className,
+      :identifier,
+      :namedParameter,
+      :source,
+    ) = entry;
+    if (source == null) return null;

-    switch ((className, identifier, namedParameter)) {
+    if (className == null) return;
+    switch ((identifier, namedParameter)) {

Uh oh!

Conversation

solid-illiaaihistov commented Jun 30, 2026

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

solid-illiaaihistov commented Jul 1, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

solid-danylosafonov left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

solid-danylosafonov left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants