Tool

Information about a particular tool that is available to a plugin.

Context.swift:98
struct Tool

Other members in extension

Instance members

  • let package: Package

    Information about the package to which the plugin is being applied.

  • let pluginWorkDirectoryURL: URL

    The path of a writable directory into which the plugin or the build commands it constructs can write anything it wants. This could include any generated source files that should be processed further, and it could include any caches used by the build tool or the plugin itself. The plugin is in complete control of what is written under this di- rectory, and the contents are preserved between builds.

  • func tool(named: String) throws -> Tool

    Looks up and returns the path of a named command line executable tool. The executable must be provided by an executable target or a binary target on which the package plugin target depends. This function throws an error if the tool cannot be found. The lookup is case sensitive.

Show obsolete interfaces (1)

Hide obsolete interfaces

  • let pluginWorkDirectory: Path

    The path of a writable directory into which the plugin or the build commands it constructs can write anything it wants. This could include any generated source files that should be processed further, and it could include any caches used by the build tool or the plugin itself. The plugin is in complete control of what is written under this di- rectory, and the contents are preserved between builds.

Citizens in PackagePlugin

Instance members

Show obsolete interfaces (1)

Hide obsolete interfaces

  • let path: Path

    Full path of the built or provided tool in the file system.