From 43a6648bdf1a620db18ff0e3003afd627802ea1b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tru=C8=99c=C4=83=20Daria=20Maria?= <115713732+Dariaa14@users.noreply.github.com> Date: Wed, 22 Apr 2026 10:20:26 +0300 Subject: [PATCH 01/24] Created analysis_options.yaml rules parser --- .../analysis_options_loader.dart | 115 ++++++++++++++++++ 1 file changed, 115 insertions(+) create mode 100644 lib/src/common/parameter_parser/analysis_options_loader.dart diff --git a/lib/src/common/parameter_parser/analysis_options_loader.dart b/lib/src/common/parameter_parser/analysis_options_loader.dart new file mode 100644 index 00000000..2b1d5162 --- /dev/null +++ b/lib/src/common/parameter_parser/analysis_options_loader.dart @@ -0,0 +1,115 @@ +import 'dart:io'; +import 'package:yaml/yaml.dart'; + +/// Loads and parses analysis options from a Dart project's YAML file. +class AnalysisOptionsLoader { + final Map _cache = {}; + + /// Loads analysis options from a YAML file at the given [yamlPath]. + Map loadAnalysisOptions(String yamlPath) { + if (_cache.containsKey(yamlPath)) { + return _cache[yamlPath] as Map; + } + + final file = File(yamlPath); + if (!file.existsSync()) { + _cache[yamlPath] = {}; + return {}; + } + + try { + final content = file.readAsStringSync(); + final yamlMap = loadYaml(content); + final parsedYaml = _convertYaml(yamlMap); + final result = + parsedYaml is Map ? parsedYaml : {}; + + _cache[yamlPath] = result; + return result; + } on YamlException { + _cache[yamlPath] = {}; + return {}; + } + } + + /// Extracts custom lint rules from the provided YAML map. + Map extractLintRules( + Map yaml, { + String lintName = 'custom_lint', + }) { + final customLint = yaml[lintName]; + + if (customLint is! Map) return {}; + + final rules = customLint['rules']; + + if (rules is! List) return {}; + + final result = {}; + + for (final item in rules) { + final rule = _extractRuleEntry(item); + if (rule == null) continue; + + result[rule.$1] = rule.$2; + } + + return result; + } + + dynamic _convertYaml(dynamic yaml) { + if (yaml is YamlMap) { + return _yamlMapToDartMap(yaml); + } + + if (yaml is YamlList) { + return yaml.map(_convertRuleItem).toList(); + } + + return yaml; + } + + dynamic _convertRuleItem(dynamic item) { + if (item is! YamlMap) return item; + + final map = _yamlMapToDartMap(item); + + final keys = map.keys.toList(); + + if (keys.length >= 2 && map[keys.first] == null) { + final ruleName = keys.first; + final config = Map.from(map)..remove(ruleName); + + return {ruleName: config.isEmpty ? null : config}; + } + + return map; + } + + Map _yamlMapToDartMap(YamlMap yamlMap) { + return Map.fromEntries( + yamlMap.entries.map( + (e) => MapEntry(e.key.toString(), _convertYaml(e.value)), + ), + ); + } + + (String, Map)? _extractRuleEntry(dynamic item) { + if (item is String) return (item, {}); + if (item is! Map || item.isEmpty) return null; + + final entry = item.entries.first; + final ruleName = entry.key.toString(); + final config = entry.value; + + if (config is Map) { + return (ruleName, config); + } + + if (config is Map) { + return (ruleName, Map.from(config)); + } + + return (ruleName, {}); + } +} From 87abe51567444439170c0d9a228e0f7a91b129aa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tru=C8=99c=C4=83=20Daria=20Maria?= <115713732+Dariaa14@users.noreply.github.com> Date: Thu, 23 Apr 2026 11:44:53 +0300 Subject: [PATCH 02/24] Improved yaml parser and added the analysis_options loader --- lib/main.dart | 3 + .../analysis_options_loader.dart | 153 +++++++----------- .../common/parameter_parser/lint_options.dart | 30 ++++ 3 files changed, 87 insertions(+), 99 deletions(-) create mode 100644 lib/src/common/parameter_parser/lint_options.dart diff --git a/lib/main.dart b/lib/main.dart index 010dcaff..7324cd81 100644 --- a/lib/main.dart +++ b/lib/main.dart @@ -23,6 +23,9 @@ class SolidLintsPlugin extends Plugin { @override void register(PluginRegistry registry) { + // final directory = Directory.current; + // final rules = analysisLoader.loadRules(directory.path); + registry.registerLintRule( AvoidGlobalStateRule(), ); diff --git a/lib/src/common/parameter_parser/analysis_options_loader.dart b/lib/src/common/parameter_parser/analysis_options_loader.dart index 2b1d5162..0cea9442 100644 --- a/lib/src/common/parameter_parser/analysis_options_loader.dart +++ b/lib/src/common/parameter_parser/analysis_options_loader.dart @@ -1,115 +1,70 @@ -import 'dart:io'; +import 'dart:collection'; + +import 'package:analyzer/file_system/file_system.dart'; +import 'package:analyzer/file_system/physical_file_system.dart'; +import 'package:path/path.dart' as p; +import 'package:solid_lints/src/common/parameter_parser/lint_options.dart'; import 'package:yaml/yaml.dart'; +/// A global instance of [AnalysisOptionsLoader] for use across the plugin. +final analysisLoader = AnalysisOptionsLoader(); + /// Loads and parses analysis options from a Dart project's YAML file. class AnalysisOptionsLoader { - final Map _cache = {}; + /// Asynchronously loads analysis options from the specified [rootPath]. + Map loadRules(String rootPath) { + final file = PhysicalResourceProvider.INSTANCE.getFile( + p.join(rootPath, 'analysis_options.yaml'), + ); - /// Loads analysis options from a YAML file at the given [yamlPath]. - Map loadAnalysisOptions(String yamlPath) { - if (_cache.containsKey(yamlPath)) { - return _cache[yamlPath] as Map; - } + final rules = _getRules(file); + return rules; + } - final file = File(yamlPath); - if (!file.existsSync()) { - _cache[yamlPath] = {}; + Map _getRules(File? analysisOptionsFile) { + if (analysisOptionsFile == null || !analysisOptionsFile.exists) { return {}; } + final optionsString = analysisOptionsFile.readAsStringSync(); + Object? yaml; try { - final content = file.readAsStringSync(); - final yamlMap = loadYaml(content); - final parsedYaml = _convertYaml(yamlMap); - final result = - parsedYaml is Map ? parsedYaml : {}; - - _cache[yamlPath] = result; - return result; - } on YamlException { - _cache[yamlPath] = {}; + yaml = loadYaml(optionsString) as Object?; + } catch (err) { return {}; } - } - - /// Extracts custom lint rules from the provided YAML map. - Map extractLintRules( - Map yaml, { - String lintName = 'custom_lint', - }) { - final customLint = yaml[lintName]; - - if (customLint is! Map) return {}; - - final rules = customLint['rules']; - - if (rules is! List) return {}; - - final result = {}; - - for (final item in rules) { - final rule = _extractRuleEntry(item); - if (rule == null) continue; - - result[rule.$1] = rule.$2; - } - - return result; - } - - dynamic _convertYaml(dynamic yaml) { - if (yaml is YamlMap) { - return _yamlMapToDartMap(yaml); - } - - if (yaml is YamlList) { - return yaml.map(_convertRuleItem).toList(); - } - - return yaml; - } - - dynamic _convertRuleItem(dynamic item) { - if (item is! YamlMap) return item; - - final map = _yamlMapToDartMap(item); - - final keys = map.keys.toList(); - - if (keys.length >= 2 && map[keys.first] == null) { - final ruleName = keys.first; - final config = Map.from(map)..remove(ruleName); - - return {ruleName: config.isEmpty ? null : config}; - } - - return map; - } - - Map _yamlMapToDartMap(YamlMap yamlMap) { - return Map.fromEntries( - yamlMap.entries.map( - (e) => MapEntry(e.key.toString(), _convertYaml(e.value)), - ), - ); - } - - (String, Map)? _extractRuleEntry(dynamic item) { - if (item is String) return (item, {}); - if (item is! Map || item.isEmpty) return null; - - final entry = item.entries.first; - final ruleName = entry.key.toString(); - final config = entry.value; - - if (config is Map) { - return (ruleName, config); - } - - if (config is Map) { - return (ruleName, Map.from(config)); + if (yaml is! Map) return {}; + + final rules = {}; + final pluginsYaml = yaml['plugins'] as Object?; + + if (pluginsYaml is Map) { + final solidLint = pluginsYaml['solid_lints']; + if (solidLint is Map) { + final diagnostics = solidLint['diagnostics']; + + if (diagnostics is Map) { + for (final diag in diagnostics.entries) { + final ruleName = diag.key as String; + final value = diag.value; + + if (value is bool) { + rules[ruleName] = LintOptions.empty(enabled: value); + } else if (value is Map) { + final map = Map.from(value); + + final enabled = map.remove('enabled') as bool? ?? true; + + rules[ruleName] = LintOptions.fromYaml( + map, + enabled: enabled, + ); + } + } + } + } } - return (ruleName, {}); + return UnmodifiableMapView(rules); } } diff --git a/lib/src/common/parameter_parser/lint_options.dart b/lib/src/common/parameter_parser/lint_options.dart new file mode 100644 index 00000000..f368ae13 --- /dev/null +++ b/lib/src/common/parameter_parser/lint_options.dart @@ -0,0 +1,30 @@ +import 'package:analyzer/analysis_rule/analysis_rule.dart'; +import 'package:collection/collection.dart'; + +/// Option information for a specific [AnalysisRule]. +class LintOptions { + /// Creates a [LintOptions] from YAML. + const LintOptions.fromYaml(Map yaml, {required this.enabled}) + : json = yaml; + + /// Options with no [json] + const LintOptions.empty({required this.enabled}) : json = const {}; + + /// Whether the configuration enables/disables the lint rule. + final bool enabled; + + /// Extra configurations for a [AnalysisRule]. + final Map json; + + @override + bool operator ==(Object other) => + other is LintOptions && + other.enabled == enabled && + const MapEquality().equals(other.json, json); + + @override + int get hashCode => Object.hash( + enabled, + const MapEquality().hash(json), + ); +} From 4c604a364afbe3f3732e0e838244d21effc79ec4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tru=C8=99c=C4=83=20Daria=20Maria?= <115713732+Dariaa14@users.noreply.github.com> Date: Thu, 23 Apr 2026 15:52:19 +0300 Subject: [PATCH 03/24] Improved rules loader from yaml --- lib/main.dart | 3 - .../analysis_options_loader.dart | 60 +++++- .../common/parameter_parser/lint_options.dart | 202 ++++++++++++++++++ 3 files changed, 255 insertions(+), 10 deletions(-) diff --git a/lib/main.dart b/lib/main.dart index 7324cd81..010dcaff 100644 --- a/lib/main.dart +++ b/lib/main.dart @@ -23,9 +23,6 @@ class SolidLintsPlugin extends Plugin { @override void register(PluginRegistry registry) { - // final directory = Directory.current; - // final rules = analysisLoader.loadRules(directory.path); - registry.registerLintRule( AvoidGlobalStateRule(), ); diff --git a/lib/src/common/parameter_parser/analysis_options_loader.dart b/lib/src/common/parameter_parser/analysis_options_loader.dart index 0cea9442..a48e8701 100644 --- a/lib/src/common/parameter_parser/analysis_options_loader.dart +++ b/lib/src/common/parameter_parser/analysis_options_loader.dart @@ -1,8 +1,10 @@ import 'dart:collection'; +import 'dart:io' as io; +import 'dart:io'; +import 'package:analyzer/analysis_rule/rule_context.dart'; import 'package:analyzer/file_system/file_system.dart'; import 'package:analyzer/file_system/physical_file_system.dart'; -import 'package:path/path.dart' as p; import 'package:solid_lints/src/common/parameter_parser/lint_options.dart'; import 'package:yaml/yaml.dart'; @@ -11,14 +13,58 @@ final analysisLoader = AnalysisOptionsLoader(); /// Loads and parses analysis options from a Dart project's YAML file. class AnalysisOptionsLoader { - /// Asynchronously loads analysis options from the specified [rootPath]. - Map loadRules(String rootPath) { - final file = PhysicalResourceProvider.INSTANCE.getFile( - p.join(rootPath, 'analysis_options.yaml'), - ); + Map _rulesCache = {}; + + /// Retrieves the currently loaded lint rules. + Map get rules => _rulesCache; + + /// Loads lint rules from the analysis options file based + /// on the provided [RuleContext]. + void loadRulesFromContext(RuleContext context) { + if (_rulesCache.isNotEmpty) { + return; + } + + final directory = context.allUnits.first.file.path; + _loadRules(directory); + } + + void _loadRules(String rootPath) { + final yamlPath = _findNearestYamlUpwards(rootPath); + + if (yamlPath == null) { + return; + } + + final file = PhysicalResourceProvider.INSTANCE.getFile(yamlPath); final rules = _getRules(file); - return rules; + _rulesCache = rules; + } + + String? _findNearestYamlUpwards( + String filePath, { + String fileName = 'analysis_options.yaml', + }) { + final startFile = io.File(filePath); + io.Directory dir = startFile.parent; + + while (true) { + final candidate = PhysicalResourceProvider.INSTANCE + .getFile('${dir.path}${Platform.pathSeparator}$fileName'); + + if (candidate.exists) { + return candidate.path; + } + + final parent = dir.parent; + + if (parent.path == dir.path) { + return null; + } + + dir = parent; + } } Map _getRules(File? analysisOptionsFile) { diff --git a/lib/src/common/parameter_parser/lint_options.dart b/lib/src/common/parameter_parser/lint_options.dart index f368ae13..0174f7fc 100644 --- a/lib/src/common/parameter_parser/lint_options.dart +++ b/lib/src/common/parameter_parser/lint_options.dart @@ -1,3 +1,205 @@ +// Apache License +// Version 2.0, January 2004 +// http://www.apache.org/licenses/ + +// TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +// 1. Definitions. + +// "License" shall mean the terms and conditions for use, reproduction, +// and distribution as defined by Sections 1 through 9 of this document. + +// "Licensor" shall mean the copyright owner or entity authorized by +// the copyright owner that is granting the License. + +// "Legal Entity" shall mean the union of the acting entity and all +// other entities that control, are controlled by, or are under common +// control with that entity. For the purposes of this definition, +// "control" means (i) the power, direct or indirect, to cause the +// direction or management of such entity, whether by contract or +// otherwise, or (ii) ownership of fifty percent (50%) or more of the +// outstanding shares, or (iii) beneficial ownership of such entity. + +// "You" (or "Your") shall mean an individual or Legal Entity +// exercising permissions granted by this License. + +// "Source" form shall mean the preferred form for making modifications, +// including but not limited to software source code, documentation +// source, and configuration files. + +// "Object" form shall mean any form resulting from mechanical +// transformation or translation of a Source form, including but +// not limited to compiled object code, generated documentation, +// and conversions to other media types. + +// "Work" shall mean the work of authorship, whether in Source or +// Object form, made available under the License, as indicated by a +// copyright notice that is included in or attached to the work +// (an example is provided in the Appendix below). + +// "Derivative Works" shall mean any work, whether in Source or Object +// form, that is based on (or derived from) the Work and for which the +// editorial revisions, annotations, elaborations, or other modifications +// represent, as a whole, an original work of authorship. For the purposes +// of this License, Derivative Works shall not include works that remain +// separable from, or merely link (or bind by name) to the interfaces of, +// the Work and Derivative Works thereof. + +// "Contribution" shall mean any work of authorship, including +// the original version of the Work and any modifications or additions +// to that Work or Derivative Works thereof, that is intentionally +// submitted to Licensor for inclusion in the Work by the copyright owner +// or by an individual or Legal Entity authorized to submit on behalf of +// the copyright owner. For the purposes of this definition, "submitted" +// means any form of electronic, verbal, or written communication sent +// to the Licensor or its representatives, including but not limited to +// communication on electronic mailing lists, source code control systems, +// and issue tracking systems that are managed by, or on behalf of, the +// Licensor for the purpose of discussing and improving the Work, but +// excluding communication that is conspicuously marked or otherwise +// designated in writing by the copyright owner as "Not a Contribution." + +// "Contributor" shall mean Licensor and any individual or Legal Entity +// on behalf of whom a Contribution has been received by Licensor and +// subsequently incorporated within the Work. + +// 2. Grant of Copyright License. Subject to the terms and conditions of +// this License, each Contributor hereby grants to You a perpetual, +// worldwide, non-exclusive, no-charge, royalty-free, irrevocable +// copyright license to reproduce, prepare Derivative Works of, +// publicly display, publicly perform, sublicense, and distribute the +// Work and such Derivative Works in Source or Object form. + +// 3. Grant of Patent License. Subject to the terms and conditions of +// this License, each Contributor hereby grants to You a perpetual, +// worldwide, non-exclusive, no-charge, royalty-free, irrevocable +// (except as stated in this section) patent license to make, have made, +// use, offer to sell, sell, import, and otherwise transfer the Work, +// where such license applies only to those patent claims licensable +// by such Contributor that are necessarily infringed by their +// Contribution(s) alone or by combination of their Contribution(s) +// with the Work to which such Contribution(s) was submitted. If You +// institute patent litigation against any entity (including a +// cross-claim or counterclaim in a lawsuit) alleging that the Work +// or a Contribution incorporated within the Work constitutes direct +// or contributory patent infringement, then any patent licenses +// granted to You under this License for that Work shall terminate +// as of the date such litigation is filed. + +// 4. Redistribution. You may reproduce and distribute copies of the +// Work or Derivative Works thereof in any medium, with or without +// modifications, and in Source or Object form, provided that You +// meet the following conditions: + +// (a) You must give any other recipients of the Work or +// Derivative Works a copy of this License; and + +// (b) You must cause any modified files to carry prominent notices +// stating that You changed the files; and + +// (c) You must retain, in the Source form of any Derivative Works +// that You distribute, all copyright, patent, trademark, and +// attribution notices from the Source form of the Work, +// excluding those notices that do not pertain to any part of +// the Derivative Works; and + +// (d) If the Work includes a "NOTICE" text file as part of its +// distribution, then any Derivative Works that You distribute must +// include a readable copy of the attribution notices contained +// within such NOTICE file, excluding those notices that do not +// pertain to any part of the Derivative Works, in at least one +// of the following places: within a NOTICE text file distributed +// as part of the Derivative Works; within the Source form or +// documentation, if provided along with the Derivative Works; or, +// within a display generated by the Derivative Works, if and +// wherever such third-party notices normally appear. The contents +// of the NOTICE file are for informational purposes only and +// do not modify the License. You may add Your own attribution +// notices within Derivative Works that You distribute, alongside +// or as an addendum to the NOTICE text from the Work, provided +// that such additional attribution notices cannot be construed +// as modifying the License. + +// You may add Your own copyright statement to Your modifications and +// may provide additional or different license terms and conditions +// for use, reproduction, or distribution of Your modifications, or +// for any such Derivative Works as a whole, provided Your use, +// reproduction, and distribution of the Work otherwise complies with +// the conditions stated in this License. + +// 5. Submission of Contributions. Unless You explicitly state otherwise, +// any Contribution intentionally submitted for inclusion in the Work +// by You to the Licensor shall be under the terms and conditions of +// this License, without any additional terms or conditions. +// Notwithstanding the above, nothing herein shall supersede or modify +// the terms of any separate license agreement you may have executed +// with Licensor regarding such Contributions. + +// 6. Trademarks. This License does not grant permission to use the trade +// names, trademarks, service marks, or product names of the Licensor, +// except as required for reasonable and customary use in describing the +// origin of the Work and reproducing the content of the NOTICE file. + +// 7. Disclaimer of Warranty. Unless required by applicable law or +// agreed to in writing, Licensor provides the Work (and each +// Contributor provides its Contributions) on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +// implied, including, without limitation, any warranties or conditions +// of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A +// PARTICULAR PURPOSE. You are solely responsible for determining the +// appropriateness of using or redistributing the Work and assume any +// risks associated with Your exercise of permissions under this License. + +// 8. Limitation of Liability. In no event and under no legal theory, +// whether in tort (including negligence), contract, or otherwise, +// unless required by applicable law (such as deliberate and grossly +// negligent acts) or agreed to in writing, shall any Contributor be +// liable to You for damages, including any direct, indirect, special, +// incidental, or consequential damages of any character arising as a +// result of this License or out of the use or inability to use the +// Work (including but not limited to damages for loss of goodwill, +// work stoppage, computer failure or malfunction, or any and all +// other commercial damages or losses), even if such Contributor +// has been advised of the possibility of such damages. + +// 9. Accepting Warranty or Additional Liability. While redistributing +// the Work or Derivative Works thereof, You may choose to offer, +// and charge a fee for, acceptance of support, warranty, indemnity, +// or other liability obligations and/or rights consistent with this +// License. However, in accepting such obligations, You may act only +// on Your own behalf and on Your sole responsibility, not on behalf +// of any other Contributor, and only if You agree to indemnify, +// defend, and hold each Contributor harmless for any liability +// incurred by, or claims asserted against, such Contributor by reason +// of your accepting any such warranty or additional liability. + +// END OF TERMS AND CONDITIONS + +// APPENDIX: How to apply the Apache License to your work. + +// To apply the Apache License to your work, attach the following +// boilerplate notice, with the fields enclosed by brackets "[]" +// replaced with your own identifying information. (Don't include +// the brackets!) The text should be enclosed in the appropriate +// comment syntax for the file format. We also recommend that a +// file or class name and description of purpose be included on the +// same "printed page" as the copyright notice for easier +// identification within third-party archives. + +// Copyright 2020 Invertase Limited + +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at + +// http://www.apache.org/licenses/LICENSE-2.0 + +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + import 'package:analyzer/analysis_rule/analysis_rule.dart'; import 'package:collection/collection.dart'; From 87f58702dbe8cc1ba110ac838351076740b75d76 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tru=C8=99c=C4=83=20Daria=20Maria?= <115713732+Dariaa14@users.noreply.github.com> Date: Thu, 23 Apr 2026 16:11:39 +0300 Subject: [PATCH 04/24] Added verification before looking for .yaml's path --- lib/src/common/parameter_parser/analysis_options_loader.dart | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/lib/src/common/parameter_parser/analysis_options_loader.dart b/lib/src/common/parameter_parser/analysis_options_loader.dart index a48e8701..2a0f3107 100644 --- a/lib/src/common/parameter_parser/analysis_options_loader.dart +++ b/lib/src/common/parameter_parser/analysis_options_loader.dart @@ -24,7 +24,9 @@ class AnalysisOptionsLoader { if (_rulesCache.isNotEmpty) { return; } - + if (context.allUnits.isEmpty) { + return; + } final directory = context.allUnits.first.file.path; _loadRules(directory); } From ca9df7c4480d9999d5bc22a762343f63c382453d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tru=C8=99c=C4=83=20Daria=20Maria?= <115713732+Dariaa14@users.noreply.github.com> Date: Thu, 23 Apr 2026 17:54:59 +0300 Subject: [PATCH 05/24] Fields and getters are now declared before the constructor --- lib/src/common/parameter_parser/lint_options.dart | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/src/common/parameter_parser/lint_options.dart b/lib/src/common/parameter_parser/lint_options.dart index 0174f7fc..ad22fed9 100644 --- a/lib/src/common/parameter_parser/lint_options.dart +++ b/lib/src/common/parameter_parser/lint_options.dart @@ -205,10 +205,6 @@ import 'package:collection/collection.dart'; /// Option information for a specific [AnalysisRule]. class LintOptions { - /// Creates a [LintOptions] from YAML. - const LintOptions.fromYaml(Map yaml, {required this.enabled}) - : json = yaml; - /// Options with no [json] const LintOptions.empty({required this.enabled}) : json = const {}; @@ -218,6 +214,10 @@ class LintOptions { /// Extra configurations for a [AnalysisRule]. final Map json; + /// Creates a [LintOptions] from YAML. + const LintOptions.fromYaml(Map yaml, {required this.enabled}) + : json = yaml; + @override bool operator ==(Object other) => other is LintOptions && From 226a748e33ccd8e9afe387ad9c6e61ac31993b3f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tru=C8=99c=C4=83=20Daria=20Maria?= <115713732+Dariaa14@users.noreply.github.com> Date: Thu, 23 Apr 2026 18:12:15 +0300 Subject: [PATCH 06/24] Added method to get options of a rule by it's name --- lib/src/common/parameter_parser/analysis_options_loader.dart | 3 +++ 1 file changed, 3 insertions(+) diff --git a/lib/src/common/parameter_parser/analysis_options_loader.dart b/lib/src/common/parameter_parser/analysis_options_loader.dart index 2a0f3107..23822a8f 100644 --- a/lib/src/common/parameter_parser/analysis_options_loader.dart +++ b/lib/src/common/parameter_parser/analysis_options_loader.dart @@ -18,6 +18,9 @@ class AnalysisOptionsLoader { /// Retrieves the currently loaded lint rules. Map get rules => _rulesCache; + /// Gets the options for a specific rule by its name. + LintOptions? getRuleOptions(String ruleName) => _rulesCache[ruleName]; + /// Loads lint rules from the analysis options file based /// on the provided [RuleContext]. void loadRulesFromContext(RuleContext context) { From 08c3e8e81e1f3a46e34ef82fc36f9040aa802305 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tru=C8=99c=C4=83=20Daria=20Maria?= <115713732+Dariaa14@users.noreply.github.com> Date: Thu, 23 Apr 2026 18:21:36 +0300 Subject: [PATCH 07/24] Made suggested changes to file upward finder --- .../parameter_parser/analysis_options_loader.dart | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/lib/src/common/parameter_parser/analysis_options_loader.dart b/lib/src/common/parameter_parser/analysis_options_loader.dart index 23822a8f..3c0a6d6a 100644 --- a/lib/src/common/parameter_parser/analysis_options_loader.dart +++ b/lib/src/common/parameter_parser/analysis_options_loader.dart @@ -1,5 +1,3 @@ -import 'dart:collection'; - import 'dart:io' as io; import 'dart:io'; import 'package:analyzer/analysis_rule/rule_context.dart'; @@ -35,7 +33,7 @@ class AnalysisOptionsLoader { } void _loadRules(String rootPath) { - final yamlPath = _findNearestYamlUpwards(rootPath); + final yamlPath = _findNearestFileUpwards(rootPath); if (yamlPath == null) { return; @@ -47,14 +45,14 @@ class AnalysisOptionsLoader { _rulesCache = rules; } - String? _findNearestYamlUpwards( + String? _findNearestFileUpwards( String filePath, { String fileName = 'analysis_options.yaml', }) { final startFile = io.File(filePath); io.Directory dir = startFile.parent; - while (true) { + while (dir.path != dir.parent.path) { final candidate = PhysicalResourceProvider.INSTANCE .getFile('${dir.path}${Platform.pathSeparator}$fileName'); @@ -64,12 +62,9 @@ class AnalysisOptionsLoader { final parent = dir.parent; - if (parent.path == dir.path) { - return null; - } - dir = parent; } + return null; } Map _getRules(File? analysisOptionsFile) { @@ -116,6 +111,6 @@ class AnalysisOptionsLoader { } } - return UnmodifiableMapView(rules); + return rules; } } From 1eee0b2a55a573323917135fdc4a75cbf78f7431 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tru=C8=99c=C4=83=20Daria=20Maria?= <115713732+Dariaa14@users.noreply.github.com> Date: Thu, 23 Apr 2026 18:28:58 +0300 Subject: [PATCH 08/24] Removed top-level variable --- lib/src/common/parameter_parser/analysis_options_loader.dart | 3 --- 1 file changed, 3 deletions(-) diff --git a/lib/src/common/parameter_parser/analysis_options_loader.dart b/lib/src/common/parameter_parser/analysis_options_loader.dart index 3c0a6d6a..9570fb34 100644 --- a/lib/src/common/parameter_parser/analysis_options_loader.dart +++ b/lib/src/common/parameter_parser/analysis_options_loader.dart @@ -6,9 +6,6 @@ import 'package:analyzer/file_system/physical_file_system.dart'; import 'package:solid_lints/src/common/parameter_parser/lint_options.dart'; import 'package:yaml/yaml.dart'; -/// A global instance of [AnalysisOptionsLoader] for use across the plugin. -final analysisLoader = AnalysisOptionsLoader(); - /// Loads and parses analysis options from a Dart project's YAML file. class AnalysisOptionsLoader { Map _rulesCache = {}; From 0ef7917ff8e06c8dc7d8fbe02a603f4d8f9a905a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tru=C8=99c=C4=83=20Daria=20Maria?= <115713732+Dariaa14@users.noreply.github.com> Date: Thu, 23 Apr 2026 18:31:36 +0300 Subject: [PATCH 09/24] Improved name of variable in loadRuleFromContext --- lib/src/common/parameter_parser/analysis_options_loader.dart | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/src/common/parameter_parser/analysis_options_loader.dart b/lib/src/common/parameter_parser/analysis_options_loader.dart index 9570fb34..b6f1ac8f 100644 --- a/lib/src/common/parameter_parser/analysis_options_loader.dart +++ b/lib/src/common/parameter_parser/analysis_options_loader.dart @@ -25,8 +25,8 @@ class AnalysisOptionsLoader { if (context.allUnits.isEmpty) { return; } - final directory = context.allUnits.first.file.path; - _loadRules(directory); + final filePath = context.allUnits.first.file.path; + _loadRules(filePath); } void _loadRules(String rootPath) { From 86c3f4d27fc625fdf4afefd2df755ac1fa79e757 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tru=C8=99c=C4=83=20Daria=20Maria?= <115713732+Dariaa14@users.noreply.github.com> Date: Thu, 23 Apr 2026 18:50:12 +0300 Subject: [PATCH 10/24] Updated analysis options to have rules for each configuration file path --- .../analysis_options_loader.dart | 20 ++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/lib/src/common/parameter_parser/analysis_options_loader.dart b/lib/src/common/parameter_parser/analysis_options_loader.dart index b6f1ac8f..d8179f76 100644 --- a/lib/src/common/parameter_parser/analysis_options_loader.dart +++ b/lib/src/common/parameter_parser/analysis_options_loader.dart @@ -8,20 +8,18 @@ import 'package:yaml/yaml.dart'; /// Loads and parses analysis options from a Dart project's YAML file. class AnalysisOptionsLoader { - Map _rulesCache = {}; - - /// Retrieves the currently loaded lint rules. - Map get rules => _rulesCache; + final Map> _rulesCache = {}; /// Gets the options for a specific rule by its name. - LintOptions? getRuleOptions(String ruleName) => _rulesCache[ruleName]; + LintOptions? getRuleOptions(RuleContext context, String ruleName) { + final yamlPath = _findNearestFileUpwards(context.allUnits.first.file.path); + if (yamlPath == null) return null; + return _rulesCache[yamlPath]?[ruleName]; + } /// Loads lint rules from the analysis options file based /// on the provided [RuleContext]. void loadRulesFromContext(RuleContext context) { - if (_rulesCache.isNotEmpty) { - return; - } if (context.allUnits.isEmpty) { return; } @@ -36,10 +34,14 @@ class AnalysisOptionsLoader { return; } + if (_rulesCache.containsKey(yamlPath)) { + return; + } + final file = PhysicalResourceProvider.INSTANCE.getFile(yamlPath); final rules = _getRules(file); - _rulesCache = rules; + _rulesCache[yamlPath] = rules; } String? _findNearestFileUpwards( From e0490f702f91264380cffc62e84796890a88b16f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tru=C8=99c=C4=83=20Daria=20Maria?= <115713732+Dariaa14@users.noreply.github.com> Date: Thu, 23 Apr 2026 19:06:09 +0300 Subject: [PATCH 11/24] Updated file upward finder to not mix File from dart.io with file from analyzer --- .../analysis_options_loader.dart | 20 +++++++++---------- 1 file changed, 9 insertions(+), 11 deletions(-) diff --git a/lib/src/common/parameter_parser/analysis_options_loader.dart b/lib/src/common/parameter_parser/analysis_options_loader.dart index d8179f76..65c53ce5 100644 --- a/lib/src/common/parameter_parser/analysis_options_loader.dart +++ b/lib/src/common/parameter_parser/analysis_options_loader.dart @@ -1,5 +1,3 @@ -import 'dart:io' as io; -import 'dart:io'; import 'package:analyzer/analysis_rule/rule_context.dart'; import 'package:analyzer/file_system/file_system.dart'; import 'package:analyzer/file_system/physical_file_system.dart'; @@ -48,20 +46,20 @@ class AnalysisOptionsLoader { String filePath, { String fileName = 'analysis_options.yaml', }) { - final startFile = io.File(filePath); - io.Directory dir = startFile.parent; + final pathContext = PhysicalResourceProvider.INSTANCE.pathContext; + var dir = pathContext.dirname(filePath); - while (dir.path != dir.parent.path) { - final candidate = PhysicalResourceProvider.INSTANCE - .getFile('${dir.path}${Platform.pathSeparator}$fileName'); + while (pathContext.dirname(dir) != dir) { + final candidatePath = pathContext.join(dir, fileName); + final candidate = + PhysicalResourceProvider.INSTANCE.getFile(candidatePath); if (candidate.exists) { - return candidate.path; + return candidatePath; } - final parent = dir.parent; - - dir = parent; + final parentDir = pathContext.dirname(dir); + dir = parentDir; } return null; } From 03a53baa7f6eacddbad7e2a2aa70a2bb3173c8ab Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tru=C8=99c=C4=83=20Daria=20Maria?= <115713732+Dariaa14@users.noreply.github.com> Date: Thu, 23 Apr 2026 19:09:55 +0300 Subject: [PATCH 12/24] Added usage example in avoid_global_state_rule --- lib/main.dart | 4 +++- .../avoid_global_state/avoid_global_state_rule.dart | 9 ++++++++- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/lib/main.dart b/lib/main.dart index 010dcaff..087c45c7 100644 --- a/lib/main.dart +++ b/lib/main.dart @@ -1,5 +1,6 @@ import 'package:analysis_server_plugin/plugin.dart'; import 'package:analysis_server_plugin/registry.dart'; +import 'package:solid_lints/src/common/parameter_parser/analysis_options_loader.dart'; import 'package:solid_lints/src/lints/avoid_debug_print_in_release/avoid_debug_print_in_release_rule.dart'; import 'package:solid_lints/src/lints/avoid_global_state/avoid_global_state_rule.dart'; import 'package:solid_lints/src/lints/avoid_non_null_assertion/avoid_non_null_assertion_rule.dart'; @@ -23,8 +24,9 @@ class SolidLintsPlugin extends Plugin { @override void register(PluginRegistry registry) { + final analysisLoader = AnalysisOptionsLoader(); registry.registerLintRule( - AvoidGlobalStateRule(), + AvoidGlobalStateRule(analysisLoader), ); registry.registerLintRule( AvoidNonNullAssertionRule(), diff --git a/lib/src/lints/avoid_global_state/avoid_global_state_rule.dart b/lib/src/lints/avoid_global_state/avoid_global_state_rule.dart index 6ee78241..6586673f 100644 --- a/lib/src/lints/avoid_global_state/avoid_global_state_rule.dart +++ b/lib/src/lints/avoid_global_state/avoid_global_state_rule.dart @@ -2,6 +2,7 @@ import 'package:analyzer/analysis_rule/analysis_rule.dart'; import 'package:analyzer/analysis_rule/rule_context.dart'; import 'package:analyzer/analysis_rule/rule_visitor_registry.dart'; import 'package:analyzer/error/error.dart'; +import 'package:solid_lints/src/common/parameter_parser/analysis_options_loader.dart'; import 'package:solid_lints/src/lints/avoid_global_state/visitors/avoid_global_state_visitor.dart'; /// Avoid top-level and static mutable variables. @@ -46,8 +47,10 @@ class AvoidGlobalStateRule extends AnalysisRule { 'Prefer using final/const or a state management solution.', ); + final AnalysisOptionsLoader _analysisLoader; + /// Creates an instance of [AvoidGlobalStateRule]. - AvoidGlobalStateRule() + AvoidGlobalStateRule(this._analysisLoader) : super( name: lintName, description: 'Avoid top-level or static mutable variables ', @@ -63,6 +66,10 @@ class AvoidGlobalStateRule extends AnalysisRule { ) { final visitor = AvoidGlobalStateVisitor(this); + _analysisLoader.loadRulesFromContext(context); + // To get the options of the rule: + // _analysisLoader.getRuleOptions(context, lintName); + registry.addTopLevelVariableDeclaration(this, visitor); registry.addFieldDeclaration(this, visitor); } From 9f90265ab73b2bf9d4c71dd351c865098de846b4 Mon Sep 17 00:00:00 2001 From: Andrew Bekhiet Date: Tue, 2 Jun 2026 21:22:34 +0300 Subject: [PATCH 13/24] style: move getters and fields before constructor --- .../common/parameter_parser/lint_options.dart | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/lib/src/common/parameter_parser/lint_options.dart b/lib/src/common/parameter_parser/lint_options.dart index ad22fed9..7880b42d 100644 --- a/lib/src/common/parameter_parser/lint_options.dart +++ b/lib/src/common/parameter_parser/lint_options.dart @@ -205,15 +205,21 @@ import 'package:collection/collection.dart'; /// Option information for a specific [AnalysisRule]. class LintOptions { - /// Options with no [json] - const LintOptions.empty({required this.enabled}) : json = const {}; - /// Whether the configuration enables/disables the lint rule. final bool enabled; /// Extra configurations for a [AnalysisRule]. final Map json; + @override + int get hashCode => Object.hash( + enabled, + const MapEquality().hash(json), + ); + + /// Options with no [json] + const LintOptions.empty({required this.enabled}) : json = const {}; + /// Creates a [LintOptions] from YAML. const LintOptions.fromYaml(Map yaml, {required this.enabled}) : json = yaml; @@ -223,10 +229,4 @@ class LintOptions { other is LintOptions && other.enabled == enabled && const MapEquality().equals(other.json, json); - - @override - int get hashCode => Object.hash( - enabled, - const MapEquality().hash(json), - ); } From a8d53e4f0dc94e6e343a7722d384da3faec86e5b Mon Sep 17 00:00:00 2001 From: Andrew Bekhiet Date: Tue, 2 Jun 2026 21:28:53 +0300 Subject: [PATCH 14/24] style: improve readability --- .../analysis_options_loader.dart | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/lib/src/common/parameter_parser/analysis_options_loader.dart b/lib/src/common/parameter_parser/analysis_options_loader.dart index 65c53ce5..3b1891c9 100644 --- a/lib/src/common/parameter_parser/analysis_options_loader.dart +++ b/lib/src/common/parameter_parser/analysis_options_loader.dart @@ -12,6 +12,7 @@ class AnalysisOptionsLoader { LintOptions? getRuleOptions(RuleContext context, String ruleName) { final yamlPath = _findNearestFileUpwards(context.allUnits.first.file.path); if (yamlPath == null) return null; + return _rulesCache[yamlPath]?[ruleName]; } @@ -21,6 +22,7 @@ class AnalysisOptionsLoader { if (context.allUnits.isEmpty) { return; } + final filePath = context.allUnits.first.file.path; _loadRules(filePath); } @@ -47,20 +49,21 @@ class AnalysisOptionsLoader { String fileName = 'analysis_options.yaml', }) { final pathContext = PhysicalResourceProvider.INSTANCE.pathContext; - var dir = pathContext.dirname(filePath); + String currentDirectoryPath = pathContext.dirname(filePath); - while (pathContext.dirname(dir) != dir) { - final candidatePath = pathContext.join(dir, fileName); - final candidate = + while (pathContext.dirname(currentDirectoryPath) != currentDirectoryPath) { + final candidatePath = pathContext.join(currentDirectoryPath, fileName); + final candidateFile = PhysicalResourceProvider.INSTANCE.getFile(candidatePath); - if (candidate.exists) { + if (candidateFile.exists) { return candidatePath; } - final parentDir = pathContext.dirname(dir); - dir = parentDir; + final parentDir = pathContext.dirname(currentDirectoryPath); + currentDirectoryPath = parentDir; } + return null; } @@ -76,6 +79,7 @@ class AnalysisOptionsLoader { } catch (err) { return {}; } + if (yaml is! Map) return {}; final rules = {}; From 73514fd8746ba8407287a5857c7eaf0214530767 Mon Sep 17 00:00:00 2001 From: Andrew Bekhiet Date: Tue, 2 Jun 2026 21:59:22 +0300 Subject: [PATCH 15/24] fix: don't parse enabled if the rule has configured options style: improve variable names refactor: use root package path instead of library path refactor: use pattern matching to reduce nesting --- .../analysis_options_loader.dart | 77 ++++++++----------- 1 file changed, 32 insertions(+), 45 deletions(-) diff --git a/lib/src/common/parameter_parser/analysis_options_loader.dart b/lib/src/common/parameter_parser/analysis_options_loader.dart index 3b1891c9..b9d7b5be 100644 --- a/lib/src/common/parameter_parser/analysis_options_loader.dart +++ b/lib/src/common/parameter_parser/analysis_options_loader.dart @@ -10,7 +10,10 @@ class AnalysisOptionsLoader { /// Gets the options for a specific rule by its name. LintOptions? getRuleOptions(RuleContext context, String ruleName) { - final yamlPath = _findNearestFileUpwards(context.allUnits.first.file.path); + final packageRootPath = context.package?.root.path; + if (packageRootPath == null) return null; + + final yamlPath = _findNearestAnalysisOptionsFilePath(packageRootPath); if (yamlPath == null) return null; return _rulesCache[yamlPath]?[ruleName]; @@ -19,40 +22,33 @@ class AnalysisOptionsLoader { /// Loads lint rules from the analysis options file based /// on the provided [RuleContext]. void loadRulesFromContext(RuleContext context) { - if (context.allUnits.isEmpty) { - return; - } + final packageRootPath = context.package?.root.path; + if (packageRootPath == null) return; - final filePath = context.allUnits.first.file.path; - _loadRules(filePath); + _loadRules(packageRootPath); } void _loadRules(String rootPath) { - final yamlPath = _findNearestFileUpwards(rootPath); + final yamlPath = _findNearestAnalysisOptionsFilePath(rootPath); - if (yamlPath == null) { + if (yamlPath == null || _rulesCache.containsKey(yamlPath)) { return; } - if (_rulesCache.containsKey(yamlPath)) { - return; - } - - final file = PhysicalResourceProvider.INSTANCE.getFile(yamlPath); + final analysisOptionsFile = + PhysicalResourceProvider.INSTANCE.getFile(yamlPath); - final rules = _getRules(file); + final rules = _getRules(analysisOptionsFile); _rulesCache[yamlPath] = rules; } - String? _findNearestFileUpwards( - String filePath, { - String fileName = 'analysis_options.yaml', - }) { + String? _findNearestAnalysisOptionsFilePath(String packageRootPath) { final pathContext = PhysicalResourceProvider.INSTANCE.pathContext; - String currentDirectoryPath = pathContext.dirname(filePath); + String currentDirectoryPath = packageRootPath; while (pathContext.dirname(currentDirectoryPath) != currentDirectoryPath) { - final candidatePath = pathContext.join(currentDirectoryPath, fileName); + final candidatePath = + pathContext.join(currentDirectoryPath, 'analysis_options.yaml'); final candidateFile = PhysicalResourceProvider.INSTANCE.getFile(candidatePath); @@ -83,31 +79,22 @@ class AnalysisOptionsLoader { if (yaml is! Map) return {}; final rules = {}; - final pluginsYaml = yaml['plugins'] as Object?; - - if (pluginsYaml is Map) { - final solidLint = pluginsYaml['solid_lints']; - if (solidLint is Map) { - final diagnostics = solidLint['diagnostics']; - - if (diagnostics is Map) { - for (final diag in diagnostics.entries) { - final ruleName = diag.key as String; - final value = diag.value; - - if (value is bool) { - rules[ruleName] = LintOptions.empty(enabled: value); - } else if (value is Map) { - final map = Map.from(value); - - final enabled = map.remove('enabled') as bool? ?? true; - - rules[ruleName] = LintOptions.fromYaml( - map, - enabled: enabled, - ); - } - } + + if (yaml + case {'plugins': {'solid_lints': {'diagnostics': final diagnostics?}}} + when diagnostics is Map) { + for (final MapEntry(:key, :value) in diagnostics.entries) { + if (key is! String) continue; + + final ruleName = key; + + if (value is bool) { + rules[ruleName] = LintOptions.empty(enabled: value); + } else if (value is Map) { + rules[ruleName] = LintOptions.fromYaml( + Map.from(value), + enabled: true, + ); } } } From c6a24534fd2144977463277b9baf993bae53f189 Mon Sep 17 00:00:00 2001 From: Andrew Bekhiet Date: Tue, 2 Jun 2026 23:54:18 +0300 Subject: [PATCH 16/24] feat: reload rules from file if newer refactor: allow mocking resource provider refactor: extract CachedPackageRules model --- .../analysis_options_loader.dart | 35 ++++++++++++------- .../cached_package_rules.dart | 16 +++++++++ 2 files changed, 39 insertions(+), 12 deletions(-) create mode 100644 lib/src/common/parameter_parser/cached_package_rules.dart diff --git a/lib/src/common/parameter_parser/analysis_options_loader.dart b/lib/src/common/parameter_parser/analysis_options_loader.dart index b9d7b5be..d6d2f214 100644 --- a/lib/src/common/parameter_parser/analysis_options_loader.dart +++ b/lib/src/common/parameter_parser/analysis_options_loader.dart @@ -1,12 +1,19 @@ import 'package:analyzer/analysis_rule/rule_context.dart'; import 'package:analyzer/file_system/file_system.dart'; import 'package:analyzer/file_system/physical_file_system.dart'; +import 'package:solid_lints/src/common/parameter_parser/cached_package_rules.dart'; import 'package:solid_lints/src/common/parameter_parser/lint_options.dart'; import 'package:yaml/yaml.dart'; /// Loads and parses analysis options from a Dart project's YAML file. class AnalysisOptionsLoader { - final Map> _rulesCache = {}; + final ResourceProvider _resourceProvider; + final Map _rulesCache = {}; + + /// Creates an instance of [AnalysisOptionsLoader] + AnalysisOptionsLoader({ResourceProvider? resourceProvider}) + : _resourceProvider = + resourceProvider ?? PhysicalResourceProvider.INSTANCE; /// Gets the options for a specific rule by its name. LintOptions? getRuleOptions(RuleContext context, String ruleName) { @@ -16,7 +23,7 @@ class AnalysisOptionsLoader { final yamlPath = _findNearestAnalysisOptionsFilePath(packageRootPath); if (yamlPath == null) return null; - return _rulesCache[yamlPath]?[ruleName]; + return _rulesCache[yamlPath]?.rules[ruleName]; } /// Loads lint rules from the analysis options file based @@ -25,32 +32,36 @@ class AnalysisOptionsLoader { final packageRootPath = context.package?.root.path; if (packageRootPath == null) return; - _loadRules(packageRootPath); + _loadRulesIfNewer(packageRootPath); } - void _loadRules(String rootPath) { + void _loadRulesIfNewer(String rootPath) { final yamlPath = _findNearestAnalysisOptionsFilePath(rootPath); + if (yamlPath == null) return; + + final analysisOptionsFile = _resourceProvider.getFile(yamlPath); + final modificationStamp = analysisOptionsFile.modificationStamp; + final cachedRules = _rulesCache[yamlPath]; - if (yamlPath == null || _rulesCache.containsKey(yamlPath)) { + if (cachedRules?.modificationStamp == modificationStamp) { return; } - final analysisOptionsFile = - PhysicalResourceProvider.INSTANCE.getFile(yamlPath); - final rules = _getRules(analysisOptionsFile); - _rulesCache[yamlPath] = rules; + _rulesCache[yamlPath] = CachedPackageRules( + modificationStamp: modificationStamp, + rules: rules, + ); } String? _findNearestAnalysisOptionsFilePath(String packageRootPath) { - final pathContext = PhysicalResourceProvider.INSTANCE.pathContext; + final pathContext = _resourceProvider.pathContext; String currentDirectoryPath = packageRootPath; while (pathContext.dirname(currentDirectoryPath) != currentDirectoryPath) { final candidatePath = pathContext.join(currentDirectoryPath, 'analysis_options.yaml'); - final candidateFile = - PhysicalResourceProvider.INSTANCE.getFile(candidatePath); + final candidateFile = _resourceProvider.getFile(candidatePath); if (candidateFile.exists) { return candidatePath; diff --git a/lib/src/common/parameter_parser/cached_package_rules.dart b/lib/src/common/parameter_parser/cached_package_rules.dart new file mode 100644 index 00000000..dc1f1d07 --- /dev/null +++ b/lib/src/common/parameter_parser/cached_package_rules.dart @@ -0,0 +1,16 @@ +import 'package:solid_lints/src/common/parameter_parser/lint_options.dart'; + +/// Cached rules for a dart package +class CachedPackageRules { + /// The last modification stamp of the analysis options file + final int modificationStamp; + + /// Cached rules options by rule name for the package + final Map rules; + + /// Creates an instance of [CachedPackageRules] + const CachedPackageRules({ + required this.modificationStamp, + required this.rules, + }); +} From 55af03a63ff51c38b85de9c107629585940b7698 Mon Sep 17 00:00:00 2001 From: Andrew Bekhiet Date: Tue, 2 Jun 2026 23:54:32 +0300 Subject: [PATCH 17/24] test: add AnalysisOptionsLoaderTest --- .../analysis_options_loader_test.dart | 229 ++++++++++++++++++ 1 file changed, 229 insertions(+) create mode 100644 test/src/common/parameter_parser/analysis_options_loader_test.dart diff --git a/test/src/common/parameter_parser/analysis_options_loader_test.dart b/test/src/common/parameter_parser/analysis_options_loader_test.dart new file mode 100644 index 00000000..e7df2c4a --- /dev/null +++ b/test/src/common/parameter_parser/analysis_options_loader_test.dart @@ -0,0 +1,229 @@ +import 'package:analyzer/analysis_rule/rule_context.dart'; +import 'package:analyzer/file_system/file_system.dart'; +import 'package:analyzer/workspace/workspace.dart'; +import 'package:analyzer_testing/src/analysis_rule/pub_package_resolution.dart'; +import 'package:solid_lints/src/common/parameter_parser/analysis_options_loader.dart'; +import 'package:test/test.dart'; +import 'package:test_reflective_loader/test_reflective_loader.dart'; + +void main() { + defineReflectiveSuite(() { + defineReflectiveTests(AnalysisOptionsLoaderTest); + }); +} + +@reflectiveTest +class AnalysisOptionsLoaderTest extends PubPackageResolutionTest { + // TODO: use actual [Rule.lintName] after migrating to analyzer_server_plugin + // Can't be used right now because they have compile errors + static const _mockRuleThatNeedsConfigName = 'mock_rule_that_needs_config'; + static const _mockRule2Name = 'mock_rule_2'; + static const _cyclomaticComplexityName = 'cyclomatic_complexity'; + + static const _mockAnalysisOptionsContent = ''' +plugins: + solid_lints: + diagnostics: + $_mockRuleThatNeedsConfigName: + abc: def + $_mockRule2Name: + foo: bar + exclude: + - class_name: MockClass + method_name: mockMethod + $_cyclomaticComplexityName: + max_complexity: 10 + exclude: + - class_name: MockClass + method_name: mockMethod + - method_name: mockMethod2 + '''; + static const _mockDifferentAnalysisOptionsContent = ''' +plugins: + solid_lints: + diagnostics: + $_mockRuleThatNeedsConfigName: + abc: ghi + $_mockRule2Name: + foo: baz + exclude: + - class_name: MockOtherClass + method_name: mockOtherMethod + $_cyclomaticComplexityName: + max_complexity: 20 + exclude: + - class_name: MockOtherClass + method_name: mockOtherMethod + - method_name: mockOtherMethod2 + '''; + + late AnalysisOptionsLoader analysisOptionsLoader; + late RuleContext mockRuleContext; + + @override + void setUp() { + super.setUp(); + + analysisOptionsLoader = + AnalysisOptionsLoader(resourceProvider: resourceProvider); + mockRuleContext = _createMockContextForPackage(testPackageRootPath); + + _writeMockAnalysisOptionsYamlFile(); + + analysisOptionsLoader.loadRulesFromContext(mockRuleContext); + } + + void _writeMockAnalysisOptionsYamlFile() { + newAnalysisOptionsYamlFile( + testPackageRootPath, + _mockAnalysisOptionsContent, + ); + } + + void test_cached_response_is_scoped_to_package_and_rule() { + const otherPackageRootPath = '/home/other'; + + newFolder(otherPackageRootPath); + newPubspecYamlFile(otherPackageRootPath, 'name: other'); + newAnalysisOptionsYamlFile( + otherPackageRootPath, + _mockDifferentAnalysisOptionsContent, + ); + + for (final ruleName in [ + _mockRuleThatNeedsConfigName, + _mockRule2Name, + _cyclomaticComplexityName + ]) { + final currentPackageOptions = analysisOptionsLoader.getRuleOptions( + mockRuleContext, + ruleName, + ); + final otherPackageOptions = analysisOptionsLoader.getRuleOptions( + _createMockContextForPackage(otherPackageRootPath), + ruleName, + ); + + expect( + currentPackageOptions?.json, + isNot(equals(otherPackageOptions?.json)), + ); + } + } + + void test_each_rule_gets_its_options() { + analysisOptionsLoader.loadRulesFromContext(mockRuleContext); + + final mockRuleThatNeedsConfigOptions = analysisOptionsLoader.getRuleOptions( + mockRuleContext, + _mockRuleThatNeedsConfigName, + ); + final mockRule2Options = analysisOptionsLoader.getRuleOptions( + mockRuleContext, + _mockRule2Name, + ); + final cyclomaticComplexityOptions = analysisOptionsLoader.getRuleOptions( + mockRuleContext, + _cyclomaticComplexityName, + ); + + expect(mockRuleThatNeedsConfigOptions, isNotNull); + expect(mockRuleThatNeedsConfigOptions?.enabled, isTrue); + expect(mockRuleThatNeedsConfigOptions?.json, {'abc': 'def'}); + + expect(mockRule2Options, isNotNull); + expect(mockRule2Options?.enabled, isTrue); + expect(mockRule2Options?.json, { + 'foo': 'bar', + 'exclude': [ + {'class_name': 'MockClass', 'method_name': 'mockMethod'}, + ] + }); + + expect(cyclomaticComplexityOptions, isNotNull); + expect(cyclomaticComplexityOptions?.enabled, isTrue); + expect(cyclomaticComplexityOptions?.json, { + 'max_complexity': 10, + 'exclude': [ + {'class_name': 'MockClass', 'method_name': 'mockMethod'}, + {'method_name': 'mockMethod2'}, + ] + }); + } + + void test_invalidates_cache_when_analysis_options_changed() { + final initialOptions = analysisOptionsLoader.getRuleOptions( + mockRuleContext, + _mockRuleThatNeedsConfigName, + ); + + newAnalysisOptionsYamlFile( + testPackageRootPath, + _mockDifferentAnalysisOptionsContent, + ); + analysisOptionsLoader.loadRulesFromContext(mockRuleContext); + + final updatedOptions = analysisOptionsLoader.getRuleOptions( + mockRuleContext, + _mockRuleThatNeedsConfigName, + ); + + expect(initialOptions?.json, {'abc': 'def'}); + expect(updatedOptions?.json, {'abc': 'ghi'}); + expect(updatedOptions, isNot(same(initialOptions))); + } + + void test_loads_and_parses_rule_options_from_yaml_file() { + analysisOptionsLoader.loadRulesFromContext(mockRuleContext); + + final options = analysisOptionsLoader.getRuleOptions( + mockRuleContext, + _mockRuleThatNeedsConfigName, + ); + + expect(options, isNotNull); + expect(options?.enabled, isTrue); + expect(options?.json, {'abc': 'def'}); + } + + void test_returns_cached_response_for_same_rule_name() { + analysisOptionsLoader.loadRulesFromContext(mockRuleContext); + + final firstOptions = analysisOptionsLoader.getRuleOptions( + mockRuleContext, + _mockRuleThatNeedsConfigName, + ); + final secondOptions = analysisOptionsLoader.getRuleOptions( + mockRuleContext, + _mockRuleThatNeedsConfigName, + ); + + expect(secondOptions, same(firstOptions)); + } + + RuleContext _createMockContextForPackage(String packageRootPath) { + return _TestRuleContext( + _TestWorkspacePackage(getFolder(packageRootPath)), + ); + } +} + +class _TestRuleContext implements RuleContext { + @override + final WorkspacePackage? package; + + _TestRuleContext(this.package); + + @override + dynamic noSuchMethod(Invocation invocation) => super.noSuchMethod(invocation); +} + +class _TestWorkspacePackage implements WorkspacePackage { + @override + final Folder root; + + _TestWorkspacePackage(this.root); + + @override + dynamic noSuchMethod(Invocation invocation) => super.noSuchMethod(invocation); +} From 06c53678cd2e93b361ab14299c0d0a29c2174d41 Mon Sep 17 00:00:00 2001 From: Andrew Bekhiet Date: Wed, 3 Jun 2026 21:12:30 +0300 Subject: [PATCH 18/24] feat(SolidLintRule): add parameter parsing refactor: use Map instead of LintOptions as the enabled field is implicitly true for all rules that the analyzer processes remove RuleConfig as it is no longer needed --- .../analysis_options_loader.dart | 43 ++-- .../common/parameter_parser/lint_options.dart | 232 ------------------ lib/src/models/rule_config.dart | 43 ---- lib/src/models/solid_lint_rule.dart | 43 +++- .../analysis_options_loader_test.dart | 30 +-- 5 files changed, 63 insertions(+), 328 deletions(-) delete mode 100644 lib/src/common/parameter_parser/lint_options.dart delete mode 100644 lib/src/models/rule_config.dart diff --git a/lib/src/common/parameter_parser/analysis_options_loader.dart b/lib/src/common/parameter_parser/analysis_options_loader.dart index d6d2f214..b397bb08 100644 --- a/lib/src/common/parameter_parser/analysis_options_loader.dart +++ b/lib/src/common/parameter_parser/analysis_options_loader.dart @@ -2,7 +2,6 @@ import 'package:analyzer/analysis_rule/rule_context.dart'; import 'package:analyzer/file_system/file_system.dart'; import 'package:analyzer/file_system/physical_file_system.dart'; import 'package:solid_lints/src/common/parameter_parser/cached_package_rules.dart'; -import 'package:solid_lints/src/common/parameter_parser/lint_options.dart'; import 'package:yaml/yaml.dart'; /// Loads and parses analysis options from a Dart project's YAML file. @@ -16,7 +15,7 @@ class AnalysisOptionsLoader { resourceProvider ?? PhysicalResourceProvider.INSTANCE; /// Gets the options for a specific rule by its name. - LintOptions? getRuleOptions(RuleContext context, String ruleName) { + Map? getRuleOptions(RuleContext context, String ruleName) { final packageRootPath = context.package?.root.path; if (packageRootPath == null) return null; @@ -26,16 +25,16 @@ class AnalysisOptionsLoader { return _rulesCache[yamlPath]?.rules[ruleName]; } - /// Loads lint rules from the analysis options file based - /// on the provided [RuleContext]. - void loadRulesFromContext(RuleContext context) { + /// Loads lint rules from the analysis options file for all rules + /// using the provided [RuleContext]. + void loadRulesOptionsFromContext(RuleContext context) { final packageRootPath = context.package?.root.path; if (packageRootPath == null) return; - _loadRulesIfNewer(packageRootPath); + _loadRulesOptionsIfNewer(packageRootPath); } - void _loadRulesIfNewer(String rootPath) { + void _loadRulesOptionsIfNewer(String rootPath) { final yamlPath = _findNearestAnalysisOptionsFilePath(rootPath); if (yamlPath == null) return; @@ -74,7 +73,7 @@ class AnalysisOptionsLoader { return null; } - Map _getRules(File? analysisOptionsFile) { + Map> _getRules(File? analysisOptionsFile) { if (analysisOptionsFile == null || !analysisOptionsFile.exists) { return {}; } @@ -87,29 +86,19 @@ class AnalysisOptionsLoader { return {}; } - if (yaml is! Map) return {}; - - final rules = {}; - if (yaml case {'plugins': {'solid_lints': {'diagnostics': final diagnostics?}}} when diagnostics is Map) { - for (final MapEntry(:key, :value) in diagnostics.entries) { - if (key is! String) continue; - - final ruleName = key; - - if (value is bool) { - rules[ruleName] = LintOptions.empty(enabled: value); - } else if (value is Map) { - rules[ruleName] = LintOptions.fromYaml( - Map.from(value), - enabled: true, - ); - } - } + return Map.fromEntries( + diagnostics.entries.where((e) => e.key is String && e.value is Map).map( + (e) => MapEntry( + e.key as String, + Map.from(e.value as Map), + ), + ), + ); } - return rules; + return {}; } } diff --git a/lib/src/common/parameter_parser/lint_options.dart b/lib/src/common/parameter_parser/lint_options.dart deleted file mode 100644 index 7880b42d..00000000 --- a/lib/src/common/parameter_parser/lint_options.dart +++ /dev/null @@ -1,232 +0,0 @@ -// Apache License -// Version 2.0, January 2004 -// http://www.apache.org/licenses/ - -// TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - -// 1. Definitions. - -// "License" shall mean the terms and conditions for use, reproduction, -// and distribution as defined by Sections 1 through 9 of this document. - -// "Licensor" shall mean the copyright owner or entity authorized by -// the copyright owner that is granting the License. - -// "Legal Entity" shall mean the union of the acting entity and all -// other entities that control, are controlled by, or are under common -// control with that entity. For the purposes of this definition, -// "control" means (i) the power, direct or indirect, to cause the -// direction or management of such entity, whether by contract or -// otherwise, or (ii) ownership of fifty percent (50%) or more of the -// outstanding shares, or (iii) beneficial ownership of such entity. - -// "You" (or "Your") shall mean an individual or Legal Entity -// exercising permissions granted by this License. - -// "Source" form shall mean the preferred form for making modifications, -// including but not limited to software source code, documentation -// source, and configuration files. - -// "Object" form shall mean any form resulting from mechanical -// transformation or translation of a Source form, including but -// not limited to compiled object code, generated documentation, -// and conversions to other media types. - -// "Work" shall mean the work of authorship, whether in Source or -// Object form, made available under the License, as indicated by a -// copyright notice that is included in or attached to the work -// (an example is provided in the Appendix below). - -// "Derivative Works" shall mean any work, whether in Source or Object -// form, that is based on (or derived from) the Work and for which the -// editorial revisions, annotations, elaborations, or other modifications -// represent, as a whole, an original work of authorship. For the purposes -// of this License, Derivative Works shall not include works that remain -// separable from, or merely link (or bind by name) to the interfaces of, -// the Work and Derivative Works thereof. - -// "Contribution" shall mean any work of authorship, including -// the original version of the Work and any modifications or additions -// to that Work or Derivative Works thereof, that is intentionally -// submitted to Licensor for inclusion in the Work by the copyright owner -// or by an individual or Legal Entity authorized to submit on behalf of -// the copyright owner. For the purposes of this definition, "submitted" -// means any form of electronic, verbal, or written communication sent -// to the Licensor or its representatives, including but not limited to -// communication on electronic mailing lists, source code control systems, -// and issue tracking systems that are managed by, or on behalf of, the -// Licensor for the purpose of discussing and improving the Work, but -// excluding communication that is conspicuously marked or otherwise -// designated in writing by the copyright owner as "Not a Contribution." - -// "Contributor" shall mean Licensor and any individual or Legal Entity -// on behalf of whom a Contribution has been received by Licensor and -// subsequently incorporated within the Work. - -// 2. Grant of Copyright License. Subject to the terms and conditions of -// this License, each Contributor hereby grants to You a perpetual, -// worldwide, non-exclusive, no-charge, royalty-free, irrevocable -// copyright license to reproduce, prepare Derivative Works of, -// publicly display, publicly perform, sublicense, and distribute the -// Work and such Derivative Works in Source or Object form. - -// 3. Grant of Patent License. Subject to the terms and conditions of -// this License, each Contributor hereby grants to You a perpetual, -// worldwide, non-exclusive, no-charge, royalty-free, irrevocable -// (except as stated in this section) patent license to make, have made, -// use, offer to sell, sell, import, and otherwise transfer the Work, -// where such license applies only to those patent claims licensable -// by such Contributor that are necessarily infringed by their -// Contribution(s) alone or by combination of their Contribution(s) -// with the Work to which such Contribution(s) was submitted. If You -// institute patent litigation against any entity (including a -// cross-claim or counterclaim in a lawsuit) alleging that the Work -// or a Contribution incorporated within the Work constitutes direct -// or contributory patent infringement, then any patent licenses -// granted to You under this License for that Work shall terminate -// as of the date such litigation is filed. - -// 4. Redistribution. You may reproduce and distribute copies of the -// Work or Derivative Works thereof in any medium, with or without -// modifications, and in Source or Object form, provided that You -// meet the following conditions: - -// (a) You must give any other recipients of the Work or -// Derivative Works a copy of this License; and - -// (b) You must cause any modified files to carry prominent notices -// stating that You changed the files; and - -// (c) You must retain, in the Source form of any Derivative Works -// that You distribute, all copyright, patent, trademark, and -// attribution notices from the Source form of the Work, -// excluding those notices that do not pertain to any part of -// the Derivative Works; and - -// (d) If the Work includes a "NOTICE" text file as part of its -// distribution, then any Derivative Works that You distribute must -// include a readable copy of the attribution notices contained -// within such NOTICE file, excluding those notices that do not -// pertain to any part of the Derivative Works, in at least one -// of the following places: within a NOTICE text file distributed -// as part of the Derivative Works; within the Source form or -// documentation, if provided along with the Derivative Works; or, -// within a display generated by the Derivative Works, if and -// wherever such third-party notices normally appear. The contents -// of the NOTICE file are for informational purposes only and -// do not modify the License. You may add Your own attribution -// notices within Derivative Works that You distribute, alongside -// or as an addendum to the NOTICE text from the Work, provided -// that such additional attribution notices cannot be construed -// as modifying the License. - -// You may add Your own copyright statement to Your modifications and -// may provide additional or different license terms and conditions -// for use, reproduction, or distribution of Your modifications, or -// for any such Derivative Works as a whole, provided Your use, -// reproduction, and distribution of the Work otherwise complies with -// the conditions stated in this License. - -// 5. Submission of Contributions. Unless You explicitly state otherwise, -// any Contribution intentionally submitted for inclusion in the Work -// by You to the Licensor shall be under the terms and conditions of -// this License, without any additional terms or conditions. -// Notwithstanding the above, nothing herein shall supersede or modify -// the terms of any separate license agreement you may have executed -// with Licensor regarding such Contributions. - -// 6. Trademarks. This License does not grant permission to use the trade -// names, trademarks, service marks, or product names of the Licensor, -// except as required for reasonable and customary use in describing the -// origin of the Work and reproducing the content of the NOTICE file. - -// 7. Disclaimer of Warranty. Unless required by applicable law or -// agreed to in writing, Licensor provides the Work (and each -// Contributor provides its Contributions) on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or -// implied, including, without limitation, any warranties or conditions -// of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A -// PARTICULAR PURPOSE. You are solely responsible for determining the -// appropriateness of using or redistributing the Work and assume any -// risks associated with Your exercise of permissions under this License. - -// 8. Limitation of Liability. In no event and under no legal theory, -// whether in tort (including negligence), contract, or otherwise, -// unless required by applicable law (such as deliberate and grossly -// negligent acts) or agreed to in writing, shall any Contributor be -// liable to You for damages, including any direct, indirect, special, -// incidental, or consequential damages of any character arising as a -// result of this License or out of the use or inability to use the -// Work (including but not limited to damages for loss of goodwill, -// work stoppage, computer failure or malfunction, or any and all -// other commercial damages or losses), even if such Contributor -// has been advised of the possibility of such damages. - -// 9. Accepting Warranty or Additional Liability. While redistributing -// the Work or Derivative Works thereof, You may choose to offer, -// and charge a fee for, acceptance of support, warranty, indemnity, -// or other liability obligations and/or rights consistent with this -// License. However, in accepting such obligations, You may act only -// on Your own behalf and on Your sole responsibility, not on behalf -// of any other Contributor, and only if You agree to indemnify, -// defend, and hold each Contributor harmless for any liability -// incurred by, or claims asserted against, such Contributor by reason -// of your accepting any such warranty or additional liability. - -// END OF TERMS AND CONDITIONS - -// APPENDIX: How to apply the Apache License to your work. - -// To apply the Apache License to your work, attach the following -// boilerplate notice, with the fields enclosed by brackets "[]" -// replaced with your own identifying information. (Don't include -// the brackets!) The text should be enclosed in the appropriate -// comment syntax for the file format. We also recommend that a -// file or class name and description of purpose be included on the -// same "printed page" as the copyright notice for easier -// identification within third-party archives. - -// Copyright 2020 Invertase Limited - -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at - -// http://www.apache.org/licenses/LICENSE-2.0 - -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -import 'package:analyzer/analysis_rule/analysis_rule.dart'; -import 'package:collection/collection.dart'; - -/// Option information for a specific [AnalysisRule]. -class LintOptions { - /// Whether the configuration enables/disables the lint rule. - final bool enabled; - - /// Extra configurations for a [AnalysisRule]. - final Map json; - - @override - int get hashCode => Object.hash( - enabled, - const MapEquality().hash(json), - ); - - /// Options with no [json] - const LintOptions.empty({required this.enabled}) : json = const {}; - - /// Creates a [LintOptions] from YAML. - const LintOptions.fromYaml(Map yaml, {required this.enabled}) - : json = yaml; - - @override - bool operator ==(Object other) => - other is LintOptions && - other.enabled == enabled && - const MapEquality().equals(other.json, json); -} diff --git a/lib/src/models/rule_config.dart b/lib/src/models/rule_config.dart deleted file mode 100644 index 35c35b96..00000000 --- a/lib/src/models/rule_config.dart +++ /dev/null @@ -1,43 +0,0 @@ -import 'package:analyzer/error/error.dart' as error; -import 'package:custom_lint_builder/custom_lint_builder.dart'; - -/// Type definition of a value factory which allows us to map data from -/// YAML configuration to an object of type [T]. -typedef RuleParameterParser = T Function(Map json); - -/// Type definition for a problem message factory after finding a problem -/// by a given lint. -typedef RuleProblemFactory = String Function(T value); - -/// [RuleConfig] allows us to quickly parse a lint rule and -/// declare basic configuration for it. -class RuleConfig { - /// Constructor for [RuleConfig] model. - RuleConfig({ - required this.name, - required CustomLintConfigs configs, - required RuleProblemFactory problemMessage, - RuleParameterParser? paramsParser, - }) : enabled = configs.rules[name]?.enabled ?? false, - parameters = paramsParser?.call(configs.rules[name]?.json ?? {}) as T, - _problemMessageFactory = problemMessage; - - /// This lint rule represents the error. - final String name; - - /// A flag which indicates whether this rule was enabled by the user. - final bool enabled; - - /// Value with a configuration for a particular rule. - final T parameters; - - /// Factory for generating error messages. - final RuleProblemFactory _problemMessageFactory; - - /// [LintCode] which is generated based on the provided data. - LintCode get lintCode => LintCode( - name: name, - problemMessage: _problemMessageFactory(parameters), - errorSeverity: error.DiagnosticSeverity.WARNING, - ); -} diff --git a/lib/src/models/solid_lint_rule.dart b/lib/src/models/solid_lint_rule.dart index a536eb4f..54f07fd5 100644 --- a/lib/src/models/solid_lint_rule.dart +++ b/lib/src/models/solid_lint_rule.dart @@ -1,16 +1,41 @@ -import 'package:custom_lint_builder/custom_lint_builder.dart'; -import 'package:solid_lints/src/models/rule_config.dart'; +import 'package:analyzer/analysis_rule/analysis_rule.dart'; +import 'package:analyzer/analysis_rule/rule_context.dart'; +import 'package:solid_lints/src/common/parameter_parser/analysis_options_loader.dart'; + +/// A function that parses the rule parameters from analysis options json +typedef RuleParametersParser = T Function(Map); /// A base class for emitting information about /// issues with user's `.dart` files. -abstract class SolidLintRule extends DartLintRule { +abstract class SolidLintRule extends AnalysisRule { + final AnalysisOptionsLoader? _analysisOptionsLoader; + + final RuleParametersParser? _parametersParser; + /// Constructor for [SolidLintRule] model. - SolidLintRule(this.config) : super(code: config.lintCode); + SolidLintRule({ + required super.name, + required super.description, + super.state, + }) : _analysisOptionsLoader = null, + _parametersParser = null; + + /// Constructor for [SolidLintRule] model with parameters. + SolidLintRule.withParameters({ + required AnalysisOptionsLoader analysisOptionsLoader, + required RuleParametersParser parametersParser, + required super.name, + required super.description, + super.state, + }) : _analysisOptionsLoader = analysisOptionsLoader, + _parametersParser = parametersParser; - /// Configuration for a particular rule with all the - /// defined custom parameters. - final RuleConfig config; + /// Reads the rule parameters from analysis options and parses them to [T] + T? getParametersForContext(RuleContext context) { + final unparsedParameters = + _analysisOptionsLoader?.getRuleOptions(context, name); + if (unparsedParameters == null) return null; - /// A flag which indicates whether this rule was enabled by the user. - bool get enabled => config.enabled; + return _parametersParser?.call(unparsedParameters); + } } diff --git a/test/src/common/parameter_parser/analysis_options_loader_test.dart b/test/src/common/parameter_parser/analysis_options_loader_test.dart index e7df2c4a..a727136f 100644 --- a/test/src/common/parameter_parser/analysis_options_loader_test.dart +++ b/test/src/common/parameter_parser/analysis_options_loader_test.dart @@ -70,7 +70,7 @@ plugins: _writeMockAnalysisOptionsYamlFile(); - analysisOptionsLoader.loadRulesFromContext(mockRuleContext); + analysisOptionsLoader.loadRulesOptionsFromContext(mockRuleContext); } void _writeMockAnalysisOptionsYamlFile() { @@ -105,14 +105,14 @@ plugins: ); expect( - currentPackageOptions?.json, - isNot(equals(otherPackageOptions?.json)), + currentPackageOptions, + isNot(equals(otherPackageOptions)), ); } } void test_each_rule_gets_its_options() { - analysisOptionsLoader.loadRulesFromContext(mockRuleContext); + analysisOptionsLoader.loadRulesOptionsFromContext(mockRuleContext); final mockRuleThatNeedsConfigOptions = analysisOptionsLoader.getRuleOptions( mockRuleContext, @@ -128,12 +128,10 @@ plugins: ); expect(mockRuleThatNeedsConfigOptions, isNotNull); - expect(mockRuleThatNeedsConfigOptions?.enabled, isTrue); - expect(mockRuleThatNeedsConfigOptions?.json, {'abc': 'def'}); + expect(mockRuleThatNeedsConfigOptions, {'abc': 'def'}); expect(mockRule2Options, isNotNull); - expect(mockRule2Options?.enabled, isTrue); - expect(mockRule2Options?.json, { + expect(mockRule2Options, { 'foo': 'bar', 'exclude': [ {'class_name': 'MockClass', 'method_name': 'mockMethod'}, @@ -141,8 +139,7 @@ plugins: }); expect(cyclomaticComplexityOptions, isNotNull); - expect(cyclomaticComplexityOptions?.enabled, isTrue); - expect(cyclomaticComplexityOptions?.json, { + expect(cyclomaticComplexityOptions, { 'max_complexity': 10, 'exclude': [ {'class_name': 'MockClass', 'method_name': 'mockMethod'}, @@ -161,20 +158,20 @@ plugins: testPackageRootPath, _mockDifferentAnalysisOptionsContent, ); - analysisOptionsLoader.loadRulesFromContext(mockRuleContext); + analysisOptionsLoader.loadRulesOptionsFromContext(mockRuleContext); final updatedOptions = analysisOptionsLoader.getRuleOptions( mockRuleContext, _mockRuleThatNeedsConfigName, ); - expect(initialOptions?.json, {'abc': 'def'}); - expect(updatedOptions?.json, {'abc': 'ghi'}); + expect(initialOptions, {'abc': 'def'}); + expect(updatedOptions, {'abc': 'ghi'}); expect(updatedOptions, isNot(same(initialOptions))); } void test_loads_and_parses_rule_options_from_yaml_file() { - analysisOptionsLoader.loadRulesFromContext(mockRuleContext); + analysisOptionsLoader.loadRulesOptionsFromContext(mockRuleContext); final options = analysisOptionsLoader.getRuleOptions( mockRuleContext, @@ -182,12 +179,11 @@ plugins: ); expect(options, isNotNull); - expect(options?.enabled, isTrue); - expect(options?.json, {'abc': 'def'}); + expect(options, {'abc': 'def'}); } void test_returns_cached_response_for_same_rule_name() { - analysisOptionsLoader.loadRulesFromContext(mockRuleContext); + analysisOptionsLoader.loadRulesOptionsFromContext(mockRuleContext); final firstOptions = analysisOptionsLoader.getRuleOptions( mockRuleContext, From affc62c2d7dc6cc77d2daafd02303782edf70a84 Mon Sep 17 00:00:00 2001 From: Andrew Bekhiet Date: Thu, 4 Jun 2026 01:33:35 +0300 Subject: [PATCH 19/24] fix: use Map for raw rule config --- lib/src/common/parameter_parser/cached_package_rules.dart | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/lib/src/common/parameter_parser/cached_package_rules.dart b/lib/src/common/parameter_parser/cached_package_rules.dart index dc1f1d07..a65201d9 100644 --- a/lib/src/common/parameter_parser/cached_package_rules.dart +++ b/lib/src/common/parameter_parser/cached_package_rules.dart @@ -1,12 +1,10 @@ -import 'package:solid_lints/src/common/parameter_parser/lint_options.dart'; - /// Cached rules for a dart package class CachedPackageRules { /// The last modification stamp of the analysis options file final int modificationStamp; /// Cached rules options by rule name for the package - final Map rules; + final Map> rules; /// Creates an instance of [CachedPackageRules] const CachedPackageRules({ From 1b10b3def8f1162ad164de4bb849019c4490866e Mon Sep 17 00:00:00 2001 From: Andrew Bekhiet Date: Thu, 4 Jun 2026 01:33:42 +0300 Subject: [PATCH 20/24] fix: method name --- lib/src/lints/avoid_global_state/avoid_global_state_rule.dart | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/src/lints/avoid_global_state/avoid_global_state_rule.dart b/lib/src/lints/avoid_global_state/avoid_global_state_rule.dart index 6586673f..a027f402 100644 --- a/lib/src/lints/avoid_global_state/avoid_global_state_rule.dart +++ b/lib/src/lints/avoid_global_state/avoid_global_state_rule.dart @@ -66,7 +66,7 @@ class AvoidGlobalStateRule extends AnalysisRule { ) { final visitor = AvoidGlobalStateVisitor(this); - _analysisLoader.loadRulesFromContext(context); + _analysisLoader.loadRulesOptionsFromContext(context); // To get the options of the rule: // _analysisLoader.getRuleOptions(context, lintName); From 4c30ac9bf6c10753624ebaac9d11a5af72abc5c3 Mon Sep 17 00:00:00 2001 From: Andrew Bekhiet Date: Thu, 4 Jun 2026 01:34:14 +0300 Subject: [PATCH 21/24] fix: make sure rules options are loaded before getting parameters --- lib/src/models/solid_lint_rule.dart | 2 ++ 1 file changed, 2 insertions(+) diff --git a/lib/src/models/solid_lint_rule.dart b/lib/src/models/solid_lint_rule.dart index 54f07fd5..9f5bee56 100644 --- a/lib/src/models/solid_lint_rule.dart +++ b/lib/src/models/solid_lint_rule.dart @@ -32,6 +32,8 @@ abstract class SolidLintRule extends AnalysisRule { /// Reads the rule parameters from analysis options and parses them to [T] T? getParametersForContext(RuleContext context) { + _analysisOptionsLoader?.loadRulesOptionsFromContext(context); + final unparsedParameters = _analysisOptionsLoader?.getRuleOptions(context, name); if (unparsedParameters == null) return null; From 1cb4497ed14cf3fa2739f9a97f3f7eb0dbe94398 Mon Sep 17 00:00:00 2001 From: Andrew Bekhiet Date: Mon, 8 Jun 2026 23:10:04 +0300 Subject: [PATCH 22/24] refactor: remove unused AnalysisOptionsLoader from AvoidGlobalStateRule refactor: use for loop to register rules --- lib/main.dart | 24 ++++++++++--------- .../avoid_global_state_rule.dart | 9 +------ 2 files changed, 14 insertions(+), 19 deletions(-) diff --git a/lib/main.dart b/lib/main.dart index 087c45c7..e758297e 100644 --- a/lib/main.dart +++ b/lib/main.dart @@ -25,21 +25,23 @@ class SolidLintsPlugin extends Plugin { @override void register(PluginRegistry registry) { final analysisLoader = AnalysisOptionsLoader(); - registry.registerLintRule( - AvoidGlobalStateRule(analysisLoader), - ); - registry.registerLintRule( + + final doubleLiteralFormatRule = DoubleLiteralFormatRule(); + final lintRules = [ + AvoidGlobalStateRule(), AvoidNonNullAssertionRule(), - ); - registry.registerLintRule( AvoidDebugPrintInReleaseRule(), - ); - registry.registerLintRule( + doubleLiteralFormatRule, ProperSuperCallsRule(), - ); + // TODO: Add more lint rules and use analysisLoader + // for rules that need parameters + // For example: `CyclomaticComplexityRule(analysisLoader)` + ]; + + for (final lintRule in lintRules) { + registry.registerLintRule(lintRule); + } - final doubleLiteralFormatRule = DoubleLiteralFormatRule(); - registry.registerLintRule(doubleLiteralFormatRule); for (final code in doubleLiteralFormatRule.diagnosticCodes) { registry.registerFixForRule(code, DoubleLiteralFormatFix.new); } diff --git a/lib/src/lints/avoid_global_state/avoid_global_state_rule.dart b/lib/src/lints/avoid_global_state/avoid_global_state_rule.dart index a027f402..6ee78241 100644 --- a/lib/src/lints/avoid_global_state/avoid_global_state_rule.dart +++ b/lib/src/lints/avoid_global_state/avoid_global_state_rule.dart @@ -2,7 +2,6 @@ import 'package:analyzer/analysis_rule/analysis_rule.dart'; import 'package:analyzer/analysis_rule/rule_context.dart'; import 'package:analyzer/analysis_rule/rule_visitor_registry.dart'; import 'package:analyzer/error/error.dart'; -import 'package:solid_lints/src/common/parameter_parser/analysis_options_loader.dart'; import 'package:solid_lints/src/lints/avoid_global_state/visitors/avoid_global_state_visitor.dart'; /// Avoid top-level and static mutable variables. @@ -47,10 +46,8 @@ class AvoidGlobalStateRule extends AnalysisRule { 'Prefer using final/const or a state management solution.', ); - final AnalysisOptionsLoader _analysisLoader; - /// Creates an instance of [AvoidGlobalStateRule]. - AvoidGlobalStateRule(this._analysisLoader) + AvoidGlobalStateRule() : super( name: lintName, description: 'Avoid top-level or static mutable variables ', @@ -66,10 +63,6 @@ class AvoidGlobalStateRule extends AnalysisRule { ) { final visitor = AvoidGlobalStateVisitor(this); - _analysisLoader.loadRulesOptionsFromContext(context); - // To get the options of the rule: - // _analysisLoader.getRuleOptions(context, lintName); - registry.addTopLevelVariableDeclaration(this, visitor); registry.addFieldDeclaration(this, visitor); } From 0975ba753959393d9ff8ce46ea91ca6a84e3e064 Mon Sep 17 00:00:00 2001 From: Andrew Bekhiet Date: Mon, 8 Jun 2026 23:15:18 +0300 Subject: [PATCH 23/24] refactor: extract duplicate logic --- .../analysis_options_loader.dart | 35 +++++++++++-------- 1 file changed, 20 insertions(+), 15 deletions(-) diff --git a/lib/src/common/parameter_parser/analysis_options_loader.dart b/lib/src/common/parameter_parser/analysis_options_loader.dart index b397bb08..ab22ecc9 100644 --- a/lib/src/common/parameter_parser/analysis_options_loader.dart +++ b/lib/src/common/parameter_parser/analysis_options_loader.dart @@ -15,29 +15,34 @@ class AnalysisOptionsLoader { resourceProvider ?? PhysicalResourceProvider.INSTANCE; /// Gets the options for a specific rule by its name. - Map? getRuleOptions(RuleContext context, String ruleName) { + Map? getRuleOptions(RuleContext context, String ruleName) => + _withNearestAnalysisOptionsFilePathForContext?>( + context, + (path) => _rulesCache[path]?.rules[ruleName], + ); + + /// Loads lint rules from the analysis options file for all rules + /// using the provided [RuleContext]. + void loadRulesOptionsFromContext(RuleContext context) => + _withNearestAnalysisOptionsFilePathForContext( + context, + _loadRulesOptionsIfNewer, + ); + + T? _withNearestAnalysisOptionsFilePathForContext( + RuleContext context, + T Function(String) f, + ) { final packageRootPath = context.package?.root.path; if (packageRootPath == null) return null; final yamlPath = _findNearestAnalysisOptionsFilePath(packageRootPath); if (yamlPath == null) return null; - return _rulesCache[yamlPath]?.rules[ruleName]; + return f(yamlPath); } - /// Loads lint rules from the analysis options file for all rules - /// using the provided [RuleContext]. - void loadRulesOptionsFromContext(RuleContext context) { - final packageRootPath = context.package?.root.path; - if (packageRootPath == null) return; - - _loadRulesOptionsIfNewer(packageRootPath); - } - - void _loadRulesOptionsIfNewer(String rootPath) { - final yamlPath = _findNearestAnalysisOptionsFilePath(rootPath); - if (yamlPath == null) return; - + void _loadRulesOptionsIfNewer(String yamlPath) { final analysisOptionsFile = _resourceProvider.getFile(yamlPath); final modificationStamp = analysisOptionsFile.modificationStamp; final cachedRules = _rulesCache[yamlPath]; From 20d709e50a7b1cf588392c4076d2df9b97ee2d1e Mon Sep 17 00:00:00 2001 From: Andrew Bekhiet Date: Mon, 8 Jun 2026 21:04:37 +0300 Subject: [PATCH 24/24] refactor: migrate avoid_returning_widgets rule feat: also check FunctionDeclarationStatement --- lib/main.dart | 9 +- .../excluded_identifiers_list_parameter.dart | 2 +- .../avoid_returning_widgets_rule.dart | 84 ++--- .../avoid_returning_widgets_parameters.dart | 7 + .../avoid_returning_widgets_visitor.dart | 84 +++++ .../analysis_options.yaml | 11 - .../avoid_returning_widget_test.dart | 96 ------ pubspec.yaml | 1 + .../avoid_returning_widgets_rule_test.dart | 296 ++++++++++++++++++ 9 files changed, 423 insertions(+), 167 deletions(-) create mode 100644 lib/src/lints/avoid_returning_widgets/visitors/avoid_returning_widgets_visitor.dart delete mode 100644 lint_test/avoid_returning_widget_test/analysis_options.yaml delete mode 100644 lint_test/avoid_returning_widget_test/avoid_returning_widget_test.dart create mode 100644 test/src/lints/avoid_returning_widgets/avoid_returning_widgets_rule_test.dart diff --git a/lib/main.dart b/lib/main.dart index e758297e..cc2793e1 100644 --- a/lib/main.dart +++ b/lib/main.dart @@ -4,6 +4,8 @@ import 'package:solid_lints/src/common/parameter_parser/analysis_options_loader. import 'package:solid_lints/src/lints/avoid_debug_print_in_release/avoid_debug_print_in_release_rule.dart'; import 'package:solid_lints/src/lints/avoid_global_state/avoid_global_state_rule.dart'; import 'package:solid_lints/src/lints/avoid_non_null_assertion/avoid_non_null_assertion_rule.dart'; +import 'package:solid_lints/src/lints/avoid_returning_widgets/avoid_returning_widgets_rule.dart'; +import 'package:solid_lints/src/lints/avoid_returning_widgets/models/avoid_returning_widgets_parameters.dart'; import 'package:solid_lints/src/lints/double_literal_format/double_literal_format_rule.dart'; import 'package:solid_lints/src/lints/double_literal_format/fixes/double_literal_format_fix.dart'; import 'package:solid_lints/src/lints/proper_super_calls/proper_super_calls_rule.dart'; @@ -33,9 +35,10 @@ class SolidLintsPlugin extends Plugin { AvoidDebugPrintInReleaseRule(), doubleLiteralFormatRule, ProperSuperCallsRule(), - // TODO: Add more lint rules and use analysisLoader - // for rules that need parameters - // For example: `CyclomaticComplexityRule(analysisLoader)` + AvoidReturningWidgetsRule( + analysisOptionsLoader: analysisLoader, + parametersParser: AvoidReturningWidgetsParameters.fromJson, + ), ]; for (final lintRule in lintRules) { diff --git a/lib/src/common/parameters/excluded_identifiers_list_parameter.dart b/lib/src/common/parameters/excluded_identifiers_list_parameter.dart index 8a4b1097..526201a4 100644 --- a/lib/src/common/parameters/excluded_identifiers_list_parameter.dart +++ b/lib/src/common/parameters/excluded_identifiers_list_parameter.dart @@ -82,7 +82,7 @@ class ExcludedIdentifiersListParameter { final classDeclaration = node.thisOrAncestorOfType(); return classDeclaration != null && - classDeclaration.name.toString() == className; + classDeclaration.namePart.typeName.lexeme == className; } } } diff --git a/lib/src/lints/avoid_returning_widgets/avoid_returning_widgets_rule.dart b/lib/src/lints/avoid_returning_widgets/avoid_returning_widgets_rule.dart index 6bd15911..c90f2d97 100644 --- a/lib/src/lints/avoid_returning_widgets/avoid_returning_widgets_rule.dart +++ b/lib/src/lints/avoid_returning_widgets/avoid_returning_widgets_rule.dart @@ -1,11 +1,9 @@ -import 'package:analyzer/dart/ast/ast.dart'; -import 'package:analyzer/dart/element/type.dart'; -import 'package:analyzer/error/listener.dart'; -import 'package:custom_lint_builder/custom_lint_builder.dart'; +import 'package:analyzer/analysis_rule/rule_context.dart'; +import 'package:analyzer/analysis_rule/rule_visitor_registry.dart'; +import 'package:analyzer/error/error.dart'; import 'package:solid_lints/src/lints/avoid_returning_widgets/models/avoid_returning_widgets_parameters.dart'; -import 'package:solid_lints/src/models/rule_config.dart'; +import 'package:solid_lints/src/lints/avoid_returning_widgets/visitors/avoid_returning_widgets_visitor.dart'; import 'package:solid_lints/src/models/solid_lint_rule.dart'; -import 'package:solid_lints/src/utils/types_utils.dart'; /// A rule which warns about returning widgets from functions and methods. /// @@ -54,64 +52,38 @@ class AvoidReturningWidgetsRule /// This lint rule represents /// the error whether we return a widget. static const lintName = 'avoid_returning_widgets'; - static const _override = 'override'; - AvoidReturningWidgetsRule._(super.config); + static const _code = LintCode( + lintName, + 'Returning a widget from a function is considered an anti-pattern. ' + 'Unless you are overriding an existing method, ' + 'consider extracting your widget to a separate class.', + ); - /// Creates a new instance of [AvoidReturningWidgetsRule] - /// based on the lint configuration. - factory AvoidReturningWidgetsRule.createRule(CustomLintConfigs configs) { - final rule = RuleConfig( - configs: configs, - name: lintName, - paramsParser: AvoidReturningWidgetsParameters.fromJson, - problemMessage: (_) => - 'Returning a widget from a function is considered an anti-pattern. ' - 'Unless you are overriding an existing method, ' - 'consider extracting your widget to a separate class.', - ); + @override + DiagnosticCode get diagnosticCode => _code; - return AvoidReturningWidgetsRule._(rule); - } + /// Creates a new instance of [AvoidReturningWidgetsRule] + AvoidReturningWidgetsRule({ + required super.analysisOptionsLoader, + required super.parametersParser, + }) : super.withParameters( + name: _code.lowerCaseName, + description: _code.problemMessage, + ); @override - void run( - CustomLintResolver resolver, - DiagnosticReporter reporter, - CustomLintContext context, + void registerNodeProcessors( + RuleVisitorRegistry registry, + RuleContext context, ) { - context.registry.addDeclaration((node) { - // Check if declaration is function or method, - // simultaneously checks if return type is [DartType] - final DartType? returnType = switch (node) { - FunctionDeclaration(returnType: TypeAnnotation(:final type?)) || - MethodDeclaration(returnType: TypeAnnotation(:final type?)) => - type, - _ => null, - }; - - if (returnType == null) { - return; - } - - final isWidgetReturned = hasWidgetType(returnType); + super.registerNodeProcessors(registry, context); - final isIgnored = config.parameters.exclude.shouldIgnore(node); + final parameters = getParametersForContext(context) ?? + AvoidReturningWidgetsParameters.empty(); - final isOverriden = switch (node) { - FunctionDeclaration(:final functionExpression) => - functionExpression.parent is MethodDeclaration && - (functionExpression.parent! as MethodDeclaration) - .metadata - .any((m) => m.name.name == _override), - MethodDeclaration(:final metadata) => - metadata.any((m) => m.name.name == _override), - _ => false, - }; + final visitor = AvoidReturningWidgetsVisitor(this, parameters); - if (isWidgetReturned && !isOverriden && !isIgnored) { - reporter.atNode(node, code); - } - }); + registry.addCompilationUnit(this, visitor); } } diff --git a/lib/src/lints/avoid_returning_widgets/models/avoid_returning_widgets_parameters.dart b/lib/src/lints/avoid_returning_widgets/models/avoid_returning_widgets_parameters.dart index 7947ea64..14c27036 100644 --- a/lib/src/lints/avoid_returning_widgets/models/avoid_returning_widgets_parameters.dart +++ b/lib/src/lints/avoid_returning_widgets/models/avoid_returning_widgets_parameters.dart @@ -11,6 +11,13 @@ class AvoidReturningWidgetsParameters { required this.exclude, }); + /// Empty [AvoidReturningWidgetsParameters] model, excludes nothing. + factory AvoidReturningWidgetsParameters.empty() { + return AvoidReturningWidgetsParameters( + exclude: ExcludedIdentifiersListParameter(exclude: []), + ); + } + /// Method for creating from json data factory AvoidReturningWidgetsParameters.fromJson(Map json) { return AvoidReturningWidgetsParameters( diff --git a/lib/src/lints/avoid_returning_widgets/visitors/avoid_returning_widgets_visitor.dart b/lib/src/lints/avoid_returning_widgets/visitors/avoid_returning_widgets_visitor.dart new file mode 100644 index 00000000..b81f4c39 --- /dev/null +++ b/lib/src/lints/avoid_returning_widgets/visitors/avoid_returning_widgets_visitor.dart @@ -0,0 +1,84 @@ +import 'package:analyzer/dart/ast/ast.dart'; +import 'package:analyzer/dart/ast/visitor.dart'; +import 'package:analyzer/dart/element/element.dart'; +import 'package:analyzer/dart/element/type.dart'; +import 'package:solid_lints/src/lints/avoid_returning_widgets/avoid_returning_widgets_rule.dart'; +import 'package:solid_lints/src/lints/avoid_returning_widgets/models/avoid_returning_widgets_parameters.dart'; +import 'package:solid_lints/src/utils/types_utils.dart'; + +/// A visitor that reports on functions that return widgets. +class AvoidReturningWidgetsVisitor extends RecursiveAstVisitor { + final AvoidReturningWidgetsRule _rule; + final AvoidReturningWidgetsParameters _parameters; + + /// Creates a new instance of [AvoidReturningWidgetsVisitor] + AvoidReturningWidgetsVisitor(this._rule, this._parameters); + + @override + void visitFunctionDeclaration(FunctionDeclaration node) { + super.visitFunctionDeclaration(node); + + _visitDeclaration(node); + } + + @override + void visitMethodDeclaration(MethodDeclaration node) { + super.visitMethodDeclaration(node); + + _visitDeclaration(node); + } + + @override + void visitFunctionDeclarationStatement(FunctionDeclarationStatement node) { + super.visitFunctionDeclarationStatement(node); + + _visitDeclaration(node.functionDeclaration); + } + + void _visitDeclaration(Declaration node) { + if (node is! FunctionDeclaration && node is! MethodDeclaration) { + return; + } + + final returnType = switch (node) { + Declaration( + declaredFragment: ExecutableFragment( + element: ExecutableElement(type: FunctionType(:final returnType)) + ) + ) => + returnType, + MethodDeclaration(returnType: TypeAnnotation(:final type)) => type, + FunctionDeclaration(returnType: TypeAnnotation(:final type)) => type, + _ => null, + }; + if (returnType == null) return; + + final isWidgetReturned = hasWidgetType(returnType); + if (!isWidgetReturned) return; + + final isIgnored = _parameters.exclude.shouldIgnore(node); + if (isIgnored) return; + + if (_isOverridden(node)) return; + + _rule.reportAtNode(node); + } + + bool _isOverridden(Declaration node) { + return switch (node) { + Declaration( + declaredFragment: Fragment( + element: Element( + name: final String name, + enclosingElement: final InterfaceElement enclosingElement + ) + ), + ) => + enclosingElement.getInheritedMember( + Name.forLibrary(enclosingElement.library, name), + ) != + null, + _ => false, + }; + } +} diff --git a/lint_test/avoid_returning_widget_test/analysis_options.yaml b/lint_test/avoid_returning_widget_test/analysis_options.yaml deleted file mode 100644 index 0953ea1e..00000000 --- a/lint_test/avoid_returning_widget_test/analysis_options.yaml +++ /dev/null @@ -1,11 +0,0 @@ -analyzer: - plugins: - - ../custom_lint - -custom_lint: - rules: - - avoid_returning_widgets: - exclude: - - class_name: ExcludeWidget - method_name: excludeWidgetMethod - - method_name: excludeMethod diff --git a/lint_test/avoid_returning_widget_test/avoid_returning_widget_test.dart b/lint_test/avoid_returning_widget_test/avoid_returning_widget_test.dart deleted file mode 100644 index ad4398ba..00000000 --- a/lint_test/avoid_returning_widget_test/avoid_returning_widget_test.dart +++ /dev/null @@ -1,96 +0,0 @@ -// ignore_for_file: unused_element, prefer_match_file_name -// ignore_for_file: member_ordering - -/// Check returning a widget fail -/// `avoid_returning_widgets` - -import 'package:flutter/material.dart'; - -// expect_lint: avoid_returning_widgets -Widget avoidReturningWidgets() => const SizedBox(); - -class BaseWidget extends StatelessWidget { - const BaseWidget({super.key}); - - // Not allowed even though overriding it is alllowed - // expect_lint: avoid_returning_widgets - Widget get box => SizedBox(); - - // expect_lint: avoid_returning_widgets - Widget decoratedBox() { - return DecoratedBox(decoration: BoxDecoration()); - } - - @override - Widget build(BuildContext context) { - return const Placeholder(); - } -} - -class MyWidget extends BaseWidget { - const MyWidget({super.key}); - - // expect_lint: avoid_returning_widgets - Widget _test1() => const SizedBox(); - - // expect_lint: avoid_returning_widgets - Widget _test2() { - return const SizedBox( - child: SizedBox(), - ); - } - - // expect_lint: avoid_returning_widgets - Widget get _test3 => const SizedBox(); - - // Allowed - @override - Widget decoratedBox() { - return super.decoratedBox(); - } - - // Allowed - @override - Widget get box => ColoredBox(color: Colors.pink); - - // Allowed - @override - Widget build(BuildContext context) { - return const SizedBox(); - } -} - -// expect_lint: avoid_returning_widgets -Widget build() { - return Offstage(); -} - -// no lint -SizedBox excludeMethod() => const SizedBox(); - -class ExcludeWidget extends StatelessWidget { - const ExcludeWidget({super.key}); - - @override - Widget build(BuildContext context) { - return const Placeholder(); - } - - // no lint - Widget excludeWidgetMethod() => const SizedBox(); - - // expect_lint: avoid_returning_widgets - Widget excludeWidgetMethod2() => const SizedBox(); -} - -class NotExcludeWidget extends StatelessWidget { - const NotExcludeWidget({super.key}); - - @override - Widget build(BuildContext context) { - return const Placeholder(); - } - - // expect_lint: avoid_returning_widgets - Widget excludeWidgetMethod() => const SizedBox(); -} diff --git a/pubspec.yaml b/pubspec.yaml index 7b7dd9b2..b1a226bb 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -20,6 +20,7 @@ dependencies: glob: ^2.1.3 path: ^1.9.1 yaml: ^3.1.3 + # These packages are required for pana analysis to run correctly test: ^1.25.14 dev_dependencies: diff --git a/test/src/lints/avoid_returning_widgets/avoid_returning_widgets_rule_test.dart b/test/src/lints/avoid_returning_widgets/avoid_returning_widgets_rule_test.dart new file mode 100644 index 00000000..f780c3df --- /dev/null +++ b/test/src/lints/avoid_returning_widgets/avoid_returning_widgets_rule_test.dart @@ -0,0 +1,296 @@ +import 'package:analyzer_testing/analysis_rule/analysis_rule.dart'; +import 'package:analyzer_testing/utilities/utilities.dart'; +import 'package:solid_lints/src/common/parameter_parser/analysis_options_loader.dart'; +import 'package:solid_lints/src/lints/avoid_returning_widgets/avoid_returning_widgets_rule.dart'; +import 'package:solid_lints/src/lints/avoid_returning_widgets/models/avoid_returning_widgets_parameters.dart'; +import 'package:test_reflective_loader/test_reflective_loader.dart'; + +void main() { + defineReflectiveSuite(() { + defineReflectiveTests(AvoidReturningWidgetsRuleTest); + }); +} + +@reflectiveTest +class AvoidReturningWidgetsRuleTest extends AnalysisRuleTest { + static const _importFlutterWidgets = "import 'package:flutter/widgets.dart';"; + static const _mockFlutterWidgetsContent = ''' +abstract class Widget { + final String key; + + const Widget({required this.key}); +} + +class StatelessWidget implements Widget { + const StatelessWidget({super.key}); + + @override + Widget build(BuildContext context); +} + +class StatefulWidget implements Widget { + const StatefulWidget({super.key}); + + @override + Widget build(BuildContext context); +} + +abstract interface class BuildContext {} + +class Placeholder extends StatelessWidget { + const Placeholder({super.key}); + + @override + Widget build(BuildContext context) => throw 'unimplemented'; +} + +class SizedBox extends Widget { + final Widget? child; + + const SizedBox({this.child}); + + @override + Widget build(BuildContext context) => child ?? const SizedBox(); +} + +class BoxDecoration extends Widget { + const BoxDecoration(); + + @override + Widget build(BuildContext context) => throw 'unimplemented'; +} + +class DecoratedBox extends Widget { + const DecoratedBox({required this.decoration}); + + final BoxDecoration decoration; + + @override + Widget build(BuildContext context) => throw 'unimplemented'; +} +'''; + static const _mockAnalysisOptionsContent = ''' +plugins: + solid_lints: + diagnostics: + avoid_returning_widgets: + exclude: + - class_name: ExcludeWidget + method_name: excludeWidgetMethod + - method_name: excludeMethod + '''; + + void _addBaseWidgetFile() { + newFile('$testPackageLibPath/base_widget.dart', ''' +$_importFlutterWidgets +class BaseWidget extends StatelessWidget { + const BaseWidget({super.key}); + + Widget get box => SizedBox(); + + Widget decoratedBox() => DecoratedBox(decoration: BoxDecoration()); + + set box(Widget value) { + throw 'unimplemented'; + } +} +'''); + } + + @override + void setUp() { + rule = AvoidReturningWidgetsRule( + analysisOptionsLoader: AnalysisOptionsLoader( + resourceProvider: resourceProvider, + ), + parametersParser: AvoidReturningWidgetsParameters.fromJson, + ); + newPackage('flutter') + ..addFile('lib/widgets.dart', _mockFlutterWidgetsContent); + super.setUp(); + + newAnalysisOptionsYamlFile( + testPackageRootPath, + '''${analysisOptionsContent(rules: [rule.name])} +$_mockAnalysisOptionsContent''', + ); + } + + Future test_reports_on_static_function() async { + await assertDiagnostics( + ''' +$_importFlutterWidgets + +Widget avoidReturningWidgets() => const SizedBox(); + +Widget build() { + return SizedBox(); +} +''', + [lint(40, 51), lint(93, 39)], + ); + } + + Future test_reports_on_methods() async { + await assertDiagnostics( + ''' +$_importFlutterWidgets + +class BaseWidget extends StatelessWidget { + const BaseWidget({super.key}); + + Widget decoratedBox() { + return DecoratedBox(decoration: BoxDecoration()); + } +} +''', + [lint(119, 81)], + ); + } + + Future test_reports_on_getters_but_not_setters() async { + await assertDiagnostics( + ''' +$_importFlutterWidgets + +class BaseWidget extends StatelessWidget { + const BaseWidget({super.key}); + + Widget get box => SizedBox(); + + set box(Widget value) { + throw 'unimplemented'; + } +} +''', + [lint(119, 29)], + ); + } + + Future test_reports_on_private_members() async { + _addBaseWidgetFile(); + + await assertDiagnostics( + ''' +$_importFlutterWidgets +import 'base_widget.dart'; + +class MyWidget extends BaseWidget { + const MyWidget({super.key}); + + Widget _test1() => const SizedBox(); + + Widget _test2() { + return const SizedBox( + child: SizedBox(), + ); + } + + Widget get _test3 => const SizedBox(); + + @override + Widget decoratedBox() { + return super.decoratedBox(); + } + + @override + Widget get box => SizedBox(); + + @override + Widget build(BuildContext context) { + return const SizedBox(); + } +} +''', + [ + lint(137, 36), + lint(177, 80), + lint(261, 38), + ], + ); + } + + Future test_does_not_report_on_overridden_members() async { + _addBaseWidgetFile(); + + // Shouldn't report even if not annotated with @override + await assertNoDiagnostics( + ''' +$_importFlutterWidgets +import 'base_widget.dart'; + +class MyWidget extends BaseWidget { + const MyWidget({super.key}); + + Widget decoratedBox() { + return super.decoratedBox(); + } + + Widget get box => SizedBox(); + + Widget build(BuildContext context) { + return const SizedBox(); + } +} +''', + ); + } + + Future test_does_not_report_on_excluded() async { + await assertNoDiagnostics( + ''' +$_importFlutterWidgets + +SizedBox excludeMethod() => const SizedBox(); + +class ExcludeWidget extends StatelessWidget { + const ExcludeWidget({super.key}); + + @override + Widget build(BuildContext context) { + return const Placeholder(); + } + + Widget excludeWidgetMethod() => const SizedBox(); +} + +''', + ); + } + + Future test_reports_on_non_matching_excluded() async { + await assertDiagnostics( + ''' +$_importFlutterWidgets + +SizedBox excludeMethod() => const SizedBox(); + +class ExcludeWidget extends StatelessWidget { + const ExcludeWidget({super.key}); + + @override + Widget build(BuildContext context) { + return const Placeholder(); + } + + Widget notExcludeWidgetMethod() => const Placeholder(); +} + +class NotExcludeWidget extends StatelessWidget { + const NotExcludeWidget({super.key}); + + @override + Widget build(BuildContext context) { + return const Placeholder(); + } + + Widget excludeWidgetMethod() => const SizedBox(); +} +''', + [ + lint(260, 55), + lint(498, 49), + ], + ); + } +}