Make example's README.md priority over any dart file in the examples directory.

.github/workflows/test-package.yml

@@ -21,7 +21,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        sdk: [3.6.0-334.4.beta]
+        sdk: [3.6.0]
     steps:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
       - uses: dart-lang/setup-dart@e630b99d28a3b71860378cafdc2a067c71107f94
@@ -49,8 +49,8 @@ jobs:
         # TODO(sigurdm): our end2end test creates longer filenames than we can
         # handle on windows. See https://github.com/dart-lang/sdk/issues/42416
         os: [ubuntu-latest, macos-latest]
-        sdk: [3.6.0-334.4.beta]
-        flutter: [3.27.0-0.2.pre]
+        sdk: [3.6.0]
+        flutter: [3.27.0]
     steps:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
       - uses: dart-lang/setup-dart@e630b99d28a3b71860378cafdc2a067c71107f94

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.22.18-dev
+
+- Make example's `README.md` priority over any dart file in the examples directory.
+
 ## 0.22.17
 
 - Fixed lower dependency constraint for `cli_util`.

lib/src/maintenance.dart

@@ -7,6 +7,7 @@ import 'package:json_annotation/json_annotation.dart';
 /// Returns the candidates in priority order to display under the 'Example' tab.
 List<String> exampleFileCandidates(String package) {
   return <String>[
+    'example/README.md',
     'example/example.md',
     'example/lib/main.dart',
     'example/bin/main.dart',
@@ -20,7 +21,6 @@ List<String> exampleFileCandidates(String package) {
     'example/lib/example.dart',
     'example/bin/example.dart',
     'example/example.dart',
-    'example/README.md',
   ];
 }
 

lib/src/pubspec.dart

@@ -76,11 +76,9 @@ class Pubspec {
           _dependentSdks!.add(value.sdk);
         }
       }
-      if (_inner.environment != null) {
-        final keys = _inner.environment!.keys.toList();
-        keys.remove('sdk');
-        _dependentSdks!.addAll(keys);
-      }
+      final keys = _inner.environment.keys.toList();
+      keys.remove('sdk');
+      _dependentSdks!.addAll(keys);
     }
     return _dependentSdks!;
   }
