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.

Sign up for GitHub

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

Replace references to long-deprecated stagehand #1341

Merged
merged 1 commit into from
Feb 21, 2024
Merged

Replace references to long-deprecated stagehand #1341

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 9 additions & 5 deletions lib/src/report/template.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<ReportSection> followsTemplate(PackageContext context) async {
final packageDir = context.packageDir;
Expand Down Expand Up @@ -239,13 +239,16 @@ Future<ReportSection> 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 = [
Expand Down Expand Up @@ -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.',
Expand Down
2 changes: 1 addition & 1 deletion test/goldens/end2end/_dummy_pkg-1.0.0-null-safety.1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
"grantedPoints": 15,
"maxPoints": 30,
"status": "failed",
"summary": "### [x] 0/10 points: Provide a valid `pubspec.yaml`\n\n<details>\n<summary>\nSdk-constraint doesn't allow future stable dart 2.x releases\n</summary>\n\n`pubspec.yaml:6:8`\n\n```\n ╷\n6 │ sdk: \">=2.12.0-0 <2.12.0\"\n │ ^^^^^^^^^^^^^^^^^^^^\n ╵\n```\n\n</details>\n<details>\n<summary>\nThe package description is too short.\n</summary>\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</details>\n<details>\n<summary>\nFailed to verify repository URL.\n</summary>\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</details>\n\n### [*] 5/5 points: Provide a valid `README.md`\n\n\n### [x] 0/5 points: Provide a valid `CHANGELOG.md`\n\n<details>\n<summary>\nNo `CHANGELOG.md` found.\n</summary>\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</details>\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<details>\n<summary>\nSdk-constraint doesn't allow future stable dart 2.x releases\n</summary>\n\n`pubspec.yaml:6:8`\n\n```\n ╷\n6 │ sdk: \">=2.12.0-0 <2.12.0\"\n │ ^^^^^^^^^^^^^^^^^^^^\n ╵\n```\n\n</details>\n<details>\n<summary>\nThe package description is too short.\n</summary>\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</details>\n<details>\n<summary>\nFailed to verify repository URL.\n</summary>\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</details>\n\n### [*] 5/5 points: Provide a valid `README.md`\n\n\n### [x] 0/5 points: Provide a valid `CHANGELOG.md`\n\n<details>\n<summary>\nNo `CHANGELOG.md` found.\n</summary>\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</details>\n\n### [*] 10/10 points: Use an OSI-approved license\n\nDetected license: `BSD-3-Clause`."
},
{
"id": "documentation",
Expand Down
2 changes: 1 addition & 1 deletion test/goldens/end2end/_dummy_pkg-1.0.0-null-safety.1.json_report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Please provide a valid [`repository`](https://dart.dev/tools/pub/pubspec#reposit
No `CHANGELOG.md` found.
</summary>

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).
</details>

### [*] 10/10 points: Use an OSI-approved license
Expand Down