[various] Add `missing_code_block_language_in_doc_comment` lint to flutter/packages. by kallentu · Pull Request #6473 · flutter/packages

kallentu · 2024-04-05T21:43:49Z

Adds this Dartdoc-related lint to the flutter repository, in replacement of the Dartdoc warning (missingCodeBlockLanguage) because it will be deprecated and removed soon.

flutter/flutter already has this lint as well. Adding to flutter/engine with flutter-team-archive/engine#51944.

Lint Proposal: dart-lang/sdk#59420

Issue covering future work removing the // ignore:s: flutter/flutter#157620

Pre-launch Checklist

If you need help, consider asking for advice on the #hackers-new channel on Discord.

stuartmorgan-g · 2024-06-04T17:16:21Z

Is this lint in 3.4, or do we need to wait another stable release cycle?

Piinks · 2024-10-22T22:51:14Z

(PR triage): What is the status of this PR?

kallentu · 2024-10-24T19:32:29Z

(PR triage): What is the status of this PR?

@Piinks
Linux analyze legacy N-1 is failing because it's linting on the wrong things. There's a commit that just so happens to fall in 3.5 (dart-lang/sdk@b6ac281) which isn't picked up in that tryjob. The rest of the lint work is done in 3.4 and the version of legacy N-1 is at Dart 3.4.x.

What's the best way forward? I don't want to be doing the fix for what's failing because it's the wrong behaviour. I'm happy to wait longer, but I suspect N-1 will become N-2 and that will end up failing.

Piinks · 2024-10-24T19:36:02Z

Hmm, I am not sure. @stuartmorgan would likely be best to advise.
I think you would have to bump the dependency on each affected package to make it no longer compatible with N-1 and N-2.

kallentu · 2024-10-28T20:02:47Z

The options are:
Drop support for N-1 in those packages
Wait for the next stable to do this, and drop N-2 in those packages
Wait for two more stables (I would not recommend this one; the value of N-2 support is low)
Add // ignore annotations for the N-1 false positives, with a comment explaining why and linking to an issue that tracks removing them after the next stable update. There's no warning for unnecessary // ignores, so that will work on all versions.
Any of those is fine. Our policy is that we only commit to supporting N, so the bar for dropping N-1 is low; N-1/N-2 tests are to prevent accidentally doing something that doesn't compile in N-1/N-2 and shipping it in a version that claims to support that version, thus breaking clients.

Added ignores as you suggested with the issue tracking it: flutter/flutter#157620.

Fixed up pubspec and changelogs. Should be ready for review and to move forward.

stuartmorgan-g

LGTM with minor changes.

chunhtai

LGTM

ditman

LGTM, but there's some TODOs that could be done now I think?

ditman · 2024-11-04T23:41:20Z

Thanks @kallentu!!

