Implement proposed adjustments to SE-0303 to use @main for plugins
#3712
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
abertelrud
requested review from
friedbunny,
neonichu and
tomerd
as code owners
abertelrud
force-pushed
the
eng/plugin-improvements
branch
from
0fb7392 to
27104d7
Compare
|
@swift-ci please smoke test |
abertelrud
force-pushed
the
eng/plugin-improvements
branch
from
27104d7 to
2d75055
Compare
|
@swift-ci please smoke test |
abertelrud
changed the title
@main for plugins@main for plugins
tomerd
reviewed
Sep 9, 2021
...scellaneous/Plugins/ContrivedTestPlugin/Plugins/MyAmbiguouslyNamedCommandPlugin/plugin.swift
Outdated
Show resolved
Hide resolved
tomerd
reviewed
Sep 9, 2021
tomerd
reviewed
Sep 9, 2021
tomerd
reviewed
Sep 9, 2021
|
|
||
| struct Diagnostic: Encodable { | ||
| enum Severity: String, Encodable { | ||
| case error, warning, remark |
There was a problem hiding this comment.
Maybe. Or note. In the amendment proposal this is remark, so we should also take it up there whether it should be something else.
tomerd
reviewed
Sep 9, 2021
tomerd
reviewed
Sep 9, 2021
tomerd
reviewed
Sep 9, 2021
tomerd
reviewed
Sep 9, 2021
abertelrud
force-pushed
the
eng/plugin-improvements
branch
2 times, most recently
from
2d12188 to
61abc08
Compare
|
@swift-ci please smoke test |
abertelrud
force-pushed
the
eng/plugin-improvements
branch
from
2dc5ea7 to
ec71d58
Compare
This is an implementation of the proposed adjustments to SE-0303 in swiftlang/swift-evolution#1434. This changes the entry point to use `@main` rather than top-level code, and introduces protocols for the entry points corresponding to the various plugin capabilities. It gets rid of the globals in favour of plugin parameters and return values (except for diagnostics, which are still collected using a process-wide list).
…ifications. Mark the Severity as public and add a method that takes it as a parameter.
abertelrud
force-pushed
the
eng/plugin-improvements
branch
from
ec71d58 to
aa295b0
Compare
|
@swift-ci please smoke test |
abertelrud
force-pushed
the
eng/plugin-improvements
branch
from
aa295b0 to
1ce1543
Compare
|
@swift-ci please smoke test |
|
@swift-ci please smoke test linux |
|
These Linux failures seem to be outside of the actual changes for this PR... they're also different each time; trying again. |
|
@swift-ci please smoke test linux |
|
lgtm 👍 |
tomerd
approved these changes
Sep 17, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is an implementation of almost all of the approved adjustments to SE-0303 proposed in swiftlang/swift-evolution#1434.
Motivation:
This changes the entry point to use
@mainrather than top-level code, and introduces protocols for the entry points corresponding to the various plugin capabilities. Using@mainallows customized entry points for each kind of plugin, makes it clearer what the inputs and expected outputs of each plugin are by replacing the global variables with method parameters and return values, and will make it easier to add new kinds of plugins in the future.Modifications:
static func main()that decodes input from SwiftPM and calls the pluginatexit()code for dumping output with similar code at the end of the staticmain()-parse-as-libraryso that@maincan be usedResult:
Plugins will use the new entry point as described in the amended SE-0303.
The one change left to make is to mark the entry point as
async. That cannot be done right now because it would make plugins unavailable on macOS 11 and earlier. Further work is needed to find a way to supportasyncwhen running on macOS 12 and later, while still supporting macOS 11 for plugins that don't needasyncAPIs.