Skip to content

Add conceptual documentation for SwiftPM plugins #9543

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Viditgupta-official wants to merge 1 commit into
base: main
Choose a base branch
from
+24 −0
Open

Add conceptual documentation for SwiftPM plugins #9543

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions Sources/PackageManagerDocs/Documentation.docc/Package/Plugins.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Plugins

Swift Package Manager supports plugins that can extend package functionality.

## Overview

There are two kinds of plugins in SwiftPM:

- **Command plugins**, which are invoked explicitly by users.
- **Build tool plugins**, which are applied to targets during the build.

## Build Tool Plugins

Build tool plugins are executed by the build system and may generate files
that are used as inputs to compilation.

## Plugin Outputs and Visibility

Plugins may generate files that are tracked by the build system for incremental
builds. Generated files are associated with the target the plugin is applied to.

Plugins do not form a pipeline, and outputs produced by one plugin are not
guaranteed to be visible to other plugins.