Migrate data source from rules.json to messages.yaml #9

r0227n · 2025-03-19T09:30:02Z

Issue

close [Improve]: Migrate rules.json to messages.yaml #5

Overview (Required)

This pull request includes several changes to the tools/update_lint_rules package, focusing on updating the LintRule model, adding a new JSON converter for State, and modifying the AnalysisOptionsService to use the new State type. The most important changes include the introduction of the State type, the addition of new methods to the RuleState enum, and the updates to the AnalysisOptionsService to filter rules based on the new State type.

Updates to `LintRule` model:

Added nullable fields for categories and details, and replaced RuleState with the new State type in the Rule factory constructor. (tools/update_lint_rules/lib/src/models/lint_rule.dart, tools/update_lint_rules/lib/src/models/lint_rule.dartL24-R25)
Introduced the State type as a typedef for Map<RuleState, Since> and added the _StateJsonConverter class to handle JSON serialization and deserialization for the State type. (tools/update_lint_rules/lib/src/models/lint_rule.dart, tools/update_lint_rules/lib/src/models/lint_rule.dartR104-R119)

Enhancements to `RuleState` enum:

Added internal state to the RuleState enum.
Introduced active and inactive getter methods to determine the activity status of a rule state. (tools/update_lint_rules/lib/src/models/lint_rule.dart, tools/update_lint_rules/lib/src/models/lint_rule.dartR38-R45)

Changes to `AnalysisOptionsService`:

Added an extension method hasMinimumVersion to the State type to check if a rule state meets a minimum Dart SDK version. (tools/update_lint_rules/lib/src/services/analysis_options_service.dart, tools/update_lint_rules/lib/src/services/analysis_options_service.dartR15-R31)
Updated the filtering logic in AnalysisOptionsService to use the new State type and its hasMinimumVersion method. (tools/update_lint_rules/lib/src/services/analysis_options_service.dart, tools/update_lint_rules/lib/src/services/analysis_options_service.dartL37-R64)

Codebase simplification:

Removed unnecessary fields and methods related to description, incompatibles, sets, fixStatus, and since from the Rule class and its related classes and methods. (tools/update_lint_rules/lib/src/models/lint_rule.freezed.dart, [1] [2] [3] [4] [5] [6] [7] [8]
Updated the JSON serialization and deserialization logic in lint_rule.g.dart to reflect the changes in the Rule class. (tools/update_lint_rules/lib/src/models/lint_rule.g.dart, tools/update_lint_rules/lib/src/models/lint_rule.g.dartL17-R50)

Links

Screenshot

N/A

github-actions · 2025-03-19T09:30:15Z

Ready for review 🚀

blendthink

@r0227n
I've left some comments, so please take a look. 🙏

tools/update_lint_rules/lib/src/services/lint_rule_service.dart

tools/update_lint_rules/lib/src/models/lint_rule.dart

r0227n · 2025-03-21T09:26:55Z

@blendthink
Please re-review.
When comparing 3.6/all.yaml before and after the fix, package_api_docs and unsafe_html_attribute are

Before: not included
After modification: included

but we are aware that this is not a problem.

package_api_docs

Before: rules.json

https://github.com/dart-lang/sdk/blob/ae6da8b926f208bf87d2e11375be5c611c27ee1b/pkg/linter/tool/machine/rules.json#L1625-L1638
The value of state key was not output before the correction because it was removed.

After: message.yaml

https://github.com/dart-lang/sdk/blob/ae6da8b926f208bf87d2e11375be5c611c27ee1b/pkg/linter/messages.yaml#L7394-L7399

Because “removed” is 3.7 or later, it is now output in 3.6.

unsafe_html

Before modification: rules.json

Not output because it is not described in the rules.json.

After: message.yaml

https://github.com/dart-lang/sdk/blob/ae6da8b926f208bf87d2e11375be5c611c27ee1b/pkg/linter/messages.yaml#L13330-L13336

The output is output because it is described.

r0227n · 2025-04-02T04:37:55Z

@blendthink
Please re-review.🙇

… to JSON conversion process

…JSON conversion

…rule retrieval process

…ML to JSON within LintRuleService

Rename sourceRuleWithCategories to ruleWithCategories to make the code more concise while maintaining clarity about the variable's role in handling shared rule categories.

…dName and merge data after encoding.

…tCodeDtoMapper

r0227n · 2025-04-10T09:24:27Z

@blendthink
Please re-review.🙇

blendthink

@r0227n
Apologies for the delayed review comment.
Please take a look and leave your comments or make any necessary changes.

tools/update_lint_rules/lib/src/services/lint_rule_service.dart

tools/update_lint_rules/lib/src/services/analysis_options_service.dart

tools/update_lint_rules/lib/src/mappers/lint_code_dto_mapper.dart

blendthink · 2025-04-14T06:23:37Z

tools/update_lint_rules/lib/src/mappers/lint_code_dto_mapper.dart

+  /// Filter [LintCodeDto] by sharedName
+  static Iterable<LintCodeDto> filterLintCodeDtosBySharedName(
+    Iterable<LintCodeDto> dtos,
+  ) {
+    return dtos.where(
+      (dto) =>
+          dto.sharedName == null &&
+          dto.categories != null &&
+          dto.deprecatedDetails != null &&
+          dto.state != null,
+    );
+  }


Since this is not a common/shared process, it might be better for readability not to extract it as a separate method.

always_require_non_null_named_parameters has only state and deprecatedDetails, so executing toRule will result in a FormatException.

Therefore, null safety(e.g details ?? initialValue) or add it to the where condition to exclude it.

There exist values such as iterable_contains_unrelated_type's where state is not null but categories and deprecatedDetails are null.
Therefore, we changed c8191bc to filter sharedName as null and state as not null.

I was mistake.
I deleted state in 7d0b4f9 because the conditions sharedName == null and state != null do not exist.

tools/update_lint_rules/lib/src/mappers/lint_code_dto_mapper.dart

- Remove null-check conditions from where clause when grouping DTOs by sharedName - Allow toRuleFromDtos to handle cases where categories, deprecatedDetails, or state fields are partially missing across grouped DTOs - This ensures proper merging of data from multiple DTOs with the same sharedName

… other than state

r0227n · 2025-04-15T07:00:02Z

I confirmed that always_require_non_null_named_parameters is successfully filtered by state by performing the following check because the state has ”removed“: ‘3.3’.

The value of always_require_non_null_named_parameters is

exists in build/dart/3.2.yaml
Not present in build/dart/3.3.yaml

r0227n · 2025-04-15T07:16:05Z

@blendthink
Please re-review.🙇

#9 (comment)

blendthink

@r0227n
Please take a look and leave your comments or make any necessary changes.

tools/update_lint_rules/lib/src/mappers/lint_code_dto_mapper.dart

…exist, so state is deleted.

…e class instead of dto class

r0227n · 2025-04-15T10:57:07Z

tools/update_lint_rules/lib/src/mappers/lint_code_dto_mapper.dart

+        .map(
+          (dto) => LintCodeDtoMapper.buildRule(
+            name: dto.name,
+            categories: dto.categories ?? const [],


Since data such as always_require_non_null_named_parameters's for which category is null already exists, an empty character is assigned when category is null.

r0227n · 2025-04-16T01:41:54Z

@blendthink
Please re-review.🙇

github-actions bot assigned r0227n Mar 19, 2025

github-actions bot requested review from blendthink, K9i-0, morikann, trm11tkr, Yamasaki-pan961 and YumNumm March 19, 2025 09:30

blendthink reviewed Mar 19, 2025

View reviewed changes

tools/update_lint_rules/lib/src/services/lint_rule_service.dart Outdated Show resolved Hide resolved

tools/update_lint_rules/lib/src/services/lint_rule_service.dart Outdated Show resolved Hide resolved

tools/update_lint_rules/lib/src/models/lint_rule.dart Outdated Show resolved Hide resolved

r0227n and others added 19 commits April 10, 2025 12:33

feat: Change Rule property for yaml

4b904de

feat: Change information source from json to yaml

0a2c195

chor: Move convertToJsonFromYaml method into getRules method

c3f612c

fix: Add dependencies and remove ignore

755424d

fix: state and categories no longer output non-existent values.

032279a

chore: Minimized roop processing

17c63a1

add: convertToJsonFromYaml method test code

25b02fd

refactor: simplify convertToJsonFromYaml method and optimize YAML map…

a4a2a98

… to JSON conversion process

feat: add toJson extension method to YamlMap to simplify YAML map to …

cf2a1ea

…JSON conversion

fix: add exception handling for non-YamlMap entry values and improve …

2e51eff

…rule retrieval process

test: add unit tests for YamlMap's toJson method

67c16ff

refactor: remove convertToJsonFromYaml method and directly convert YA…

3e1ee91

…ML to JSON within LintRuleService

fix: typo ( exsistsCategories → existsCategories )

4ee2737

docs: add example YAML data to explain shared rule categories

67b2bde

refactor: rename variable to better reflect its purpose

aead3af

Rename sourceRuleWithCategories to ruleWithCategories to make the code more concise while maintaining clarity about the variable's role in handling shared rule categories.

docs: add comment explaining rule addition conditions

9188e2c

add: Create DTO for LintCode

d1be457

refactor: Changed to separate processing by presence/absence of Share…

6341baa

…dName and merge data after encoding.

refactor: Sort output results alphabetically

e6214a1

r0227n added 5 commits April 10, 2025 16:34

refactor: extract grouping and filtering logic for LintCodeDto to Lin…

b0db03a

…tCodeDtoMapper

delete: canConvertToRule

2895b6c

refactor: delegate rule conversion logic to LintCodeDtoMapper

c32423f

test: update state assertions in LintCodeDtoMapper tests

388411b

refactor: simplify mapping of LintCodeDto to Rule in toRules method

64d2fa9

r0227n added 2 commits April 14, 2025 16:37

chore: Cancel the modifications made in 0a2c195

9ada809

chore ; LintCodeDto grouping process is no longer a function cutout.

2edc37d

blendthink reviewed Apr 14, 2025

View reviewed changes

r0227n added 9 commits April 14, 2025 19:11

refacotr: Delete toRuleFromDtos and merge toRule

9bce333

chore: Remove the where condition “state is only active”.

da2e1fc

fix: Fixed to consider active/inactive and determine if version supports

1ccc1c2

chore: Fix the where condition because some values have no properties…

c8191bc

… other than state

chore: Move ExtState to a file defined by State

de3e1ec

add: visibleForTesting annotation

7711233

fix: Fix tests as mapper class is modified.

2bd92cc

chore: remove incorrect visibleForTesting annotation

535e765

blendthink reviewed Apr 15, 2025

View reviewed changes

r0227n added 2 commits April 15, 2025 19:09

fix: The condition sharedName is null and state is not null does not …

7d0b4f9

…exist, so state is deleted.

refactor: Rewrote method to directly assign parameters and create Rul…

763e64c

…e class instead of dto class

r0227n commented Apr 15, 2025

View reviewed changes

r0227n added 5 commits April 16, 2025 09:16

rename: Rename mapper class & method

ff06585

chore: Modified test cases due to function argument changes

7f37d0f

chore: Support for renaming staging leaks

a7c019a

add: Correction of forgetting to add required

973b4a1

chore: The “categories ? []” in the comments for the reason.

8ff0798

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migrate data source from rules.json to messages.yaml #9

Migrate data source from rules.json to messages.yaml #9

r0227n commented Mar 19, 2025

github-actions bot commented Mar 19, 2025

blendthink left a comment

r0227n commented Mar 21, 2025 •

edited

Loading

r0227n commented Apr 2, 2025

r0227n commented Apr 10, 2025

blendthink left a comment

blendthink Apr 14, 2025

r0227n Apr 14, 2025

r0227n Apr 15, 2025

r0227n Apr 15, 2025

r0227n commented Apr 15, 2025

r0227n commented Apr 15, 2025

blendthink left a comment

r0227n Apr 15, 2025

r0227n commented Apr 16, 2025

Migrate data source from rules.json to messages.yaml #9

Are you sure you want to change the base?

Migrate data source from rules.json to messages.yaml #9

Conversation

r0227n commented Mar 19, 2025

Issue

Overview (Required)

Updates to LintRule model:

Enhancements to RuleState enum:

Changes to AnalysisOptionsService:

Codebase simplification:

Links

Screenshot

github-actions bot commented Mar 19, 2025

blendthink left a comment

Choose a reason for hiding this comment

r0227n commented Mar 21, 2025 • edited Loading

package_api_docs

Before: rules.json

After: message.yaml

unsafe_html

Before modification: rules.json

After: message.yaml

r0227n commented Apr 2, 2025

r0227n commented Apr 10, 2025

blendthink left a comment

Choose a reason for hiding this comment

blendthink Apr 14, 2025

Choose a reason for hiding this comment

r0227n Apr 14, 2025

Choose a reason for hiding this comment

r0227n Apr 15, 2025

Choose a reason for hiding this comment

r0227n Apr 15, 2025

Choose a reason for hiding this comment

r0227n commented Apr 15, 2025

r0227n commented Apr 15, 2025

blendthink left a comment

Choose a reason for hiding this comment

r0227n Apr 15, 2025

Choose a reason for hiding this comment

r0227n commented Apr 16, 2025

Updates to `LintRule` model:

Enhancements to `RuleState` enum:

Changes to `AnalysisOptionsService`:

r0227n commented Mar 21, 2025 •

edited

Loading