Recognize new example files in bin/ (#1375)

dart-lang · Jun 11, 2024 · 41e9520 · 41e9520
1 parent 08a3ca2
commit 41e9520
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 14 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 0.22.6
+
+- New recognized example files in the `example/bin` directory.
+
 ## 0.22.5
 
 - Updated text and link on downgrade analysis.

diff --git a/lib/src/maintenance.dart b/lib/src/maintenance.dart
@@ -9,12 +9,16 @@ List<String> exampleFileCandidates(String package) {
   return <String>[
     'example/example.md',
     'example/lib/main.dart',
+    'example/bin/main.dart',
     'example/main.dart',
     'example/lib/$package.dart',
+    'example/bin/$package.dart',
     'example/$package.dart',
     'example/lib/${package}_example.dart',
+    'example/bin/${package}_example.dart',
     'example/${package}_example.dart',
     'example/lib/example.dart',
+    'example/bin/example.dart',
     'example/example.dart',
     'example/README.md',
   ];

diff --git a/lib/src/version.dart b/lib/src/version.dart
diff --git a/pubspec.yaml b/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.5
+version: 0.22.6-dev
 repository: https://github.com/dart-lang/pana
 topics:
   - tool

diff --git a/test/goldens/end2end/_dummy_pkg-1.0.0-null-safety.1.json b/test/goldens/end2end/_dummy_pkg-1.0.0-null-safety.1.json
@@ -46,10 +46,10 @@
       {
         "id": "documentation",
         "title": "Provide documentation",
-        "grantedPoints": 0,
+        "grantedPoints": 10,
         "maxPoints": 20,
         "status": "failed",
-        "summary": "### [x] 0/10 points: 20% or more of the public API has dartdoc comments\n\nDependency resolution failed, unable to run `dartdoc`.\n\n### [x] 0/10 points: Package has an example\n\n<details>\n<summary>\nNo example found.\n</summary>\n\nSee [package layout](https://dart.dev/tools/pub/package-layout#examples) guidelines on how to add an example.\n</details>"
+        "summary": "### [x] 0/10 points: 20% or more of the public API has dartdoc comments\n\nDependency resolution failed, unable to run `dartdoc`.\n\n### [*] 10/10 points: Package has an example\n"
       },
       {
         "id": "platform",
@@ -80,7 +80,7 @@
   "screenshots": [],
   "result": {
     "homepageUrl": "https://github.com/dart-lang/pub-dev",
-    "grantedPoints": 15,
+    "grantedPoints": 25,
     "maxPoints": 160
   },
   "urlProblems": [],

diff --git a/test/goldens/end2end/_dummy_pkg-1.0.0-null-safety.1.json_report.md b/test/goldens/end2end/_dummy_pkg-1.0.0-null-safety.1.json_report.md
@@ -57,21 +57,14 @@ Changelog entries help developers follow the progress of your package. Check out
 
 Detected license: `BSD-3-Clause`.
 
-## 0/20 Provide documentation
+## 10/20 Provide documentation
 
 ### [x] 0/10 points: 20% or more of the public API has dartdoc comments
 
 Dependency resolution failed, unable to run `dartdoc`.
 
-### [x] 0/10 points: Package has an example
+### [*] 10/10 points: Package has an example
 
-<details>
-<summary>
-No example found.
-</summary>
-
-See [package layout](https://dart.dev/tools/pub/package-layout#examples) guidelines on how to add an example.
-</details>
 
 ## 0/20 Platform support