Merge pull request #182 from Workiva/final_v2_tweaks

FEDX-8 Last tweaks for v2 rulesets

Author: rmconsole2-wf

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.3.0
+
+- Add `v2` rulesets:
+  - `package:workiva_analysis_options/v2.yaml`
+  - `package:workiva_analysis_options/v2.recommended.yaml`
+
 ## 1.2.5
 
 - CI tweaks.

LICENSE

@@ -1,4 +1,4 @@
-Copyright 2019 Workiva, Inc.
+Copyright 2019-2022 Workiva, Inc.
 
 Redistribution and use in source and binary forms, with or without modification,
 are permitted provided that the following conditions are met:

NOTICE

@@ -1,5 +1,5 @@
 workiva_analysis_options
-Copyright 2019 Workiva, Inc.
+Copyright 2019-2022 Workiva, Inc.
 
 Redistribution and use in source and binary forms, with or without modification,
 are permitted provided that the following conditions are met:

README.md

@@ -1,7 +1,8 @@
 # Workiva's Shared Dart Analysis Options
 
-This is our take on the Dart team's [`pedantic` package][pedantic] and is used
-in all Workiva Dart packages.
+This is our take on the Dart team's [`lints` package][lints] (originally
+inspired by the [`pendantic` package][pedantic]) and is used in all Workiva Dart
+packages.
 
 This package (`package:workiva_analysis_options`) publicly exports
 `analysis_options.yaml` files that can be included in a project's own
@@ -15,7 +16,7 @@ dev_dependencies:
 
 ```yaml
 # analysis_options.yaml
-include: package:workiva_analysis_options/v1.yaml
+include: package:workiva_analysis_options/v2.yaml
 ```
 
 Because most packages don't commit a `pubspec.lock`, CI may fail if updates to
@@ -40,8 +41,8 @@ This enables consumers to depend on this package with a version range like
 
 ## How lints and analyzer rules are evaluated
 
-Periodically, Workiva's Client Platform team will evaluate the available lints
-and rules and attempt to categorize them into one of the following:
+Periodically, Workiva's Dart Community will evaluate the available lints and
+rules and attempt to categorize them into one of the following:
 
 - Required
   - Should provide enough value that it is worth requiring them for all Workiva
@@ -83,7 +84,7 @@ and rules and attempt to categorize them into one of the following:
     investigation/experimentation can be done.
 
 We will use feedback from the Dart developers at Workiva, other similar
-resources (like the [`pedantic` package][pedantic]), and the number of existing
+resources (like the [`lints` package][lints]), and the number of existing
 infractions across Workiva Dart projects (collected automatically) to inform our
 decisions. Each lint has its own issue in this repo that can be used to discuss
 changes and will serve as documentation of context and reasons that influenced
