Add templates for build tool plugins and command plugins #6111

neonichu · 2023-02-02T21:31:51Z

Adds command plugin and build tool plugin templates to swift package init.

rdar://107288352

Sources/Workspace/InitPackage.swift

abertelrud · 2023-03-27T20:47:27Z

Rebased on main and resolved conflicts with the changes to add template for compiler macros.

… in #6250 The loss of this newline seems to have been unintentional and changed the behaviour from what it was in SwiftPM 5.8. This commit restores it.

tomerd · 2023-03-27T22:49:55Z

@abertelrud is this ready for review, or still WIP?

This is fairly minimal at the moment, and doesn't try to be a tutorial on how to write command plugins. Needs a unit test. rdar://107288352

rdar://107288352

…n packages Most often these plugins are vended to other packages using products, so it makes sense to include this from the start.

abertelrud · 2023-03-27T23:11:50Z

@swift-ci please smoke test

abertelrud · 2023-03-27T23:12:58Z

@abertelrud is this ready for review, or still WIP?

Just pushed an update that makes it no longer WIP. I haven't yet changed it over to use associated types for the enum, but will do that separately, ideally as a follow-on to this PR after applying other feedback.

abertelrud · 2023-03-27T23:13:51Z

I'm thinking that this should also add the #if XcodeProjectPlugin that's needed?

Sources/Workspace/InitPackage.swift

abertelrud · 2023-03-27T23:17:51Z

Sources/Workspace/InitPackage.swift