@@ -119,10 +117,10 @@ class Pubspec {
       .any((d) => d is GitDependency && (d.ref == null || d.ref!.length < 40));
 
   SdkConstraintStatus get sdkConstraintStatus =>
-      SdkConstraintStatus.fromSdkVersion(_inner.environment?['sdk']);
+      SdkConstraintStatus.fromSdkVersion(_inner.environment['sdk']);
 
   VersionConstraint? get dartSdkConstraint {
-    final constraint = _inner.environment?['sdk'];
+    final constraint = _inner.environment['sdk'];
     // If a package is null safe it should also be compatible with dart 3.
     // Therefore we rewrite a null-safety enabled constraint with the upper
     // bound <3.0.0 to be have upper bound <4.0.0
@@ -147,7 +145,7 @@ class Pubspec {
   VersionConstraint? get flutterSdkConstraint =>
       // Flutter constraints get special treatment, as Flutter won't be
       // using semantic versioning to mark breaking releases.
-      _removeUpperBound(_inner.environment?['flutter']);
+      _removeUpperBound(_inner.environment['flutter']);
 
   VersionConstraint? _removeUpperBound(VersionConstraint? constraint) {
     if (constraint is VersionRange) {

pubspec.yaml

@@ -1,6 +1,6 @@
 name: pana
 description: PAckage aNAlyzer - produce a report summarizing the health and quality of a Dart package.
-version: 0.22.17
+version: 0.22.18-dev
 repository: https://github.com/dart-lang/pana
 topics:
   - tool
@@ -10,43 +10,43 @@ environment:
   sdk: '>=3.0.0 <4.0.0'
 
 dependencies:
-  analyzer: '>=5.0.0 <7.0.0'
-  args: ^2.0.0
-  async: ^2.0.0
+  analyzer: ^6.11.0
+  args: ^2.6.0
+  async: ^2.12.0
   cli_util: ^0.4.2
-  collection: ^1.15.0
-  crypto: ^3.0.0
-  html: ^0.15.0
-  http: ^1.0.0
-  io: ^1.0.0
+  collection: ^1.19.1
+  crypto: ^3.0.6
+  html: ^0.15.5
+  http: ^1.2.2
+  io: ^1.0.5
   json_annotation: ^4.9.0
-  lints: '>=4.0.0 <6.0.0'
-  logging: ^1.0.0
-  markdown: ^7.0.0
-  meta: ^1.4.0
-  path: ^1.6.2
-  pub_semver: ^2.0.0
-  pubspec_parse: ^1.2.2
-  retry: ^3.0.1
-  safe_url_check: ^1.0.0
-  source_span: ^1.7.0
-  string_scanner: ^1.1.0
+  lints: ^5.1.1
+  logging: ^1.3.0
+  markdown: ^7.2.2
+  meta: ^1.16.0
+  path: ^1.9.1
+  pub_semver: ^2.1.5
+  pubspec_parse: ^1.4.0
+  retry: ^3.1.2
+  safe_url_check: ^1.1.2
+  source_span: ^1.10.1
+  string_scanner: ^1.4.1
   tar: ^2.0.0
-  test: ^1.5.2 # needed for lib/src/third_party/diff_match_patch/test.dart
-  yaml: ^3.0.0
+  test: ^1.25.14 # needed for lib/src/third_party/diff_match_patch/test.dart
+  yaml: ^3.1.3
 
 dev_dependencies:
-  build: ^2.0.1
-  build_config: ^1.0.0
-  build_runner: ^2.0.4
-  build_verify: ^3.0.0
-  build_version: ^2.0.0
-  dart_flutter_team_lints: ^3.1.0
-  json_serializable: ^6.0.0
-  shelf: ^1.0.0
-  source_gen: ^1.0.0
-  test_descriptor: ^2.0.0
-  test_process: ^2.0.0
+  build: ^2.4.2
+  build_config: ^1.1.2
+  build_runner: ^2.4.14
+  build_verify: ^3.1.0
+  build_version: ^2.1.1
+  dart_flutter_team_lints: ^3.2.1
+  json_serializable: ^6.9.0
+  shelf: ^1.4.2
+  source_gen: ^1.5.0
+  test_descriptor: ^2.0.2
+  test_process: ^2.1.1
 
 executables:
   pana:

test/goldens/end2end/bulma_min-0.7.4.json

@@ -74,7 +74,7 @@
         "grantedPoints": 0,
         "maxPoints": 40,
         "status": "failed",
-        "summary": "### [x] 0/10 points: All of the package dependencies are supported in the latest version\n\n<details>\n<summary>\nSdk constraint doesn't support current Dart version {{sdk-version}}. Cannot run `dart pub outdated`.\n</summary>\n\n`pubspec.yaml:8:8`\n\n```\n  ╷\n8 │   sdk: '>=1.0.0 <3.0.0'\n  │        ^^^^^^^^^^^^^^^^\n  ╵\n```\n\n</details>\n\n### [x] 0/10 points: Package supports latest stable Dart and Flutter SDKs\n\n<details>\n<summary>\nSdk constraint doesn't support current Dart version {{sdk-version}}.\n</summary>\n\n`pubspec.yaml:8:8`\n\n```\n  ╷\n8 │   sdk: '>=1.0.0 <3.0.0'\n  │        ^^^^^^^^^^^^^^^^\n  ╵\n```\n\nTry widening the upper boundary of the constraint.\n</details>\n\n### [x] 0/20 points: Compatible with dependency constraint lower bounds\n\n`dart pub downgrade` failed with:\n\n```\nOUT:\nResolving dependencies...\nERR:\nThe lower bound of \"sdk: '>=1.0.0 <3.0.0'\" must be 2.12.0'\nor higher to enable null safety.\n\nThe current Dart SDK (3.6.0-334.4.beta) only supports null safety.\n\nFor details, see https://dart.dev/null-safety\n```\n\nRun `dart pub downgrade` and then `dart analyze` to reproduce the above problem.\n\nYou may run `dart pub upgrade --tighten` to update your dependency constraints, see [dart.dev/go/downgrade-testing](https://dart.dev/go/downgrade-testing) for details.\n"
+        "summary": "### [x] 0/10 points: All of the package dependencies are supported in the latest version\n\n<details>\n<summary>\nSdk constraint doesn't support current Dart version {{sdk-version}}. Cannot run `dart pub outdated`.\n</summary>\n\n`pubspec.yaml:8:8`\n\n```\n  ╷\n8 │   sdk: '>=1.0.0 <3.0.0'\n  │        ^^^^^^^^^^^^^^^^\n  ╵\n```\n\n</details>\n\n### [x] 0/10 points: Package supports latest stable Dart and Flutter SDKs\n\n<details>\n<summary>\nSdk constraint doesn't support current Dart version {{sdk-version}}.\n</summary>\n\n`pubspec.yaml:8:8`\n\n```\n  ╷\n8 │   sdk: '>=1.0.0 <3.0.0'\n  │        ^^^^^^^^^^^^^^^^\n  ╵\n```\n\nTry widening the upper boundary of the constraint.\n</details>\n\n### [x] 0/20 points: Compatible with dependency constraint lower bounds\n\n`dart pub downgrade` failed with:\n\n```\nOUT:\nResolving dependencies...\nERR:\nThe lower bound of \"sdk: '>=1.0.0 <3.0.0'\" must be 2.12.0'\nor higher to enable null safety.\n\nThe current Dart SDK (3.6.0) only supports null safety.\n\nFor details, see https://dart.dev/null-safety\n```\n\nRun `dart pub downgrade` and then `dart analyze` to reproduce the above problem.\n\nYou may run `dart pub upgrade --tighten` to update your dependency constraints, see [dart.dev/go/downgrade-testing](https://dart.dev/go/downgrade-testing) for details.\n"
       }
     ]
   },

test/goldens/end2end/bulma_min-0.7.4.json_report.md

@@ -105,7 +105,7 @@ ERR:
 The lower bound of "sdk: '>=1.0.0 <3.0.0'" must be 2.12.0'
 or higher to enable null safety.
 
-The current Dart SDK (3.6.0-334.4.beta) only supports null safety.
+The current Dart SDK (3.6.0) only supports null safety.
 
 For details, see https://dart.dev/null-safety
 ```

test/goldens/end2end/mime_type-0.3.2.json

@@ -67,7 +67,7 @@
         "grantedPoints": 0,
         "maxPoints": 40,
         "status": "failed",
-        "summary": "### [x] 0/10 points: All of the package dependencies are supported in the latest version\n\n<details>\n<summary>\nSdk constraint doesn't support current Dart version {{sdk-version}}. Cannot run `dart pub outdated`.\n</summary>\n\n`pubspec.yaml:10:10`\n\n```\n   ╷\n10 │     sdk: '>=0.8.10 <3.0.0'\n   │          ^^^^^^^^^^^^^^^^^\n   ╵\n```\n\n</details>\n\n### [x] 0/10 points: Package supports latest stable Dart and Flutter SDKs\n\n<details>\n<summary>\nSdk constraint doesn't support current Dart version {{sdk-version}}.\n</summary>\n\n`pubspec.yaml:10:10`\n\n```\n   ╷\n10 │     sdk: '>=0.8.10 <3.0.0'\n   │          ^^^^^^^^^^^^^^^^^\n   ╵\n```\n\nTry widening the upper boundary of the constraint.\n</details>\n\n### [x] 0/20 points: Compatible with dependency constraint lower bounds\n\n`dart pub downgrade` failed with:\n\n```\nOUT:\nResolving dependencies...\nERR:\nThe lower bound of \"sdk: '>=0.8.10 <3.0.0'\" must be 2.12.0'\nor higher to enable null safety.\n\nThe current Dart SDK (3.6.0-334.4.beta) only supports null safety.\n\nFor details, see https://dart.dev/null-safety\n```\n\nRun `dart pub downgrade` and then `dart analyze` to reproduce the above problem.\n\nYou may run `dart pub upgrade --tighten` to update your dependency constraints, see [dart.dev/go/downgrade-testing](https://dart.dev/go/downgrade-testing) for details.\n"
+        "summary": "### [x] 0/10 points: All of the package dependencies are supported in the latest version\n\n<details>\n<summary>\nSdk constraint doesn't support current Dart version {{sdk-version}}. Cannot run `dart pub outdated`.\n</summary>\n\n`pubspec.yaml:10:10`\n\n```\n   ╷\n10 │     sdk: '>=0.8.10 <3.0.0'\n   │          ^^^^^^^^^^^^^^^^^\n   ╵\n```\n\n</details>\n\n### [x] 0/10 points: Package supports latest stable Dart and Flutter SDKs\n\n<details>\n<summary>\nSdk constraint doesn't support current Dart version {{sdk-version}}.\n</summary>\n\n`pubspec.yaml:10:10`\n\n```\n   ╷\n10 │     sdk: '>=0.8.10 <3.0.0'\n   │          ^^^^^^^^^^^^^^^^^\n   ╵\n```\n\nTry widening the upper boundary of the constraint.\n</details>\n\n### [x] 0/20 points: Compatible with dependency constraint lower bounds\n\n`dart pub downgrade` failed with:\n\n```\nOUT:\nResolving dependencies...\nERR:\nThe lower bound of \"sdk: '>=0.8.10 <3.0.0'\" must be 2.12.0'\nor higher to enable null safety.\n\nThe current Dart SDK (3.6.0) only supports null safety.\n\nFor details, see https://dart.dev/null-safety\n```\n\nRun `dart pub downgrade` and then `dart analyze` to reproduce the above problem.\n\nYou may run `dart pub upgrade --tighten` to update your dependency constraints, see [dart.dev/go/downgrade-testing](https://dart.dev/go/downgrade-testing) for details.\n"
       }
     ]
   },

