Skip to content
This repository was archived by the owner on Feb 22, 2023. It is now read-only.

Add pubspec convention checks #3984

Merged
merged 9 commits into from
May 28, 2021

Conversation

stuartmorgan-g
Copy link
Contributor

  • Creates a new pubspec-check command that validates that pubspecs
    follow repo conventions:
    • Use of repository, not homepage
    • Including an issue_tracker
    • Ordering major sections the same way
  • Enables the check in CI

This also fixes all issues found by the new check. No plugin version changes are included because the changes are either to examples, which don't need to be published, or the newly-discontinued plugins, for which it was simpler to just fix the violations that set up exclusions.

Fixes flutter/flutter#82913

Pre-launch Checklist

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • I read the Tree Hygiene wiki page, which explains my responsibilities.
  • I read and followed the Flutter Style Guide and the C++, Objective-C, Java style guides. (Note that unlike the flutter/flutter repo, the flutter/plugins repo does use dart format. See plugin_tool format)
  • I signed the CLA.
  • The title of the PR starts with the name of the plugin surrounded by square brackets, e.g. [shared_preferences]
  • I listed at least one issue that this PR fixes in the description above.
  • I updated pubspec.yaml with an appropriate new version according to the pub versioning philosophy.
  • I updated CHANGELOG.md to add a description of the change.
  • I updated/added relevant documentation (doc comments with ///).
  • I added new tests to check the change I am making or feature I am adding, or Hixie said the PR is test exempt.
  • All existing and new tests are passing.

- Creates a new `pubspec-check` command that validates that pubspecs
  follow repo conventions:
  - Use of repository, not homepage
  - Including an issue_tracker
  - Ordering major sections the same way
- Enables the check in CI

This also fixes all issues found by the new check.
@@ -59,7 +59,6 @@ void main() {
]),
);

print(processRunner.recordedCalls);
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These changes are because I was copying from existing tests and noticed that they were spammy; this was presumably left from debugging the tests when they were being written.

gaaclarke
gaaclarke previously approved these changes May 27, 2021
Copy link
Member

@gaaclarke gaaclarke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

Copy link
Member

@ditman ditman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great to me! Some tiny nitpicks below.

@gaaclarke gaaclarke dismissed their stale review May 27, 2021 21:10

The link in the email didn't send me to a review with all the changes, just one patch.

@stuartmorgan-g stuartmorgan-g added the waiting for tree to go green (Use "autosubmit") This PR is approved and tested, but waiting for the tree to be green to land. label May 28, 2021
@fluttergithubbot fluttergithubbot merged commit 2b1cc57 into flutter:master May 28, 2021
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request May 28, 2021
fluttergithubbot pushed a commit to flutter/flutter that referenced this pull request May 28, 2021
yasargil added a commit to yasargil/plugins that referenced this pull request Jun 2, 2021
* master: (131 commits)
  [in_app_purchase] fix "autoConsume" param in "buyConsumable" (flutter#3957)
  [video_player_web] fix: set autoplay to false during initialization (flutter#3985)
  [multiple_web] Adapt web PlatformView widgets to work slotted. (flutter#3964)
  [url_launcher] Add iOS unit and UI tests (flutter#3987)
  [image_picker] Change storage location for camera captures to internal cache on Android, to comply with new Google Play storage requirements.  (flutter#3956)
  [script/tool] Use 'dart pub' instead of deprecated 'pub' (flutter#3991)
  [video_player] Add iOS unit and UI tests (flutter#3986)
  Add pubspec convention checks (flutter#3984)
  Enable pubspec dependency sorting lint (flutter#3983)
  [image_picker] Migrate maven repo from jcenter to mavenCentral (flutter#3915)
  [video_player] Update README.md (flutter#3975)
  [script/tool] speed up the pub get portion of the analyze command (flutter#3982)
  Revert commit e742a7b (flutter#3976)
  Added support to request list of purchases (flutter#3944)
  [google_maps_flutter] Add iOS unit and UI tests (flutter#3978)
  Added Windows to the description (flutter#3936)
  use 'flutter pub get' for both dart and flutter packages (flutter#3973)
  [camera] android-rework part 3: Android exposure related features (flutter#3797)
  Remove exoplayer workaround from everything but video_player (flutter#3980)
  Allow reverts when checking versions (flutter#3981)
  ...
fotiDim pushed a commit to fotiDim/plugins that referenced this pull request Sep 13, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.