PackageRecipe

Represents the contents of a package recipe file (dub.json/dub.sdl) in an abstract way.

This structure is used to reason about package descriptions in isolation. For higher level package handling, see the Package class.

struct PackageRecipe {

string description;

string homepage;

string[] authors;

string copyright;

string license;

ToolchainRequirements toolchainRequirements;

ConfigurationInfo[] configurations;

BuildSettingsTemplate[string] buildTypes;

BuildSettingsTemplate buildSettings;

@Name("-ddoxFilterArgs")

string[] ddoxFilterArgs;

@Name("-ddoxTool")

string ddoxTool;

SubPackage[] subPackages;

@Name("version")

string version_;

inout(ConfigurationInfo) getConfiguration(string name);

PackageRecipe clone();

}

Alias This

Members

Functions

clone PackageRecipe clone(): Clones the package recipe recursively.
getConfiguration inout(ConfigurationInfo) getConfiguration(string name): Undocumented in source. Be warned that the author may not have intended to support it.

Variables

authors string[] authors;: List of project authors
buildSettings BuildSettingsTemplate buildSettings;: Build settings influence the command line arguments and options passed to the compiler and linker.
buildTypes BuildSettingsTemplate[string] buildTypes;: Defines additional custom build types or overrides the default ones
configurations ConfigurationInfo[] configurations;: Specifies an optional list of build configurations
copyright string copyright;: Copyright declaration string
ddoxFilterArgs string[] ddoxFilterArgs;: Specifies a list of command line flags usable for controlling filter behavior for --build=ddox experimental
ddoxTool string ddoxTool;: Specify which tool to use with --build=ddox (experimental)
description string description;: Brief description of the package.
homepage string homepage;: URL of the project website
license string license;: License(s) under which the project can be used
name string name;: Name of the package, used to uniquely identify the package.
subPackages SubPackage[] subPackages;: Sub-packages path or definitions
toolchainRequirements ToolchainRequirements toolchainRequirements;: Set of version requirements for DUB, compilers and/or language frontend.
version_ string version_;: Usually unused by users, this is set by dub automatically

Meta

Source

See Implementation

dub recipe packagerecipe functions

structs