test/goldens/end2end/mime_type-0.3.2.json_report.md

@@ -136,7 +136,7 @@ ERR:
 The lower bound of "sdk: '>=0.8.10 <3.0.0'" must be 2.12.0'
 or higher to enable null safety.
 
-The current Dart SDK (3.6.0-334.4.beta) only supports null safety.
+The current Dart SDK (3.6.0) only supports null safety.
 
 For details, see https://dart.dev/null-safety
 ```

test/goldens/end2end/sdp_transform-0.2.0.json

@@ -83,7 +83,7 @@
         "grantedPoints": 0,
         "maxPoints": 40,
         "status": "failed",
-        "summary": "### [x] 0/10 points: All of the package dependencies are supported in the latest version\n\n<details>\n<summary>\nSdk constraint doesn't support current Dart version {{sdk-version}}. Cannot run `dart pub outdated`.\n</summary>\n\n`pubspec.yaml:10:8`\n\n```\n   ╷\n10 │   sdk: '<3.0.0'\n   │        ^^^^^^^^\n   ╵\n```\n\n</details>\n\n### [x] 0/10 points: Package supports latest stable Dart and Flutter SDKs\n\n<details>\n<summary>\nSdk constraint doesn't support current Dart version {{sdk-version}}.\n</summary>\n\n`pubspec.yaml:10:8`\n\n```\n   ╷\n10 │   sdk: '<3.0.0'\n   │        ^^^^^^^^\n   ╵\n```\n\nTry widening the upper boundary of the constraint.\n</details>\n\n### [x] 0/20 points: Compatible with dependency constraint lower bounds\n\n`dart pub downgrade` failed with:\n\n```\nOUT:\nResolving dependencies...\nERR:\nThe lower bound of \"sdk: '>=1.0.0 <3.0.0'\" must be 2.12.0'\nor higher to enable null safety.\n\nThe current Dart SDK (3.6.0-334.4.beta) only supports null safety.\n\nFor details, see https://dart.dev/null-safety\n```\n\nRun `dart pub downgrade` and then `dart analyze` to reproduce the above problem.\n\nYou may run `dart pub upgrade --tighten` to update your dependency constraints, see [dart.dev/go/downgrade-testing](https://dart.dev/go/downgrade-testing) for details.\n"
+        "summary": "### [x] 0/10 points: All of the package dependencies are supported in the latest version\n\n<details>\n<summary>\nSdk constraint doesn't support current Dart version {{sdk-version}}. Cannot run `dart pub outdated`.\n</summary>\n\n`pubspec.yaml:10:8`\n\n```\n   ╷\n10 │   sdk: '<3.0.0'\n   │        ^^^^^^^^\n   ╵\n```\n\n</details>\n\n### [x] 0/10 points: Package supports latest stable Dart and Flutter SDKs\n\n<details>\n<summary>\nSdk constraint doesn't support current Dart version {{sdk-version}}.\n</summary>\n\n`pubspec.yaml:10:8`\n\n```\n   ╷\n10 │   sdk: '<3.0.0'\n   │        ^^^^^^^^\n   ╵\n```\n\nTry widening the upper boundary of the constraint.\n</details>\n\n### [x] 0/20 points: Compatible with dependency constraint lower bounds\n\n`dart pub downgrade` failed with:\n\n```\nOUT:\nResolving dependencies...\nERR:\nThe lower bound of \"sdk: '>=1.0.0 <3.0.0'\" must be 2.12.0'\nor higher to enable null safety.\n\nThe current Dart SDK (3.6.0) only supports null safety.\n\nFor details, see https://dart.dev/null-safety\n```\n\nRun `dart pub downgrade` and then `dart analyze` to reproduce the above problem.\n\nYou may run `dart pub upgrade --tighten` to update your dependency constraints, see [dart.dev/go/downgrade-testing](https://dart.dev/go/downgrade-testing) for details.\n"
       }
     ]
   },