…nt to flutter/packages. (flutter/packages#6473)

flutter/packages@796afa3...7219431 2024-11-05 jonahwilliams@google.com [vector_graphics*] Relax dependency constraints of vector_graphics, vector_graphics_codec, vector_graphics_compiler, flutter_svg (flutter/packages#8018) 2024-11-04 kallentu@google.com [various] Add `missing_code_block_language_in_doc_comment` lint to flutter/packages. (flutter/packages#6473) 2024-11-04 stuartmorgan@google.com [various] Update example apps to Kotlin 1.9.0 (flutter/packages#7998) 2024-11-04 cedvandenbosch@gmail.com [go_router] add current state getter (flutter/packages#7651) 2024-11-04 jessiewong401@gmail.com Applied Gradle Plugins Declaratively for Multiple Plugin Example Apps (flutter/packages#7968) 2024-11-04 engine-flutter-autoroll@skia.org Roll Flutter from f86b777 to 8591d0c (16 revisions) (flutter/packages#8015) 2024-11-04 stuartmorgan@google.com [camera_windows] Revert: Support image streams on Windows platform (flutter/packages#7951) 2024-11-02 stuartmorgan@google.com [camera] Use Pigeon for Windows C++->Dart (flutter/packages#8001) 2024-11-02 kevmoo@users.noreply.github.com [script/tool] update dependencies (flutter/packages#7992) 2024-11-01 engine-flutter-autoroll@skia.org Roll Flutter from 0fe6153 to f86b777 (16 revisions) (flutter/packages#8000) 2024-11-01 kevmoo@users.noreply.github.com [path_parsing] deprecate utility functions that should be private (flutter/packages#7993) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages-flutter-autoroll Please CC flutter-ecosystem@google.com on the revert to ensure that a human is aware of the problem. To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

* main: (1187 commits) [various] Update example app minSdkVersions (flutter#8035) [go_router] Activate leak testing (flutter#7546) [in_app_purchase_storekit] Add restore purchases and receipts (flutter#7964) [interactive_media_ads] Adds remaining methods for internal wrapper of the Android native `BaseManager` (flutter#7943) [google_sign_in/google_identity_services] Clear-up documentation of callbacks in various APIs and uses of those APIs (flutter#8029) [flutter_svg] wasm compatibility (flutter#8014) Applied Gradle Plugins Declaratively for Multiple Plugin Example Apps (Part 2) (flutter#8019) Roll Flutter from 29d40f7 to 73546b3 (20 revisions) (flutter#8028) [ci] Upload screenshots, logs, and Xcode test results for drive and integration_test runs (flutter#7430) Remove use_modular_headers! from Podfiles (flutter#7796) [camera_avfoundation] enable more than 30 fps (flutter#7394) Roll Flutter from 8591d0c to 29d40f7 (25 revisions) (flutter#8027) [ci] Add vector_graphics and flutter_svg to autolabeler (flutter#8025) [vector_graphics_compiler] wasm compatibility (flutter#8021) [vector_graphics*] Relax dependency constraints of vector_graphics, vector_graphics_codec, vector_graphics_compiler, flutter_svg (flutter#8018) [various] Add `missing_code_block_language_in_doc_comment` lint to flutter/packages. (flutter#6473) [various] Update example apps to Kotlin 1.9.0 (flutter#7998) [go_router] add current state getter (flutter#7651) Applied Gradle Plugins Declaratively for Multiple Plugin Example Apps (flutter#7968) Roll Flutter from f86b777 to 8591d0c (16 revisions) (flutter#8015) ... # Conflicts: # packages/quick_actions/quick_actions/CHANGELOG.md # packages/quick_actions/quick_actions_ios/CHANGELOG.md # packages/quick_actions/quick_actions_platform_interface/CHANGELOG.md

…utter/packages. (flutter#6473) Adds this Dartdoc-related lint to the flutter repository, in replacement of the Dartdoc warning (missingCodeBlockLanguage) because it will be deprecated and removed soon. flutter/flutter already has this lint as well. Adding to flutter/engine with flutter-team-archive/engine#51944. Lint Proposal: https://github.com/dart-lang/linter/issues/4904 Issue covering future work removing the `// ignore:`s: flutter/flutter#157620 ## Pre-launch Checklist - [x] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [x] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [x] I read and followed the [relevant style guides] and ran the auto-formatter. (Unlike the flutter/flutter repo, the flutter/packages repo does use `dart format`.) - [x] I signed the [CLA]. - [x] The title of the PR starts with the name of the package surrounded by square brackets, e.g. `[shared_preferences]` - [x] I [linked to at least one issue that this PR fixes] in the description above. - [x] I updated `pubspec.yaml` with an appropriate new version according to the [pub versioning philosophy], or this PR is [exempt from version changes]. - [x] I updated `CHANGELOG.md` to add a description of the change, [following repository CHANGELOG style]. - [x] I updated/added relevant documentation (doc comments with `///`). - [x] I added new tests to check the change I am making, or this PR is [test-exempt]. - [x] All existing and new tests are passing. If you need help, consider asking for advice on the #hackers-new channel on [Discord].  [Contributor Guide]: https://github.com/flutter/packages/blob/main/CONTRIBUTING.md [Tree Hygiene]: https://github.com/flutter/flutter/wiki/Tree-hygiene [relevant style guides]: https://github.com/flutter/packages/blob/main/CONTRIBUTING.md#style [CLA]: https://cla.developers.google.com/ [flutter/tests]: https://github.com/flutter/tests [breaking change policy]: https://github.com/flutter/flutter/wiki/Tree-hygiene#handling-breaking-changes [Discord]: https://github.com/flutter/flutter/wiki/Chat [linked to at least one issue that this PR fixes]: https://github.com/flutter/flutter/wiki/Tree-hygiene#overview [pub versioning philosophy]: https://dart.dev/tools/pub/versioning [exempt from version changes]: https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages#version-and-changelog-updates [following repository CHANGELOG style]: https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages#changelog-style [test-exempt]: https://github.com/flutter/flutter/wiki/Tree-hygiene#tests

github-actionsBot added p: web_benchmarks p: rfw Remote Flutter Widgets p: go_router p: flutter_migrate p: google_sign_in p: local_auth platform-android platform-ios platform-windows p: webview_flutter labels Apr 5, 2024

kallentu changed the title ~~Add missing_code_block_language_in_doc_comment lint to flutter/packages.~~Add missing_code_block_language_in_doc_comment lint to flutter/packages.Apr 5, 2024

kallentu changed the title ~~Add missing_code_block_language_in_doc_comment lint to flutter/packages.~~[various] Add missing_code_block_language_in_doc_comment lint to flutter/packages.Apr 5, 2024

stuartmorgan-g added the waiting for stable update Can't be landed until functionality reaches the stable channel label Apr 8, 2024

github-actionsBot added platform-web and removed p: local_auth platform-windows labels Aug 14, 2024

Add missing_code_block_language_in_doc_comment lint to flutter/packages.
169240d

kallentu force-pushed the code-block-lint branch from d150603 to 169240dCompare October 23, 2024 22:30

github-actionsBot added p: local_auth platform-windows and removed platform-web labels Oct 23, 2024

kallentu added 2 commits October 23, 2024 22:31

Add more code block languages.
30ecb1a

Change to code block.
d6ab434

github-actionsBot added the platform-web label Oct 24, 2024

Revert indented code block change
32d3c17

github-actionsBot removed the platform-web label Oct 24, 2024

kallentu requested review from chunhtai and stuartmorgan-g as code owners October 28, 2024 20:01

yjbanov approved these changes Oct 28, 2024
View reviewed changes

stuartmorgan-g approved these changes Oct 31, 2024
View reviewed changes

Comment threadpackages/flutter_migrate/CHANGELOG.md Outdated
Comment threadpackages/process/CHANGELOG.md

Update tense in changelog, remove some version changes.
9b77257

cbracken approved these changes Oct 31, 2024
View reviewed changes

kallentu added 2 commits October 31, 2024 20:07

Fix typo.
5cd3799

Update version for android.
79af3d1

chunhtai approved these changes Oct 31, 2024
View reviewed changes

ditman approved these changes Oct 31, 2024
View reviewed changes

Comment threadpackages/rfw/lib/src/flutter/material_widgets.dart
Comment threadpackages/webview_flutter/webview_flutter_web/lib/src/http_request_factory.dart Outdated
Comment threadpackages/rfw/lib/src/dart/binary.dart Outdated

kallentu added 5 commits October 31, 2024 22:32

Change some lints into fenced code blocks.
f4fb9f5

Unformat, ugh.
33c1f1e

More unformatting.
42d8eb4

Merge branch 'main' into code-block-lint
7fa1159

Add code block language for svg.dart.
76321e0

kallentu requested a review from domesticmouse as a code owner November 4, 2024 20:05

domesticmouse approved these changes Nov 4, 2024
View reviewed changes

Update flutter_svg version.
8c94d1c

kallentu merged commit 79f8b0b into flutter:mainNov 4, 2024

kallentu deleted the code-block-lint branch November 4, 2024 22:24

engine-flutter-autoroll mentioned this pull request Nov 5, 2024
Roll Packages from 796afa35071d to 79f8b0b66551 (10 revisions) flutter/flutter#158176
Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Nov 5, 2024
79f8b0b[various] Addmissing_code_block_language_in_doc_commentli…
dccaf99
…nt to flutter/packages. (flutter/packages#6473)

engine-flutter-autoroll mentioned this pull request Nov 5, 2024
Roll Packages from 796afa35071d to 721943194945 (11 revisions) flutter/flutter#158179
Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Nov 5, 2024
79f8b0b[various] Addmissing_code_block_language_in_doc_commentli…
f9d34ac
…nt to flutter/packages. (flutter/packages#6473)

Navigation Menu

Uh oh!

[various] Add `missing_code_block_language_in_doc_comment` lint to flutter/packages. - #6473

[various] Add `missing_code_block_language_in_doc_comment` lint to flutter/packages.#6473
kallentu merged 17 commits into
flutter:mainfrom
kallentu:code-block-lint

kallentu commented Apr 5, 2024•
edited
Loading

Uh oh!

stuartmorgan-g commented Jun 4, 2024

Uh oh!

Piinks commented Oct 22, 2024

Uh oh!

kallentu commented Oct 24, 2024•
edited
Loading

Uh oh!

Piinks commented Oct 24, 2024

Uh oh!

kallentu commented Oct 28, 2024

Uh oh!

stuartmorgan-g left a comment

Uh oh!

Uh oh!

Uh oh!

chunhtai left a comment

Uh oh!

ditman left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ditman commented Nov 4, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

Uh oh!

Conversation

kallentu commented Apr 5, 2024• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-launch Checklist

Uh oh!

stuartmorgan-g commented Jun 4, 2024

Uh oh!

Piinks commented Oct 22, 2024

Uh oh!

kallentu commented Oct 24, 2024• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Piinks commented Oct 24, 2024

Uh oh!

kallentu commented Oct 28, 2024

Uh oh!

stuartmorgan-g left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

chunhtai left a comment

Choose a reason for hiding this comment

Uh oh!

ditman left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ditman commented Nov 4, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

kallentu commented Apr 5, 2024•
edited
Loading

kallentu commented Oct 24, 2024•
edited
Loading