Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 17 commits into from
Nov 4, 2024
Merged
Show file tree
Hide file tree
Changes from 9 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions analysis_options.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@ linter:
# - lines_longer_than_80_chars # not required by flutter style
- literal_only_boolean_expressions
# - matching_super_parameters # blocked on https://github.com/dart-lang/language/issues/2509
- missing_code_block_language_in_doc_comment
- missing_whitespace_between_adjacent_strings
- no_adjacent_strings_in_list
- no_default_cases
Expand Down
3 changes: 2 additions & 1 deletion packages/flutter_migrate/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
## NEXT
## 0.0.1+4

* Adds `missing_code_block_language_in_doc_comment` lint.
* Updates minimum supported SDK version to Flutter 3.19/Dart 3.3.

## 0.0.1+3
Expand Down
4 changes: 2 additions & 2 deletions packages/flutter_migrate/lib/src/base/common.dart
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ String getEnumName(dynamic enumItem) {
/// Rationale:
///
/// Consider the following snippet:
/// ```
/// ```dart
/// try {
/// await foo();
/// ...
Expand All @@ -87,7 +87,7 @@ String getEnumName(dynamic enumItem) {
/// [asyncGuard] is intended to wrap awaited expressions occurring in a `try`
/// block. The behavior described above gives the behavior that users
/// intuitively expect from `await`. Consider the snippet:
/// ```
/// ```dart
/// try {
/// await asyncGuard(() async {
/// var c = Completer();
Expand Down
2 changes: 1 addition & 1 deletion packages/flutter_migrate/lib/src/base/logger.dart
Original file line number Diff line number Diff line change
Expand Up @@ -1125,7 +1125,7 @@ class SpinnerStatus extends AnonymousSpinnerStatus {
/// ```
///
/// yields:
/// ```
/// ```none
/// Usage: app main_command <subcommand>
/// [arguments]
/// ```
Expand Down
2 changes: 1 addition & 1 deletion packages/flutter_migrate/pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: flutter_migrate
description: A tool to migrate legacy flutter projects to modern versions.
version: 0.0.1+3
version: 0.0.1+4
repository: https://github.com/flutter/packages/tree/main/packages/flutter_migrate
issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3Ap%3A%20flutter_migrate
publish_to: none
Expand Down
4 changes: 4 additions & 0 deletions packages/go_router/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## 14.3.1

- Adds `missing_code_block_language_in_doc_comment` lint.

## 14.3.0

- Added missing implementation for the routerNeglect parameter in GoRouter.
Expand Down
37 changes: 20 additions & 17 deletions packages/go_router/lib/src/route.dart
Original file line number Diff line number Diff line change
Expand Up @@ -77,15 +77,15 @@ typedef ExitCallback = FutureOr<bool> Function(
/// with the sub routes.
///
/// For example these routes:
/// ```
/// ```none
/// / => HomePage()
/// family/f1 => FamilyPage('f1')
/// person/p2 => PersonPage('f1', 'p2') ← showing this page, Back pops ↑
/// ```
///
/// Can be represented as:
///
/// ```
/// ```dart
/// final GoRouter _router = GoRouter(
/// routes: <GoRoute>[
/// GoRoute(
Expand Down Expand Up @@ -122,12 +122,14 @@ typedef ExitCallback = FutureOr<bool> Function(
/// ),
/// ],
/// );
/// ```
///
/// If there are multiple routes that match the location, the first match is used.
/// To make predefined routes to take precedence over dynamic routes eg. '/:id'
/// consider adding the dynamic route at the end of the routes
/// consider adding the dynamic route at the end of the routes.
///
/// For example:
/// ```
/// ```dart
/// final GoRouter _router = GoRouter(
/// routes: <GoRoute>[
/// GoRoute(
Expand All @@ -145,9 +147,10 @@ typedef ExitCallback = FutureOr<bool> Function(
/// ],
/// );
/// ```
/// In the above example, if /family route is matched, it will be used.
/// else /:username route will be used.
/// ///
///
/// In the above example, if `/family` route is matched, it will be used.
/// else `/:username` route will be used.
///
/// See [main.dart](https://github.com/flutter/packages/blob/main/packages/go_router/example/lib/main.dart)
@immutable
abstract class RouteBase with Diagnosticable {
Expand All @@ -164,7 +167,7 @@ abstract class RouteBase with Diagnosticable {
/// the GoRoute constructor.
///
/// For example:
/// ```
/// ```dart
/// final GoRouter _router = GoRouter(
/// routes: <GoRoute>[
/// GoRoute(
Expand All @@ -183,7 +186,7 @@ abstract class RouteBase with Diagnosticable {
/// redirect takes priority over sub-route's.
///
/// For example:
/// ```
/// ```dart
/// final GoRouter _router = GoRouter(
/// routes: <GoRoute>[
/// GoRoute(
Expand Down Expand Up @@ -327,7 +330,7 @@ class GoRoute extends RouteBase {
/// The path of this go route.
///
/// For example:
/// ```
/// ```dart
/// GoRoute(
/// path: '/',
/// pageBuilder: (BuildContext context, GoRouterState state) => MaterialPage<void>(
Expand All @@ -352,7 +355,7 @@ class GoRoute extends RouteBase {
/// A page builder for this route.
///
/// Typically a MaterialPage, as in:
/// ```
/// ```dart
/// GoRoute(
/// path: '/',
/// pageBuilder: (BuildContext context, GoRouterState state) => MaterialPage<void>(
Expand All @@ -369,7 +372,7 @@ class GoRoute extends RouteBase {
/// A custom builder for this route.
///
/// For example:
/// ```
/// ```dart
/// GoRoute(
/// path: '/',
/// builder: (BuildContext context, GoRouterState state) => FamilyPage(
Expand All @@ -391,7 +394,7 @@ class GoRoute extends RouteBase {
/// This method can be useful it one wants to launch a dialog for user to
/// confirm if they want to exit the screen.
///
/// ```
/// ```dart
/// final GoRouter _router = GoRouter(
/// routes: <GoRoute>[
/// GoRoute(
Expand Down Expand Up @@ -542,7 +545,7 @@ class ShellRouteContext {
/// passed to the /b/details route so that it displays on the root Navigator
/// instead of the ShellRoute's Navigator:
///
/// ```
/// ```dart
/// final GlobalKey<NavigatorState> _rootNavigatorKey =
/// GlobalKey<NavigatorState>();
///
Expand Down Expand Up @@ -601,7 +604,7 @@ class ShellRouteContext {
///
/// For example:
///
/// ```
/// ```dart
/// ShellRoute(
/// builder: (BuildContext context, GoRouterState state, Widget child) {
/// return Scaffold(
Expand Down Expand Up @@ -739,7 +742,7 @@ class ShellRoute extends ShellRouteBase {
/// accomplished by using the method [StatefulNavigationShell.goBranch], for
/// example:
///
/// ```
/// ```dart
/// void _onItemTapped(int index) {
/// navigationShell.goBranch(index: index);
/// }
Expand Down Expand Up @@ -1059,7 +1062,7 @@ typedef ShellNavigationContainerBuilder = Widget Function(BuildContext context,
/// where the List of Widgets represent the Navigators for each branch.
///
/// Example:
/// ```
/// ```dart
/// builder: (BuildContext context, GoRouterState state,
/// StatefulNavigationShell navigationShell) {
/// return StatefulNavigationShell(
Expand Down
2 changes: 1 addition & 1 deletion packages/go_router/lib/src/state.dart
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ class GoRouterState {
///
/// To access GoRouterState from a widget.
///
/// ```
/// ```dart
/// GoRoute(
/// path: '/:id'
/// builder: (_, __) => MyWidget(),
Expand Down
2 changes: 1 addition & 1 deletion packages/go_router/pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: go_router
description: A declarative router for Flutter based on Navigation 2 supporting
deep linking, data-driven routes and more
version: 14.3.0
version: 14.3.1
repository: https://github.com/flutter/packages/tree/main/packages/go_router
issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+go_router%22

Expand Down
3 changes: 2 additions & 1 deletion packages/google_sign_in/google_sign_in/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
## NEXT
## 6.2.2

* Adds `missing_code_block_language_in_doc_comment` lint.
* Updates minimum supported SDK version to Flutter 3.19/Dart 3.3.
* Updates support matrix in README to indicate that iOS 11 is no longer supported.
* Clients on versions of Flutter that still support iOS 11 can continue to use this
Expand Down
2 changes: 1 addition & 1 deletion packages/google_sign_in/google_sign_in/lib/testing.dart
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import 'package:flutter/services.dart' show MethodCall;
///
/// Example usage:
///
/// ```
/// ```dart
/// GoogleSignIn googleSignIn;
/// FakeSignInBackend fakeSignInBackend;
///
Expand Down
2 changes: 1 addition & 1 deletion packages/google_sign_in/google_sign_in/pubspec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ description: Flutter plugin for Google Sign-In, a secure authentication system
for signing in with a Google account.
repository: https://github.com/flutter/packages/tree/main/packages/google_sign_in/google_sign_in
issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+google_sign_in%22
version: 6.2.1
version: 6.2.2

environment:
sdk: ^3.3.0
Expand Down
6 changes: 6 additions & 0 deletions packages/process/lib/src/interface/process_manager.dart
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,9 @@ abstract class ProcessManager {
/// The following code uses `start` to grep for `main` in the
/// file `test.dart` on Linux.
///
// TODO(kallentu): Remove ignore and fix when stable is bumped.
// https://github.com/flutter/flutter/issues/157620
// ignore: missing_code_block_language_in_doc_comment
/// ProcessManager mgr = new LocalProcessManager();
/// mgr.start(['grep', '-i', 'main', 'test.dart']).then((process) {
/// stdout.addStream(process.stdout);
Expand Down Expand Up @@ -130,6 +133,9 @@ abstract class ProcessManager {
/// The following code uses `run` to grep for `main` in the
/// file `test.dart` on Linux.
///
// TODO(kallentu): Remove ignore and fix when stable is bumped.
// https://github.com/flutter/flutter/issues/157620
// ignore: missing_code_block_language_in_doc_comment
/// ProcessManager mgr = new LocalProcessManager();
/// mgr.run('grep', ['-i', 'main', 'test.dart']).then((result) {
/// stdout.write(result.stdout);
Expand Down
3 changes: 2 additions & 1 deletion packages/rfw/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
## NEXT
## 1.0.30

* Adds `missing_code_block_language_in_doc_comment` lint.
* Updates minimum supported SDK version to Flutter 3.19/Dart 3.3.

## 1.0.29
Expand Down
20 changes: 19 additions & 1 deletion packages/rfw/lib/src/dart/binary.dart
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,9 @@ Uint8List encodeLibraryBlob(RemoteWidgetLibrary value) {
///
/// For example, the string "Hello" would be encoded as:
///
// TODO(kallentu): Remove ignore and fix when stable is bumped.
// https://github.com/flutter/flutter/issues/157620
// ignore: missing_code_block_language_in_doc_comment
/// 05 00 00 00 00 00 00 00 48 65 6C 6C 6F
///
/// * Lists are encoded as an integer length, followed by that many values
Expand All @@ -124,13 +127,19 @@ Uint8List encodeLibraryBlob(RemoteWidgetLibrary value) {
/// followed by the value (tagged lists). For example, a list of integers with
/// the values 1 and 2 in that order would be encoded as:
///
// TODO(kallentu): Remove ignore and fix when stable is bumped.
// https://github.com/flutter/flutter/issues/157620
// ignore: missing_code_block_language_in_doc_comment
/// 02 00 00 00 00 00 00 00 01 00 00 00 00 00 00 00
/// 02 00 00 00 00 00 00 00
///
/// A list of arbitrary values that happens to contain one string "Hello"
/// would be encoded as follows; 0x04 is the tag for "String" (the full list
/// of tags is described below):
///
// TODO(kallentu): Remove ignore and fix when stable is bumped.
// https://github.com/flutter/flutter/issues/157620
// ignore: missing_code_block_language_in_doc_comment
/// 01 00 00 00 00 00 00 00 04 05 00 00 00 00 00 00
/// 00 48 65 6C 6C 6F
///
Expand All @@ -147,6 +156,9 @@ Uint8List encodeLibraryBlob(RemoteWidgetLibrary value) {
/// strings, so they are untagged) is encoded as follows (0x02 is the tag for
/// integers):
///
// TODO(kallentu): Remove ignore and fix when stable is bumped.
// https://github.com/flutter/flutter/issues/157620
// ignore: missing_code_block_language_in_doc_comment
/// 01 00 00 00 00 00 00 00 01 00 00 00 00 00 00 00
/// 61 02 0F 00 00 00 00 00 00 00
///
Expand All @@ -159,6 +171,9 @@ Uint8List encodeLibraryBlob(RemoteWidgetLibrary value) {
/// one of the subparts of the imported library name. For example, `import
/// a.b` is encoded as:
///
// TODO(kallentu): Remove ignore and fix when stable is bumped.
// https://github.com/flutter/flutter/issues/157620
// ignore: missing_code_block_language_in_doc_comment
/// 02 00 00 00 00 00 00 00 01 00 00 00 00 00 00 00
kallentu marked this conversation as resolved.
Show resolved Hide resolved
/// 61 01 00 00 00 00 00 00 00 62
///
Expand Down Expand Up @@ -220,7 +235,7 @@ Uint8List encodeLibraryBlob(RemoteWidgetLibrary value) {
///
/// For example, this switch:
///
/// ```
/// ```none
/// switch (args.a) {
/// 0: 'z',
/// 1: 'o',
Expand All @@ -230,6 +245,9 @@ Uint8List encodeLibraryBlob(RemoteWidgetLibrary value) {
///
/// ...is encoded as follows (including the tag for the switch itself):
///
// TODO(kallentu): Remove ignore and fix when stable is bumped.
// https://github.com/flutter/flutter/issues/157620
// ignore: missing_code_block_language_in_doc_comment
/// 0F 0A 01 00 00 00 00 00 00 00 61 03 00 00 00 00
/// 00 00 00 02 00 00 00 00 00 00 00 00 04 01 00 00
/// 00 00 00 00 00 7A 02 01 00 00 00 00 00 00 00 04
Expand Down
Loading