Document migration from pedantic

[srawlins]

I think this could go in a snippet in the README or something.

When a dev uses pedantic for their lints, they are "protected" from a list of violations; let's say lint rules A, B, and C. Then when they migrate to the lints package, they are now protected against lint rules B, C, and D. They have "lost" that protection from rule A, which maybe they wish to keep. It looks like this is the diff between pedantic 1.11 and lints 1.0.1:

• 29 added:
  1. avoid_empty_else
  2. avoid_function_literals_in_foreach_calls
  3. avoid_renaming_method_parameters
  4. avoid_returning_null_for_void
  5. camel_case_types
  6. constant_identifier_names
  7. control_flow_in_finally
  8. empty_statements
  9. exhaustive_cases
  10. file_names
  11. hash_and_equals
  12. implementation_imports
  13. iterable_contains_unrelated_type
  14. list_remove_unrelated_type
  15. non_constant_identifier_names
  16. overridden_fields
  17. package_names
  18. package_prefixed_library_names
  19. prefer_function_declarations_over_variables
  20. prefer_initializing_formals
  21. prefer_is_not_operator
  22. prefer_null_aware_operators
  23. prefer_typing_uninitialized_variables
  24. prefer_void_to_null
  25. provide_deprecation_message
  26. unnecessary_overrides
  27. unnecessary_string_escapes
  28. unnecessary_string_interpolations
  29. void_checks
• 6 removed:
  1. always_declare_return_types
  2. prefer_single_quotes
  3. sort_child_properties_last
  4. unawaited_futures
  5. unsafe_html
  6. use_full_hex_values_for_flutter_colors

[srawlins]

CC @pq

[pq]

Thanks for this! I think it's not quite as bad as this (luckily) and a bunch of these (like valid_regexps) are actually in the core set which is included by recommended.yaml.

[pq]

Related: flutter/website#5749 (for Flutter lints migration).

[srawlins]

Ah I see; I was just diffing the literal yaml files

[srawlins]

Ok updated the list above; now 29 added and 6 removed when migrating. Should I send a PR adding a little section to the README, near the end? I think we only need to list the removed ones...

[pq]

That would be great @srawlins !

[davidmorgan]

Thanks!

Apart from prefer_single_quotes and unsafe_html, those look like things we'll probably end up recommending in some form. So the delta should narrow, I think.

[pq]

Regarding general migration instructions, I'd recommend cribbing off what @goderbauer put together here: flutter/website#5749. Good stuff!