Feature/member ordering #51

DenisBogatirov · 2023-09-14T16:18:13Z

Added member-ordering rule and implemented tests

lib/lints/member_ordering/models/field_member_group.dart

yurii-prykhodko-solid · 2023-09-15T09:00:00Z

lint_test/member_ordering_test.dart

+  State<AWidget> createState() => _AWidgetState();
+}
+
+class _AWidgetState extends State<AWidget> {


Needs more fleshed-out testcases. Private fields, private methods, static members.
It would be much better to have all that we enforce here.

Added more. But technically we can't test all because it has named-method pattern so it's possible to have config like

-a-method -b-method -c-method -d-method ...

I agree that testing all is not viable, but I would still ask for more.

Let's structure the tests a bit. Here's what I think will be helpful:

One all-positive case where we should see no lints at all.

One negative case with all ticks triggered.

One semi-negative case that would check that we can detect one isolated lint without triggering anything unrelated.

I'd also create two separate sets of tests for regular classes and for widgets, so there'll be 6 classes.

I also see some code that would enforce alphabetic order and alphabetic-by-type order. I don't see any tests for that -- just a couple basic ones will suffice.

I can't test them both because you can pass only one of them at analysis_options.yaml will add for alphabetical.

If we can't test it -- then it doesn't work. Let's try to find a way.
One option would be to create a subdir with its own analysis_options.yaml file -- but I'm not sure custom_lint handles such nesting well. Give it a test.
We can also create a completely separate package with its own config, with no nesting. A bit ugly, but at least we'll have it tested.
I don't think this will be the last rule with potentially conflicting configs.

Cannot open file, path = 'solid_lints/lint_test/alphabetize_by_type_test/pubspec.yaml' custom_lints forces a pubspec.yaml file.

yurii-prykhodko-solid

LGTM!

# Conflicts: # lib/solid_lints.dart # lint_test/analysis_options.yaml

* Add required models for member-ordering rule * Add member-ordering rule * Add MIT License comments * Fix parser type mismatch * Add tests for member-ordering and enable rule * Organize imports, ignore member-ordering in unrelated test * Group *_member_group.dart into one directory * Add more test cases * Add more test cases * Add alphabetize test cases * Add tests for alphabetical-by-type option * Ignore no-empty-block in test * Ignore member-ordering in test --------- Co-authored-by: Denis Bogatirov <denis.bohatyrov@computools.com>

* Bump version to `0.1.0` * Pull changes from `solid-metrics` repository * Update .gitignore Co-authored-by: Yuri Prykhodko <40931732+solid-yuriiprykhodko@users.noreply.github.com> * Update example/lib/solid_lints_example.dart Co-authored-by: Yuri Prykhodko <40931732+solid-yuriiprykhodko@users.noreply.github.com> * Update `CHANGELOG.md` * Add code checks with GitHub Actions * Add support for the number of parameters metric * Remove DCM references * Change lint message * Simplify configuration and remove redundant code * Fix code comments * Add missing tests * Add `lines_of_code` lint * Fix rule name * Add test and fix an edge case * Update lint to match the specification * Add `avoid_non_null_assertion` lint * Add missing comment * Add `avoid_late_keyword` lint * Update problem message * Add `avoid_global_state` lint * Fix failing tests * Add `avoid_returning_widgets` lint * Use pattern-matching * Simplify `isWidgetReturned` * Update lib/lints/avoid_returning_widgets/avoid_returning_widgets_rule.dart Co-authored-by: Yuri Prykhodko <40931732+solid-yuriiprykhodko@users.noreply.github.com> * Cleanup of `getLintRules` * Fix comment * rename MetricRule -> RuleConfig * add a sceleton for the double-literal-format rule * implement the double-literal-format rule * fix review warnings * implement quick-fix for the double-literal-format rule * fix lint warnings * add avoid-unnecessary-type-assertions rule ('is' part) * fix lint warning * add avoid-unnecessary-type-assertions rule ('whereType' part) * add quick-fix for unnecessary operator is * add quick-fix for unnecessary whereType * fix review warnings; fix a bug * add utility class for type chekcking methods * add constants for is and whereType names * add needed comments * rewrite _isUnnecessaryWhereType with pattern matching * rewrite _areGenericsWithSameTypeArgs with pattern matching * refactoring: move a castTypeInHierarchy to TypeCast class * implement "avoid unnecessary setstate" rule (#44) * implement "avoid unnecessary setstate" rule * fix pr comments * added idea files to gitignore * fix pr comments * Fix merge conflict * Fix tests and improve GitHub workflow * Fix workflow file * Fix conflicts after merge * Remove non-existing import * Add missing rule to tests and remove unnecessary GitHub actions step --------- Co-authored-by: Yaroslav Laptiev <yaroslav.laptiev@wmg.com> Co-authored-by: vladimir-beloded <x-volodymyr.beloded@transcarent.com> * Add avoid_unnecessary_type_casts_rule * Refactor types_utils, extract common methods * Add fix for avoid_unnecessary_type_casts_rule * Add AvoidUnnecessaryTypeCastsRule.createRule to solid_lints.dart * Fix 'quickFix' for avoid-unnecessary-type-casts * Add tests for avoid-unnecessary-type-casts * Fix formatting * Add more test cases * Group code for more readability * Switch to getters, refactor areGenericsWithSameTypeArgs * Avoid unrelated type assertions (#48) * Add avoid-unrelated-type-assertions rule * Add tests for avoid-unrelated-type-assertions rule --------- Co-authored-by: Denis Bogatirov <denis.bohatyrov@computools.com> * Feature/newline before return (#52) * Add newline-before-return rule * Fix typos, remove unnecessary negation * Add tests for newline-before-return --------- Co-authored-by: Denis Bogatirov <denis.bohatyrov@computools.com> * Fixes Issue #54 multiple rule reporting (#55) * Fix newline-before-return * Fix avoid-unrelated-type-assertions * Fix avoid-unnecessary-type-casts --------- Co-authored-by: Denis Bogatirov <denis.bohatyrov@computools.com> * Feature/no empty block (#53) * Add no-empty-block rule * Add tests no-empty-block rule * Add cyclomatic tests case, fix formatting --------- Co-authored-by: Denis Bogatirov <denis.bohatyrov@computools.com> * Add no equal then else rule (#56) * Add no-equal-then-else rule * Add tests for no-equal-then-else rule --------- Co-authored-by: Denis Bogatirov <denis.bohatyrov@computools.com> * Feature/member ordering (#51) * Add required models for member-ordering rule * Add member-ordering rule * Add MIT License comments * Fix parser type mismatch * Add tests for member-ordering and enable rule * Organize imports, ignore member-ordering in unrelated test * Group *_member_group.dart into one directory * Add more test cases * Add more test cases * Add alphabetize test cases * Add tests for alphabetical-by-type option * Ignore no-empty-block in test * Ignore member-ordering in test --------- Co-authored-by: Denis Bogatirov <denis.bohatyrov@computools.com> * Add avoid unused parameters rule (#49) * Add avoid-unused-parameters rule * Add tests for avoid-unused-parameters rule * Fix function name, remove null check operator and remove negation * Fix multiple reporting * Add more test cases * Fix formatting * Rename method * Add constructors and factories unused params handling * Fix constructors with named field parameters * Simplify rule run method * Fix tests * Fix tests after merge * Fix tests after merge --------- Co-authored-by: Denis Bogatirov <denis.bohatyrov@computools.com> * Added no magic number rule (#57) * Add no-magic-number rule * Add tests for no-magic-number rule * Fix import lost in merge * Ignore no-magic-number in test --------- Co-authored-by: Denis Bogatirov <denis.bohatyrov@computools.com> * Added prefer condtional expressions rule and fix (#59) * Add prefer-conditional-expressions rule and fix * Add tests for prefer-conditional-expressions rule * fix nested test plugin path * Fix tests after merge * Update lint_test/prefer_conditional_expressions_ignore_nested_test/prefer_conditional_expressions_ignore_nested_test.dart --------- Co-authored-by: Denis Bogatirov <denis.bohatyrov@computools.com> Co-authored-by: Yurii Prykhodko <144313329+yurii-prykhodko-solid@users.noreply.github.com> * Added prefer first rule (#60) * Add prefer-conditional-expressions rule and fix * Add tests for prefer-conditional-expressions rule * fix nested test plugin path * Fix tests after merge * Add prefer-first rule and fix * Add tests for prefer-first rule --------- Co-authored-by: Denis Bogatirov <denis.bohatyrov@computools.com> Co-authored-by: Yurii Prykhodko <144313329+yurii-prykhodko-solid@users.noreply.github.com> * Add prefer last rule (#61) * Add prefer-conditional-expressions rule and fix * Add tests for prefer-conditional-expressions rule * fix nested test plugin path * Fix tests after merge * Add prefer-first rule and fix * Add tests for prefer-first rule * Add prefer-last rule & fix * Add tests for prefer-last rule --------- Co-authored-by: Denis Bogatirov <denis.bohatyrov@computools.com> Co-authored-by: Yurii Prykhodko <144313329+yurii-prykhodko-solid@users.noreply.github.com> * Add prefer match file name (#62) * Add prefer-conditional-expressions rule and fix * Add tests for prefer-conditional-expressions rule * fix nested test plugin path * Fix tests after merge * Add prefer-first rule and fix * Add tests for prefer-first rule * Add prefer-last rule & fix * Add tests for prefer-last rule * Add prefer-match-file-name rule * Add tests for prefer-match-file-name rule * Typos, naming * Typos, naming * rm todo comment * Update lint_test/prefer_match_file_name_test.dart * Update lint_test/prefer_match_file_name_test.dart --------- Co-authored-by: Denis Bogatirov <denis.bohatyrov@computools.com> Co-authored-by: Yurii Prykhodko <144313329+yurii-prykhodko-solid@users.noreply.github.com> Co-authored-by: Yurii Prykhodko <yurii.prykhodko@solid.software> * Rename custom lints to use snake_case (#66) * Rename custom lints to use snake_case * Rename missed parameter --------- Co-authored-by: vladimir-beloded <x-volodymyr.beloded@transcarent.com> * Take into account the constructor initializer in the avoid_unused_parameters rule (#67) Co-authored-by: vladimir-beloded <x-volodymyr.beloded@transcarent.com> * Fix linter issues * Bump custom_lint_builder version * Update LICENSE to include third party code license * Allow magic numbers for default values (#72) * Allow magic numbers for default values * More tests --------- Co-authored-by: vladimir-beloded <x-volodymyr.beloded@transcarent.com> * Ignore magic number in constructor initializer (#73) * Ignore magic number in constructor initializer * Minor naming improvement --------- Co-authored-by: vladimir-beloded <x-volodymyr.beloded@transcarent.com> * Remove DCM steps from readme * Fix avoid-late if initialized (#71) * Implement proper-super-calls (#77) * Fix avoid-late if initialized * Update lint_test/avoid_late_keyword_test.dart Co-authored-by: Yurii Prykhodko <144313329+yurii-prykhodko-solid@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Yurii Prykhodko <144313329+yurii-prykhodko-solid@users.noreply.github.com> * Custom avoid-late * Fix naming * Apply suggestions from code review Co-authored-by: Yurii Prykhodko <144313329+yurii-prykhodko-solid@users.noreply.github.com> * Avoid late simplified * Update lib/lints/avoid_late_keyword/models/avoid_late_keyword_parameters.dart Co-authored-by: Yurii Prykhodko <144313329+yurii-prykhodko-solid@users.noreply.github.com> * Avoid-late ignored_types * Avoid-late ignored_types formatted * Update lib/lints/avoid_late_keyword/models/avoid_late_keyword_parameters.dart Co-authored-by: Yurii Prykhodko <144313329+yurii-prykhodko-solid@users.noreply.github.com> * Avoid-late ignored_types fix * Avoid-late ignored_types Fix * Avoid-late allow_initialized testcases * Update lint_test/avoid_late_keyword_allow_initialized_test/pubspec.yaml Co-authored-by: Yurii Prykhodko <144313329+yurii-prykhodko-solid@users.noreply.github.com> * Update lib/lints/avoid_late_keyword/models/avoid_late_keyword_parameters.dart Co-authored-by: Yurii Prykhodko <144313329+yurii-prykhodko-solid@users.noreply.github.com> * Allow subclasses for avoid-late whitelist * Fix naming * Short-circuit of there's no ignored types * Short-circuit earlier * Update lib/lints/avoid_late_keyword/avoid_late_keyword_rule.dart Co-authored-by: Yurii Prykhodko <144313329+yurii-prykhodko-solid@users.noreply.github.com> * Avoid-late ignored_types tests * Avoid-late add testcases * Proper-super-calls impl * Proper-super-calls format * Apply suggestions from code review Co-authored-by: Yurii Prykhodko <144313329+yurii-prykhodko-solid@users.noreply.github.com> * Proper-super-calls refactoring * Update lib/lints/proper_super_calls/proper_super_calls_rule.dart Co-authored-by: Yurii Prykhodko <144313329+yurii-prykhodko-solid@users.noreply.github.com> * Proper-super-keyword annotation check * Proper-super-keyword format * Proper-super-calls cleanup --------- Co-authored-by: Yurii Prykhodko <144313329+yurii-prykhodko-solid@users.noreply.github.com> Co-authored-by: Yurii Prykhodko <yurii.prykhodko@solid.software> * Ignore magic numbers in widget parameters (#74) * Ignore magic numbers in widget parameters * Add lint parameter to ignore magic numbers in widget params * Improve the allowed_in_widget_params parameter to exclude magic numbers in nested objects of Widget parameters * Add tests for disabled allowed_in_widget_params lint parameter * Remove unnecessary dependency --------- Co-authored-by: vladimir-beloded <x-volodymyr.beloded@transcarent.com> * Set default severity level to warning (#78) Co-authored-by: vladimir-beloded <x-volodymyr.beloded@transcarent.com> --------- Co-authored-by: Nikodem Bernat <n.bernat@outlook.com> Co-authored-by: Vadym Khokhlov <xvadima@ukr.net> Co-authored-by: Yaroslav <43727448+laptevw@users.noreply.github.com> Co-authored-by: Yaroslav Laptiev <yaroslav.laptiev@wmg.com> Co-authored-by: vladimir-beloded <x-volodymyr.beloded@transcarent.com> Co-authored-by: Denis Bogatirov <denis.bohatyrov@computools.com> Co-authored-by: DenisBogatirov <denis.bogatirov@gmail.com> Co-authored-by: Yurii Prykhodko <144313329+yurii-prykhodko-solid@users.noreply.github.com> Co-authored-by: solid-vovabeloded <41615621+solid-vovabeloded@users.noreply.github.com> Co-authored-by: Illia Romanenko <442086+illia-romanenko@users.noreply.github.com> Co-authored-by: maxxlab <42914015+maxxlab@users.noreply.github.com>

Denis Bogatirov added 6 commits September 14, 2023 18:36

Add required models for member-ordering rule

2ff3805

Add member-ordering rule

4d5fb0f

Add MIT License comments

a94c211

Fix parser type mismatch

3627056

Add tests for member-ordering and enable rule

6175a54

Organize imports, ignore member-ordering in unrelated test

154a0fc

yurii-prykhodko-solid requested changes Sep 15, 2023

View reviewed changes

Denis Bogatirov added 2 commits September 15, 2023 13:15

Group *_member_group.dart into one directory

5fc27b3

Add more test cases

0908b38

DenisBogatirov requested a review from yurii-prykhodko-solid September 15, 2023 10:30

Denis Bogatirov added 3 commits September 15, 2023 15:01

Add more test cases

9582c50

Add alphabetize test cases

21c1a72

Add tests for alphabetical-by-type option

400cca1

yurii-prykhodko-solid approved these changes Sep 15, 2023

View reviewed changes

Denis Bogatirov added 3 commits September 15, 2023 16:46

Merge branch 'release-v0.1.0' into feature/member-ordering

ca48f06

# Conflicts: # lib/solid_lints.dart # lint_test/analysis_options.yaml

Ignore no-empty-block in test

eaaf6e5

Ignore member-ordering in test

e5295a8

yurii-prykhodko-solid merged commit 6f29f0e into solid-software:release-v0.1.0 Sep 15, 2023
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/member ordering #51

Feature/member ordering #51

DenisBogatirov commented Sep 14, 2023

yurii-prykhodko-solid Sep 15, 2023

DenisBogatirov Sep 15, 2023

yurii-prykhodko-solid Sep 15, 2023

DenisBogatirov Sep 15, 2023

yurii-prykhodko-solid Sep 15, 2023 •

edited

Loading

DenisBogatirov Sep 15, 2023

yurii-prykhodko-solid Sep 15, 2023

DenisBogatirov Sep 15, 2023

yurii-prykhodko-solid left a comment

Feature/member ordering #51

Feature/member ordering #51

Conversation

DenisBogatirov commented Sep 14, 2023

yurii-prykhodko-solid Sep 15, 2023

Choose a reason for hiding this comment

DenisBogatirov Sep 15, 2023

Choose a reason for hiding this comment

yurii-prykhodko-solid Sep 15, 2023

Choose a reason for hiding this comment

DenisBogatirov Sep 15, 2023

Choose a reason for hiding this comment

yurii-prykhodko-solid Sep 15, 2023 • edited Loading

Choose a reason for hiding this comment

DenisBogatirov Sep 15, 2023

Choose a reason for hiding this comment

yurii-prykhodko-solid Sep 15, 2023

Choose a reason for hiding this comment

DenisBogatirov Sep 15, 2023

Choose a reason for hiding this comment

yurii-prykhodko-solid left a comment

Choose a reason for hiding this comment

yurii-prykhodko-solid Sep 15, 2023 •

edited

Loading