test/goldens/end2end/sdp_transform-0.2.0.json_report.md

@@ -117,7 +117,7 @@ ERR:
 The lower bound of "sdk: '>=1.0.0 <3.0.0'" must be 2.12.0'
 or higher to enable null safety.
 
-The current Dart SDK (3.6.0-334.4.beta) only supports null safety.
+The current Dart SDK (3.6.0) only supports null safety.
 
 For details, see https://dart.dev/null-safety
 ```

test/goldens/end2end/skiplist-0.1.0.json

@@ -72,15 +72,15 @@
         "grantedPoints": 0,
         "maxPoints": 50,
         "status": "failed",
-        "summary": "### [x] 0/50 points: code has no errors, warnings, lints, or formatting issues\n\n* Running `dart pub outdated` failed with the following output:\n\n```\nThe lower bound of \"sdk: '>=1.0.0 <=3.6.0-334.4.beta'\" must be 2.12.0'\nor higher to enable null safety.\n```\n"
+        "summary": "### [x] 0/50 points: code has no errors, warnings, lints, or formatting issues\n\n* Running `dart pub outdated` failed with the following output:\n\n```\nThe lower bound of \"sdk: '>=1.0.0 <=3.6.0'\" must be 2.12.0'\nor higher to enable null safety.\n```\n"
       },
       {
         "id": "dependency",
         "title": "Support up-to-date dependencies",
         "grantedPoints": 0,
         "maxPoints": 40,
         "status": "failed",
-        "summary": "### [x] 0/10 points: All of the package dependencies are supported in the latest version\n\n* Sdk constraint doesn't support current Dart version {{sdk-version}}. Cannot run `dart pub outdated`.\n\n### [x] 0/10 points: Package supports latest stable Dart and Flutter SDKs\n\n<details>\n<summary>\nPubspec.yaml does not have an sdk version constraint.\n</summary>\n\nTry adding an sdk constraint to your `pubspec.yaml`\n</details>\n\n### [x] 0/20 points: Compatible with dependency constraint lower bounds\n\n`dart pub downgrade` failed with:\n\n```\nOUT:\nResolving dependencies...\nERR:\nThe lower bound of \"sdk: '>=1.0.0 <=3.6.0-334.4.beta'\" must be 2.12.0'\nor higher to enable null safety.\n\nThe current Dart SDK (3.6.0-334.4.beta) only supports null safety.\n\nFor details, see https://dart.dev/null-safety\n```\n\nRun `dart pub downgrade` and then `dart analyze` to reproduce the above problem.\n\nYou may run `dart pub upgrade --tighten` to update your dependency constraints, see [dart.dev/go/downgrade-testing](https://dart.dev/go/downgrade-testing) for details.\n"
+        "summary": "### [x] 0/10 points: All of the package dependencies are supported in the latest version\n\n* Sdk constraint doesn't support current Dart version {{sdk-version}}. Cannot run `dart pub outdated`.\n\n### [x] 0/10 points: Package supports latest stable Dart and Flutter SDKs\n\n<details>\n<summary>\nPubspec.yaml does not have an sdk version constraint.\n</summary>\n\nTry adding an sdk constraint to your `pubspec.yaml`\n</details>\n\n### [x] 0/20 points: Compatible with dependency constraint lower bounds\n\n`dart pub downgrade` failed with:\n\n```\nOUT:\nResolving dependencies...\nERR:\nThe lower bound of \"sdk: '>=1.0.0 <=3.6.0'\" must be 2.12.0'\nor higher to enable null safety.\n\nThe current Dart SDK (3.6.0) only supports null safety.\n\nFor details, see https://dart.dev/null-safety\n```\n\nRun `dart pub downgrade` and then `dart analyze` to reproduce the above problem.\n\nYou may run `dart pub upgrade --tighten` to update your dependency constraints, see [dart.dev/go/downgrade-testing](https://dart.dev/go/downgrade-testing) for details.\n"
       }
     ]
   },