+                    struct \(typeName): BuildToolPlugin {
+                        func createBuildCommands(context: PluginContext, target: Target) async throws -> [Command] {
+                            print("Hello, World!")
+                            return []


A more full-fledged starting point would be to have a shared function between the SwiftPM and Xcode API, and some boilerplate to construct a sample build command. Not sure how far to go in that direction.

I think having a sample build command would be good.

A bit less sure about how to handle Xcode vs. SwiftPM plugins, on the one hand, shared function is obviously the right thing for many use cases, on the other hand it could potentially make it confusing that the two entry points even exist?

cc @bitjammer @TimTr for opinions on the content of these templates

In the long run, it might make sense to have an option for whether or not to add the Xcode specifics. We can leave it out for now but maybe include the URL of the plugins Markdown here in the SwiftPM repository, which talks about how to add them. That would seem to be in line with how the argument parser template works (it puts in this comment: // https://swiftpackageindex.com/apple/swift-argument-parser/documentation).

@tomerd good point that these seem to be using the older style of always having a /Sources/<target>/ folder structure. With the updated templates for executables using just /Sources/ the base templates can start a bit cleaner. Also note this PR: #6294 which makes the SwiftPM folder search path work with /Sources/ by default (no need for a path: entry), and also work with the traditional per-target folder model. So either option is now supported by default.

I don't have a strong opinion for these templates using the traditional or simplified model. But if the common case will be a single target, may be nice to stick with the simpler approach.

Simplified model sounds good given that the manifest doesn't have to be made more complicated. I'll update the PR. Thanks!

@TimTr What about the point about whether or not to include the optional XcodeProjectPlugin support to make it easier for new plugins to work with Xcode projects out-of-the-box.

Anything specific to Xcode feels like it shouldn't be there by default in the CLI tools. I could see an option (making the command pretty long to manually type, but trivial for tooling) to support tools like Xcode, or VSCode, or others. This could then be used when a user is inside Xcode already, pretty seamlessly, without implying to the rest of the Swift world that Swift is tied to Xcode.

neonichu

Hah, can't approve since I am the person who opened the PR, but LGTM. Thanks for taking this over.

Sources/Workspace/InitPackage.swift

… plugin code

…e rules to the text In the long run, it would be better for this code to construct a `Manifest` and then use `ManifestSourceGeneration` to generate the text

abertelrud · 2023-03-28T23:26:20Z

@swift-ci smoke test

abertelrud · 2023-03-28T23:26:30Z

@swift-ci test windows

abertelrud · 2023-03-28T23:27:38Z

@tomerd @neonichu Updated contents and formatting. Also, what's the magic trick to getting the windows testing to run — it's not starting despite @swift-ci test windows etc.

tomerd · 2023-03-28T23:35:36Z

@swift-ci smoke test windows

Sources/Workspace/InitPackage.swift

tomerd · 2023-03-28T23:37:42Z

Sources/Workspace/InitPackage.swift

+                struct \(typeName): BuildToolPlugin {
+                    func createBuildCommands(context: PluginContext, target: Target) async throws -> [Command] {
+                        // The plugin can choose what parts of the package to process.
+                        guard let target = target as? SourceModuleTarget else { return [] }


I think we have a nice API for this? @neonichu ?

We do have

public extension Target { /// Convenience accessor which casts the receiver to`SourceModuleTarget` if possible. var sourceModule: SourceModuleTarget? { return self as? SourceModuleTarget } }

So we do this instead?

let sourceFiles = target.sourceModule?.sourceFiles ?? []

And then proceed as if the target had source files even if it doesn't?

Actually that doesn't work since one is a FileList? and the other an array.

So maybe just:

guard let sourceFiles = target.sourceModule?.sourceFiles else { return [] }

I went ahead and made this change.

Sources/Workspace/InitPackage.swift

abertelrud · 2023-03-28T23:49:56Z

@swift-ci smoke test windows

Hm, that didn't work either. @shahmishal are we doing something wrong in how we're invoking the Windows testing here?

abertelrud · 2023-03-29T00:35:19Z

@swift-ci test

abertelrud · 2023-03-29T00:35:46Z

@swift-ci smoke test

MaxDesiatov · 2023-03-29T08:26:26Z

@swift-ci test windows

) Adds templates for build tool plugins and command plugins, allowing them to be created from the `swift package init` command. The packages are set up to vend the plugins via plugin product declarations, so they can be used by other packages. The initial code for each each plugin type is minimal, but for the build tool plugin type it shows how to create and return a build command for each source file of a particular type, since that's the most common use of build tool plugins. rdar://107288352 Co-authored-by: Anders Bertelrud <[email protected]> (cherry picked from commit f25e138)

neonichu self-assigned this Feb 2, 2023

tomerd reviewed Feb 3, 2023

View reviewed changes

Sources/Workspace/InitPackage.swift Outdated Show resolved Hide resolved

abertelrud reviewed Mar 23, 2023

View reviewed changes

Sources/Workspace/InitPackage.swift Show resolved Hide resolved

abertelrud self-assigned this Mar 27, 2023

abertelrud force-pushed the add-cmd-plugin-template branch from 95eebe3 to fb4fbaa Compare March 27, 2023 20:46

Restore a line of blank space in the generated manifest that was lost…

472e441

… in #6250 The loss of this newline seems to have been unintentional and changed the behaviour from what it was in SwiftPM 5.8. This commit restores it.

neonichu and others added 5 commits March 27, 2023 15:54

Add template support for creating a command plugin package

15905c9

This is fairly minimal at the moment, and doesn't try to be a tutorial on how to write command plugins. Needs a unit test. rdar://107288352

Add a unit test for the package command plugin template

1779745

Add template support for creating a build tool package plugin

dc414f2

rdar://107288352

Update the CHANGELOG

95784f7

Add product types for the created build tool plugin and command plugi…

1e0d950

…n packages Most often these plugins are vended to other packages using products, so it makes sense to include this from the start.

abertelrud force-pushed the add-cmd-plugin-template branch from fb4fbaa to 1e0d950 Compare March 27, 2023 23:09

abertelrud changed the title ~~WIP: Add a template for a command plugin~~ Add templates for build tool plugins and command plugins Mar 27, 2023

abertelrud marked this pull request as ready for review March 27, 2023 23:13

abertelrud reviewed Mar 27, 2023

View reviewed changes

Sources/Workspace/InitPackage.swift Show resolved Hide resolved

abertelrud reviewed Mar 27, 2023

View reviewed changes

Sources/Workspace/InitPackage.swift Show resolved Hide resolved

abertelrud reviewed Mar 27, 2023

View reviewed changes

neonichu commented Mar 28, 2023

View reviewed changes

Sources/Workspace/InitPackage.swift Outdated Show resolved Hide resolved

Sources/Workspace/InitPackage.swift Outdated Show resolved Hide resolved

tomerd reviewed Mar 28, 2023

View reviewed changes

Sources/Workspace/InitPackage.swift Show resolved Hide resolved

abertelrud added 3 commits March 28, 2023 14:44

Updated the comment that's added for plugin products

1af80a4

Use the flat package structure (no separate module directory) for the…

807d96d

… plugin code

Fix formatting by running swiftformat on the output and applying thos…

6340897

…e rules to the text In the long run, it would be better for this code to construct a `Manifest` and then use `ManifestSourceGeneration` to generate the text

tomerd reviewed Mar 28, 2023

View reviewed changes

Sources/Workspace/InitPackage.swift Show resolved Hide resolved

tomerd reviewed Mar 28, 2023

View reviewed changes

Sources/Workspace/InitPackage.swift Show resolved Hide resolved

Add more helpful contents to the newly generated build tool plugin

32501f6

abertelrud force-pushed the add-cmd-plugin-template branch from 115784c to 32501f6 Compare March 29, 2023 00:33

tomerd approved these changes Mar 29, 2023

View reviewed changes

abertelrud merged commit f25e138 into main Mar 29, 2023

abertelrud mentioned this pull request Mar 29, 2023

[5.9] Add templates for build tool plugins and command plugins (#6111) #6352

Merged

tomerd deleted the add-cmd-plugin-template branch May 1, 2023 17:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add templates for build tool plugins and command plugins #6111

Add templates for build tool plugins and command plugins #6111

neonichu commented Feb 2, 2023 •

edited by abertelrud

Loading

abertelrud commented Mar 27, 2023

tomerd commented Mar 27, 2023

abertelrud commented Mar 27, 2023

abertelrud commented Mar 27, 2023

abertelrud commented Mar 27, 2023

abertelrud Mar 27, 2023

neonichu Mar 28, 2023

tomerd Mar 28, 2023

abertelrud Mar 28, 2023

TimTr Mar 28, 2023

abertelrud Mar 28, 2023

abertelrud Mar 28, 2023

TimTr Mar 31, 2023

neonichu left a comment

abertelrud commented Mar 28, 2023

abertelrud commented Mar 28, 2023

abertelrud commented Mar 28, 2023

tomerd commented Mar 28, 2023

tomerd Mar 28, 2023

neonichu Mar 28, 2023

abertelrud Mar 28, 2023

abertelrud Mar 29, 2023 •

edited

Loading

abertelrud Mar 29, 2023

abertelrud commented Mar 28, 2023

abertelrud commented Mar 29, 2023

abertelrud commented Mar 29, 2023

MaxDesiatov commented Mar 29, 2023

Add templates for build tool plugins and command plugins #6111

Add templates for build tool plugins and command plugins #6111

Conversation

neonichu commented Feb 2, 2023 • edited by abertelrud Loading

abertelrud commented Mar 27, 2023

tomerd commented Mar 27, 2023

abertelrud commented Mar 27, 2023

abertelrud commented Mar 27, 2023

abertelrud commented Mar 27, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

neonichu left a comment

Choose a reason for hiding this comment

abertelrud commented Mar 28, 2023

abertelrud commented Mar 28, 2023

abertelrud commented Mar 28, 2023

tomerd commented Mar 28, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abertelrud Mar 29, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abertelrud commented Mar 28, 2023

abertelrud commented Mar 29, 2023

abertelrud commented Mar 29, 2023

MaxDesiatov commented Mar 29, 2023

neonichu commented Feb 2, 2023 •

edited by abertelrud

Loading

abertelrud Mar 29, 2023 •

edited

Loading