Configurable Command Plugin Build Configuration #1409
Merged
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
Packages can define their own plugins either directly or through
their dependencies. These plugins define commands, and the extension
exposes a list of these when you use `> Swift: Run Command Plugin`.
It may be desirable to build and run these plugins with specific
arguments. This patch introduces a new setting that can be specified
globally or on a per workspace folder basis that allows users to
configure arguments to pass to plugin command invocations.
The setting is defined under `swift.pluginArguments`, and is specified
as an object in the following form:
```json
{
"PluginCommandName:intent-name": ["--some", "--args"]
}
```
- The top level string key is the command id in the form
`PluginCommandName:intent-name`. For instance, swift-format's
format-source-code command would be specified as
`swift-format:format-source-code`
- Specifying `PluginCommandName` will apply the arguments to all intents
in the command plugin
- Specifying `*` will apply the arguments to all commands.
This patch also adds this wildcard functionality to the
`swift.pluginPermissions` setting.
Issue: swiftlang#1365
plemarquand
requested review from
adam-fowler,
0xTim and
award999
as code owners
MahdiBM
approved these changes
Feb 27, 2025
|
@MahdiBM I think because for backwards compatibility sake, because we've already released with pluginPermissions, we shouldn't roll it in to the more generic pluginArguments. It would also make the settings validation more tricky since it could be either one of the permissions values, or a freeform argument. |
matthewbastien
approved these changes
Mar 11, 2025
rbenegal
reviewed
Mar 11, 2025
rbenegal
approved these changes
Mar 11, 2025
Co-authored-by: Rishi <[email protected]>
|
Verified with 82fb69c |
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.
Packages can define their own plugins either directly or through their dependencies. These plugins define commands, and the extension exposes a list of these when you use
> Swift: Run Command Plugin.It may be desirable to build and run these plugins with specific arguments. This patch introduces a new setting that can be specified globally or on a per workspace folder basis that allows users to configure arguments to pass to plugin command invocations.
The setting is defined under
swift.pluginArguments, and is specified as an object in the following form:{ "PluginCommandName:intent-name": ["--some", "--args"] }PluginCommandName:intent-name. For instance, swift-format's format-source-code command would be specified asswift-format:format-source-codePluginCommandNamewill apply the arguments to all intents in the command plugin*will apply the arguments to all commands.This patch also adds this wildcard functionality to the
swift.pluginPermissionssetting.Issue: #1365