@@ -104,5 +104,5 @@
     "maxPoints": 150
   },
   "urlProblems": [],
-  "errorMessage": "Running `dart pub outdated` failed with the following output:\n\n```\nThe lower bound of \"sdk: '>=1.0.0 <=3.6.0-334.4.beta'\" must be 2.12.0'\nor higher to enable null safety.\n```"
+  "errorMessage": "Running `dart pub outdated` failed with the following output:\n\n```\nThe lower bound of \"sdk: '>=1.0.0 <=3.6.0'\" must be 2.12.0'\nor higher to enable null safety.\n```"
 }

test/goldens/end2end/skiplist-0.1.0.json_report.md

@@ -58,7 +58,7 @@ See https://dart.dev/web/wasm for details.
 * Running `dart pub outdated` failed with the following output:
 
 ```
-The lower bound of "sdk: '>=1.0.0 <=3.6.0-334.4.beta'" must be 2.12.0'
+The lower bound of "sdk: '>=1.0.0 <=3.6.0'" must be 2.12.0'
 or higher to enable null safety.
 ```
 
@@ -87,10 +87,10 @@ Try adding an sdk constraint to your `pubspec.yaml`
 OUT:
 Resolving dependencies...
 ERR:
-The lower bound of "sdk: '>=1.0.0 <=3.6.0-334.4.beta'" must be 2.12.0'
+The lower bound of "sdk: '>=1.0.0 <=3.6.0'" must be 2.12.0'
 or higher to enable null safety.
 
-The current Dart SDK (3.6.0-334.4.beta) only supports null safety.
+The current Dart SDK (3.6.0) only supports null safety.
 
 For details, see https://dart.dev/null-safety
 ```

test/self_run_test.dart

@@ -18,7 +18,8 @@ void main() {
     final snippets = [
       '## ✓ Follow Dart file conventions (30 / 30)',
       '## ✓ Platform support (20 / 20)\n',
-      '[*] 10/10 points: All of the package dependencies are supported in the latest version',
+      // TODO: consider dropping this, as we don't always resolve to the latest dependencies
+      // '[*] 10/10 points: All of the package dependencies are supported in the latest version',
       '### [*] 10/10 points: Package supports latest stable Dart and Flutter SDKs',
     ];
     for (final snippet in snippets) {