@@ -101,10 +102,6 @@ recommended rules.
 include: package:workiva_analysis_options/v1.recommended.yaml
 ```
 
-_Note: there is also a version provided by this library that includes the
-optional rules, but it is only intended for use in an automated fashion for the
-purpose of gathering data on the number of infractions in Workiva packages._
-
 ## Ensuring adoption of the latest shared options
 
 An automated tool will be integrated into a CI check to verify that Workiva Dart
@@ -127,8 +124,8 @@ It is then expected (and enforced internally at Workiva) that CI and developers
 run analysis in a way that results in a non-zero exit code when errors or
 warnings are present.
 
-With `dartanalyzer`, this means using `--fatal-warnings`. With `tuneup`, this is
-enforced by default.
+With `dartanalyzer`, this means using `--fatal-warnings`. With `dart analyze`
+and `tuneup`, this is enforced by default.
 
 ---
 
@@ -137,4 +134,5 @@ enforced by default.
 [Lints & Rules Table of Contents][lints-toc]
 
 [lints-toc]: https://github.com/Workiva/workiva_analysis_options/issues/2
+[lints]: https://pub.dev/packages/lints
 [pedantic]: https://pub.dev/packages/pedantic

lib/v2.recommended.yaml

@@ -77,16 +77,15 @@ analyzer:
     avoid_positional_boolean_parameters: warning
     avoid_relative_lib_imports: warning
     avoid_renaming_method_parameters: warning
-    avoid_returning_this: warning
-    avoid_returning_null: warning
     avoid_returning_null_for_future: warning
     avoid_returning_null_for_void: warning
+    avoid_returning_null: warning
+    avoid_returning_this: warning
     avoid_setters_without_getters: warning
     avoid_slow_async_io: warning
     avoid_type_to_string: warning
     avoid_types_on_closure_parameters: warning
     avoid_unused_constructor_parameters: warning
-    cascade_invocations: warning
     comment_references: warning
     control_flow_in_finally: warning
     curly_braces_in_flow_control_structures: warning
@@ -96,8 +95,8 @@ analyzer:
     omit_local_variable_types: warning
     overridden_fields: warning
     package_api_docs: warning
-    package_prefixed_library_names: warning
     package_names: warning
+    package_prefixed_library_names: warning
     prefer_adjacent_string_concatenation: warning
     prefer_asserts_in_initializer_lists: warning
     prefer_collection_literals: warning
@@ -106,7 +105,6 @@ analyzer:
     prefer_const_declarations: warning
     prefer_const_literals_to_create_immutables: warning
     prefer_constructors_over_static_methods: warning
-    prefer_typing_uninitialized_variables: warning
     prefer_final_fields: warning
     prefer_final_in_for_each: warning
     prefer_final_locals: warning
@@ -121,9 +119,9 @@ analyzer:
     prefer_null_aware_operators: warning
     prefer_single_quotes: warning
     prefer_spread_collections: warning
+    prefer_typing_uninitialized_variables: warning
     prefer_void_to_null: warning
     provide_deprecation_message: warning
-    sort_pub_dependencies: warning
     sort_unnamed_constructors_first: warning
     test_types_in_equals: warning
     throw_in_finally: warning
@@ -133,14 +131,13 @@ analyzer:
     unnecessary_brace_in_string_interps: warning
     unnecessary_getters_setters: warning
     unnecessary_lambdas: warning
-    unnecessary_parenthesis: warning
     unnecessary_overrides: warning
+    unnecessary_parenthesis: warning
     unnecessary_string_escapes: warning
     unnecessary_string_interpolations: warning
     unnecessary_this: warning
     use_function_type_syntax_for_parameters: warning
     use_rethrow_when_possible: warning
-    use_string_buffers: warning
     use_to_and_as_if_applicable: warning
 
 linter:
@@ -156,16 +153,15 @@ linter:
     - avoid_positional_boolean_parameters
     - avoid_relative_lib_imports
     - avoid_renaming_method_parameters
-    - avoid_returning_this
     - avoid_returning_null
     - avoid_returning_null_for_future
     - avoid_returning_null_for_void
+    - avoid_returning_this
     - avoid_setters_without_getters
     - avoid_slow_async_io
     - avoid_type_to_string
     - avoid_types_on_closure_parameters
     - avoid_unused_constructor_parameters
-    - cascade_invocations
     - comment_references
     - control_flow_in_finally
     - curly_braces_in_flow_control_structures
@@ -175,8 +171,8 @@ linter:
     - omit_local_variable_types
     - overridden_fields
     - package_api_docs
-    - package_prefixed_library_names
     - package_names
+    - package_prefixed_library_names
     - prefer_adjacent_string_concatenation
     - prefer_asserts_in_initializer_lists
     - prefer_collection_literals
@@ -185,7 +181,6 @@ linter:
     - prefer_const_declarations
     - prefer_const_literals_to_create_immutables
     - prefer_constructors_over_static_methods
-    - prefer_typing_uninitialized_variables
     - prefer_final_fields
     - prefer_final_in_for_each
     - prefer_final_locals
@@ -200,9 +195,9 @@ linter:
     - prefer_null_aware_operators
     - prefer_single_quotes
     - prefer_spread_collections
+    - prefer_typing_uninitialized_variables
     - prefer_void_to_null
     - provide_deprecation_message
-    - sort_pub_dependencies
     - sort_unnamed_constructors_first
     - test_types_in_equals
     - throw_in_finally
@@ -212,12 +207,11 @@ linter:
     - unnecessary_brace_in_string_interps
     - unnecessary_getters_setters
     - unnecessary_lambdas
-    - unnecessary_parenthesis
     - unnecessary_overrides
+    - unnecessary_parenthesis
     - unnecessary_string_escapes
     - unnecessary_string_interpolations
     - unnecessary_this
     - use_function_type_syntax_for_parameters
     - use_rethrow_when_possible
-    - use_string_buffers
     - use_to_and_as_if_applicable

lib/v2.yaml

@@ -64,15 +64,15 @@ analyzer:
   errors:
     # Protect against using language features that are incompatible with the
     # minimum SDK version for the current project:
-    sdk_version_async_exported_from_core: warning
     sdk_version_as_expression_in_const_context: warning
+    sdk_version_async_exported_from_core: warning
     sdk_version_bool_operator_in_const_context: warning
     sdk_version_eq_eq_operator_in_const_context: warning
     sdk_version_extension_methods: warning
     sdk_version_is_expression_in_const_context: warning
     sdk_version_set_literal: warning
-    sdk_version_ui_as_code: warning
     sdk_version_ui_as_code_in_const_context: warning
+    sdk_version_ui_as_code: warning
 
     # Promote some builtin hints to warnings:
     can_be_null_after_null_aware: warning
@@ -142,11 +142,16 @@ analyzer:
     unnecessary_null_aware_assignments: warning
     unnecessary_null_in_if_null_operators: warning
     unnecessary_statements: warning
-    unsafe_html: warning
     unrelated_type_equality_checks: warning
+    unsafe_html: warning
     valid_regexps: warning
     void_checks: warning
 
+    # Ignore sorting of pub deps because Workiva packages often have many public
+    # and private dependencies. Interleaving them makes it harder to maintain
+    # than keeping them separate.
+    sort_pub_dependencies: ignore
+
     # Ignore ungenerated uri error:
     # See: <https://github.com/Workiva/over_react/blob/new_boilerplate_wip/doc/new_boilerplate_migration.md#ignore-ungenerated-warnings-project-wide>.
     uri_has_not_been_generated: ignore
@@ -195,7 +200,7 @@ linter:
     - unnecessary_null_aware_assignments
     - unnecessary_null_in_if_null_operators
     - unnecessary_statements
-    - unsafe_html
     - unrelated_type_equality_checks
+    - unsafe_html
     - valid_regexps
     - void_checks