diff --git a/lib/src/report/template.dart b/lib/src/report/template.dart index 689fb95eb..aefb15eb8 100644 --- a/lib/src/report/template.dart +++ b/lib/src/report/template.dart @@ -16,7 +16,7 @@ import '../utils.dart'; import '_common.dart'; const _pluginDocsUrl = - 'https://flutter.dev/docs/development/packages-and-plugins/developing-packages#plugin'; + 'https://docs.flutter.dev/packages-and-plugins/developing-packages#plugin'; Future followsTemplate(PackageContext context) async { final packageDir = context.packageDir; @@ -239,13 +239,16 @@ Future followsTemplate(PackageContext context) async { final readmeSubsection = await checkAsset( 'README.md', - 'The `README.md` file should inform others about your project, what it does, and how they can use it. ' - 'See: the [example](https://raw.githubusercontent.com/dart-lang/stagehand/master/templates/package-simple/README.md) generated by `stagehand`.', + 'The `README.md` file should inform others about your project, ' + 'what it does, and how they can use it. ' + 'Check out the guidelines on ' + '[Writing great package pages](https://dart.dev/guides/libraries/writing-package-pages).', ); final changelogSubsection = await checkAsset( 'CHANGELOG.md', 'Changelog entries help developers follow the progress of your package. ' - 'See the [example](https://raw.githubusercontent.com/dart-lang/stagehand/master/templates/package-simple/CHANGELOG.md) generated by `stagehand`.', + 'Check out the Dart conventions for ' + '[Maintaining a package changelog](https://dart.dev/tools/pub/package-layout#changelog).', ); final pubspecSection = await checkPubspec(); final subsections = [ @@ -286,7 +289,8 @@ Subsection _licenseSection(LicenseTags tags) { paragraphs = [ detected, Issue( - 'The following ${licensePluralized(tags.nonOsiApprovedLicenses)} are not OSI-approved: ${licenseList(tags.nonOsiApprovedLicenses)}.', + 'The following ${licensePluralized(tags.nonOsiApprovedLicenses)} are ' + 'not OSI-approved: ${licenseList(tags.nonOsiApprovedLicenses)}.', suggestion: 'Consider using an [OSI-approved license](https://opensource.org/licenses)' ' in the `LICENSE` file to make it more accessible to the community.', 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 index c8dad9f4b..986b8df12 100644 --- 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 @@ -41,7 +41,7 @@ "grantedPoints": 15, "maxPoints": 30, "status": "failed", - "summary": "### [x] 0/10 points: Provide a valid `pubspec.yaml`\n\n
\n\nSdk-constraint doesn't allow future stable dart 2.x releases\n\n\n`pubspec.yaml:6:8`\n\n```\n ╷\n6 │ sdk: \">=2.12.0-0 <2.12.0\"\n │ ^^^^^^^^^^^^^^^^^^^^\n ╵\n```\n\n
\n
\n\nThe package description is too short.\n\n\nAdd more detail to the `description` field of `pubspec.yaml`. Use 60 to 180 characters to describe the package, what it does, and its target use case.\n
\n
\n\nFailed to verify repository URL.\n\n\nPlease provide a valid [`repository`](https://dart.dev/tools/pub/pubspec#repository) URL in `pubspec.yaml`, such that:\n\n * `repository` can be cloned,\n * a clone of the repository contains a `pubspec.yaml`, which:,\n * contains `name: _dummy_pkg`,\n * contains a `version` property, and,\n * does not contain a `publish_to` property.\n\n`pkg/pub_integration/test_data/_dummy_pkg/pubspec.yaml` from the repository has no `version`.\n
\n\n### [*] 5/5 points: Provide a valid `README.md`\n\n\n### [x] 0/5 points: Provide a valid `CHANGELOG.md`\n\n
\n\nNo `CHANGELOG.md` found.\n\n\nChangelog entries help developers follow the progress of your package. See the [example](https://raw.githubusercontent.com/dart-lang/stagehand/master/templates/package-simple/CHANGELOG.md) generated by `stagehand`.\n
\n\n### [*] 10/10 points: Use an OSI-approved license\n\nDetected license: `BSD-3-Clause`." + "summary": "### [x] 0/10 points: Provide a valid `pubspec.yaml`\n\n
\n\nSdk-constraint doesn't allow future stable dart 2.x releases\n\n\n`pubspec.yaml:6:8`\n\n```\n ╷\n6 │ sdk: \">=2.12.0-0 <2.12.0\"\n │ ^^^^^^^^^^^^^^^^^^^^\n ╵\n```\n\n
\n
\n\nThe package description is too short.\n\n\nAdd more detail to the `description` field of `pubspec.yaml`. Use 60 to 180 characters to describe the package, what it does, and its target use case.\n
\n
\n\nFailed to verify repository URL.\n\n\nPlease provide a valid [`repository`](https://dart.dev/tools/pub/pubspec#repository) URL in `pubspec.yaml`, such that:\n\n * `repository` can be cloned,\n * a clone of the repository contains a `pubspec.yaml`, which:,\n * contains `name: _dummy_pkg`,\n * contains a `version` property, and,\n * does not contain a `publish_to` property.\n\n`pkg/pub_integration/test_data/_dummy_pkg/pubspec.yaml` from the repository has no `version`.\n
\n\n### [*] 5/5 points: Provide a valid `README.md`\n\n\n### [x] 0/5 points: Provide a valid `CHANGELOG.md`\n\n
\n\nNo `CHANGELOG.md` found.\n\n\nChangelog entries help developers follow the progress of your package. Check out the Dart conventions for [Maintaining a package changelog](https://dart.dev/tools/pub/package-layout#changelog).\n
\n\n### [*] 10/10 points: Use an OSI-approved license\n\nDetected license: `BSD-3-Clause`." }, { "id": "documentation", 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 index eefa31ee1..261a4db41 100644 --- 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 @@ -50,7 +50,7 @@ Please provide a valid [`repository`](https://dart.dev/tools/pub/pubspec#reposit No `CHANGELOG.md` found. -Changelog entries help developers follow the progress of your package. See the [example](https://raw.githubusercontent.com/dart-lang/stagehand/master/templates/package-simple/CHANGELOG.md) generated by `stagehand`. +Changelog entries help developers follow the progress of your package. Check out the Dart conventions for [Maintaining a package changelog](https://dart.dev/tools/pub/package-layout#changelog). ### [*] 10/10 points: Use an OSI-approved license