[go: nahoru, domu]

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

[tool] Clean up "plugin" references #6503

Merged
merged 3 commits into from
Sep 27, 2022

Conversation

stuartmorgan
Copy link
Contributor

Historically the tooling was written for plugins, and then was later extended to packages in general. We've done some incremental fixup over time as parts of the tooling were modified, but there are still random references to "plugin" where we actually mean "package", which can be confusing to maintainers of the code (and in the case of the publish-plugin command, and list types, to tool clients).

This is the result of auditing references to "plugin" and fixing the ones that were incorrect.

(It is still the case that most tests use createFakePlugin when they could use the newer createFakePackage; I fixed a few of those but then realized that the change would be enormous if I continued, and those are pretty harmless, so I left the rest.)

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 relevant style guides and ran the auto-formatter. (Unlike the flutter/flutter repo, the flutter/plugins repo does use dart 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, or this PR is exempt from version changes.
  • I updated CHANGELOG.md to add a description of the change, following repository CHANGELOG style.
  • I updated/added relevant documentation (doc comments with ///).
  • I added new tests to check the change I am making, or this PR is test-exempt.
  • All existing and new tests are passing.

test('lists plugins', () async {
createFakePlugin('plugin1', packagesDir);
test('lists top-level packages', () async {
createFakePackage('package1', packagesDir);
createFakePlugin('plugin2', packagesDir);
Copy link
Contributor

Choose a reason for hiding this comment

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

was leaving plugin2 (and later plugin3) intentional?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, it was to create a mix. Ideally more tests would be using a mix of plugins and packages just to make sure there aren't any unintended behaviors for one type but not the other.

@tarrinneal tarrinneal self-requested a review September 27, 2022 19:18
Copy link
Contributor
@tarrinneal tarrinneal left a comment

Choose a reason for hiding this comment

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

that's a lot of packages

@tarrinneal tarrinneal added the autosubmit Merge PR when tree becomes green via auto submit App label Sep 27, 2022
@auto-submit auto-submit bot merged commit 2592df9 into flutter:main Sep 27, 2022
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Sep 28, 2022
adam-harwood pushed a commit to adam-harwood/flutter_plugins that referenced this pull request Nov 3, 2022
mauricioluz pushed a commit to mauricioluz/plugins that referenced this pull request Jan 26, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
autosubmit Merge PR when tree becomes green via auto submit App
Projects
None yet
2 participants