Migration guide for package:flutter_lints by goderbauer · Pull Request #5749 · flutter/website

goderbauer · 2021-05-06T21:58:23Z

Pre-work for this PR is done:

package:flutter_lint has published a stable version 1.0.0
Integrate package:flutter_lints into templates flutter#81417 is merged
This PR is updated with the Flutter version number which contains Integrate package:flutter_lints into templates flutter#81417

goderbauer · 2021-05-06T22:08:46Z

pq · 2021-05-06T23:24:42Z

src/docs/release/breaking-changes/flutter-lints-package.md

+## Summary
+
+The [`package:flutter_lints`][] defines the latest set of recommended lints that
+encourage good coding practises for Flutter apps, packages, and plugins. Projects


I think this should be "practices".

Correct, we use American English, not British English on our developer sites: https://developers.google.com/style/spelling?hl=en. :D

Yes, definitely! We use American English on our developer sites.

pq · 2021-05-06T23:26:25Z

src/docs/release/breaking-changes/flutter-lints-package.md

+
+## Context
+
+Prior to the introduction of `package:flutter_lints` the Flutter framework


=>

Prior to the introduction of package:flutter_lints,

?

pq · 2021-05-06T23:27:09Z

src/docs/release/breaking-changes/flutter-lints-package.md

+used by the [dart analyzer][] to identify code issues if a Flutter project
+didn't define a custom `analysis_options.yaml` file. Since `analysis_options_user.yaml`
+was tied to a particular framework version, it was difficult to evolve without
+breaking existing apps, packages, and plugins. As a result of that the lints


=>

As a result of that,

?

pq · 2021-05-06T23:28:54Z

src/docs/release/breaking-changes/flutter-lints-package.md

+`package:flutter_lints` was created. The package versions the lint set to enable
+evolving it without breaking existing projects. Since the package builds on
+Dart's [`package:lints`][] it also aligns the lints recommended for Flutter
+projects with the rest of the dart universe.


=>

Dart universe.

?

pq

In general, looks great. Nice docs!

A few super minor nits...

mit-mit · 2021-05-07T11:22:06Z

src/docs/release/breaking-changes/flutter-lints-package.md

+`package:flutter_lints` was created. The package versions the lint set to enable
+evolving it without breaking existing projects. Since the package builds on
+Dart's [`package:lints`][] it also aligns the lints recommended for Flutter
+projects with the rest of the Dart universe.


Suggest s/universe/ecosystem/ which sounds a bit friendlier?

mit-mit · 2021-05-07T11:54:03Z

src/docs/release/breaking-changes/flutter-lints-package.md

+include: package:flutter_lints/flutter.yaml
+```
+
+The newly activated lint set may identify some previously undiscovered issues in


s/some previously undiscovered/new/ ?

mit-mit · 2021-05-07T11:54:53Z

src/docs/release/breaking-changes/flutter-lints-package.md

+```
+
+The newly activated lint set may identify some previously undiscovered issues in
+your code. To find them, run `flutter analyze` in the root directory of your


Perhaps also mention that you can simply open the project in an IDE with Dart support?

mit-mit · 2021-05-07T11:55:15Z

src/docs/release/breaking-changes/flutter-lints-package.md

+the lints from `package:flutter_lints`. If your `analysis_options.yaml` already
+contains an `include:` directive you have to decide whether you want to keep
+those lints or whether you want to replace it with the lints from
+`package:flutter_lints` because the dart analyzer only supports one `include:`


s/dart/Dart/

sfshaza2

Nice doc, but I am wondering if we should move it.

sfshaza2 · 2021-05-10T15:52:19Z

src/docs/release/breaking-changes/flutter-lints-package.md

+
+## Timeline
+
+Landed in version: 2.xx<br>


Do you know which version?

Not yet. I'll update this PR as soon as I know.

sfshaza2 · 2021-05-10T15:52:50Z

src/docs/release/breaking-changes/flutter-lints-package.md

+[Add flutter_lints package]: {{site.github}}/flutter/packages/pull/343
+[`analysis_options_user.yaml`]: {{site.github}}/flutter/flutter/blob/master/packages/flutter/lib/analysis_options_user.yaml
+[Customizing static analysis]: https://dart.dev/guides/language/analysis-options
+[dart analyzer]: https://dart.dev/guides/language/analysis-options


Suggested change

[dart analyzer]: https://dart.dev/guides/language/analysis-options

[dart analyzer]: {{site.dart-site}}/guides/language/analysis-options

sfshaza2 · 2021-05-10T15:53:11Z

src/docs/release/breaking-changes/flutter-lints-package.md

+[dart analyzer]: https://dart.dev/guides/language/analysis-options
+[Integrate package:flutter_lints into template]: {{site.github}}/flutter/flutter/pull/81417
+[Issue 78432 - Update lint set for Flutter applications]: {{site.github}}/flutter/flutter/issues/78432
+[`package:flutter_lints`]: https://pub.dev/packages/flutter_lints


Suggested change

[`package:flutter_lints`]: https://pub.dev/packages/flutter_lints

[`package:flutter_lints`]: {{site.pub}}/packages/flutter_lints

sfshaza2 · 2021-05-10T15:53:28Z

src/docs/release/breaking-changes/flutter-lints-package.md

+[Integrate package:flutter_lints into template]: {{site.github}}/flutter/flutter/pull/81417
+[Issue 78432 - Update lint set for Flutter applications]: {{site.github}}/flutter/flutter/issues/78432
+[`package:flutter_lints`]: https://pub.dev/packages/flutter_lints
+[`package:lints`]: https://pub.dev/packages/lints


Suggested change

[`package:lints`]: https://pub.dev/packages/lints

[`package:lints`]: {{site.pub}}/packages/lints

sfshaza2 · 2021-05-10T15:56:39Z

src/docs/release/breaking-changes/flutter-lints-package.md

+[Issue 78432 - Update lint set for Flutter applications]: {{site.github}}/flutter/flutter/issues/78432
+[`package:flutter_lints`]: https://pub.dev/packages/flutter_lints
+[`package:lints`]: https://pub.dev/packages/lints
+[Package dependencies]: https://dart.dev/tools/pub/dependencies


Suggested change

[Package dependencies]: https://dart.dev/tools/pub/dependencies

[Package dependencies]: {{site.dart-site}}/tools/pub/dependencies

sfshaza2 · 2021-05-10T15:57:46Z

src/docs/release/breaking-changes/index.md

 * [ThemeData's accent properties have been deprecated][]

 [Default Scrollbars on Desktop]: /docs/release/breaking-changes/default-desktop-scrollbars
+[Introducing package:flutter_lints]: /docs/release/breaking-changes/flutter-lints-package


Hmmm... It seems that we should document this in the "main" portion of the site, rather than bury it in breaking changes, where it can only be found via google search...

I am open to that. :) Do you have a place in mind?

Also, we will link to this page from a tooling message when it is discovered that your setup is out of date.

sfshaza2

On second thought, I'm ok with this living in the breaking changes docs...

goderbauer · 2021-05-12T17:43:44Z

I am now just waiting on a Flutter dev release that contains flutter/flutter#81417 to obtain the version number that needs to be included in this guide.

sfshaza2 · 2021-05-12T19:49:17Z

SG

goderbauer · 2021-05-19T00:00:56Z

Added the missing version info. This PR is ready now!

pq

Nice doc!

sfshaza2

LGTM

google-cla bot added the cla: yes Contributor has signed the Contributor License Agreement label May 6, 2021

goderbauer marked this pull request as draft May 6, 2021 21:59

pq reviewed May 6, 2021

View reviewed changes

mit-mit reviewed May 7, 2021

View reviewed changes

sfshaza2 reviewed May 10, 2021

View reviewed changes

goderbauer added 4 commits May 10, 2021 09:40

Migration guide for package:flutter_lints

2b4f996

wording

d9c0ca2

pq review

f8abf36

mit & shams review

28335db

goderbauer force-pushed the lints branch from a3df89e to 28335db Compare May 10, 2021 16:56

This was referenced May 11, 2021

☂️ Update lint set for Flutter applications flutter/flutter#78432

Closed

publish a 1.0.0 version dart-lang/core#842

Closed

sfshaza2 reviewed May 11, 2021

View reviewed changes

pq mentioned this pull request May 14, 2021

Document migration from pedantic dart-lang/core#747

Closed

add version info

e17ca43

goderbauer marked this pull request as ready for review May 19, 2021 00:00

pq approved these changes May 19, 2021

View reviewed changes

goderbauer requested a review from sfshaza2 May 19, 2021 17:19

sfshaza2 approved these changes May 19, 2021

View reviewed changes

sfshaza2 merged commit 5fbb57b into flutter:master May 19, 2021

goderbauer deleted the lints branch May 19, 2021 18:52


		## Context

		Prior to the introduction of `package:flutter_lints` the Flutter framework

	[dart analyzer]: https://dart.dev/guides/language/analysis-options
	[dart analyzer]: {{site.dart-site}}/guides/language/analysis-options

	[`package:flutter_lints`]: https://pub.dev/packages/flutter_lints
	[`package:flutter_lints`]: {{site.pub}}/packages/flutter_lints

	[`package:lints`]: https://pub.dev/packages/lints
	[`package:lints`]: {{site.pub}}/packages/lints

	[Package dependencies]: https://dart.dev/tools/pub/dependencies
	[Package dependencies]: {{site.dart-site}}/tools/pub/dependencies

Conversation

goderbauer commented May 6, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

goderbauer commented May 6, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pq left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sfshaza2 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

goderbauer May 10, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sfshaza2 left a comment

Choose a reason for hiding this comment

Uh oh!

goderbauer commented May 12, 2021

Uh oh!

sfshaza2 commented May 12, 2021

Uh oh!

goderbauer commented May 19, 2021

Uh oh!

pq left a comment

Choose a reason for hiding this comment

Uh oh!

sfshaza2 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

goderbauer commented May 6, 2021 •

edited

Loading

goderbauer May 10, 2021 •

edited

Loading