Dependencies

Work-in-Progress Documentation

The content on this page is not yet fully finished.

Tracking issue: https://github.com/dlang/dub-docs/issues/64

Recipe details

This page details values for a DUB recipe setting.

For syntax, see build settings

Dependency syntax

`version`

See version specifiers.

version="*"
version="==a.b.c"
version="~>a.b.c"
version="~>a.b"
version=">=a"
version=">=a <b"
version="<b"

	(no release)	v0.0.1	v0.1.0	v0.2.0	v1.0.0	v2.0.0
`version="*"`	✓	✓	✓	✓	✓	✓
`version="==0.0.1"`		✓
`version="~>0.1.0"`			✓
`version="~>0.1"`			✓	✓
`version=">=0.1.0"`			✓	✓	✓	✓
`version=">=0.1.0 <1.0.0"`			✓	✓
`version="<2.0.0"`		✓	✓	✓	✓

`version` + `optional`

`version` + `optional` + `default=false`

`path`

Note

For public projects, avoid leaving your package root, so that users can build your package without needing to manage external dependencies.

Inside sub-packages you can refer to the parent package using path=".." (or elsewhere, depending on folder structure), to avoid DUB accidentally looking up a different package location whenever you run DUB from inside the sub-package folder.

`repository`

Git repositories

`dflags`

`dub.selections.json`

`dub add-path`

This command provides the basis for a Git based development workflow across a set of multiple interdependent packages. Any directory that gets added using dub add-path will get searched for sub folders containing DUB packages whenever dependencies are resolved. During the build, any such package will have precedence over packages that have been fetched by DUB automatically, provided that its version matches the selected version for the project. In particular, a version, such as "1.0.0+commit.9.a25f316" (9 commits ahead of 1.0.0) will match "1.0.0".

This approach allows to check out working copies of packages that are relevant to a project and have any changes, including new commits, be picked up in the build, without having to publish new version tags or having to modify packages recipes or selections to manually point to the path of the working copy.

dub add-local is a more selective version of this command and ca be used to register individual package folders.

CLI docs: dub add-path

`dub add-local`

Adds a directory to be searched for a valid DUB package recipe when collecting dependencies during a build. The version of the package will be inferred by the latest Git tag, in case the directory is a Git working copy. This is a more selective version of the dub add-path command and only registers a single package directory instead of a whole package directory search path.

CLI docs: dub add-local

Dependency/version resolution

Per-configuration dependencies

`Have_xyz`

Work-in-Progress Documentation

The content on this section is not yet fully finished.

Tracking issue: https://github.com/dlang/dub-docs/issues/55

Projects can have additional special dependencies for specific configurations.

"configurations": [
    {
        "name": "myconfig",
        "dependencies": {
            "mydep": { "version": "*" }
        }
    }
]

DUB provides version identifier of dependencies for conditional compilation with version conditions. Have_<dependency> version identifier can be used for conditional compilation.

Note

Special characters other than identifier characters ([a-z, A-Z, 0-9, _]) in dependency name are replaced with an underscore (_) character in their version identifier.

version (Have_mydep) {
    // dependency "mydep" is being included
    import mydep;
}
version (Have_vibe_d_http) {
    // dependency "vibe-d:http" is being included
}

Note that your package has to somehow depend on the package for it to get these Have_* version identifiers. If you want to query for it without pulling in a new dependency, use optional dependencies:

"dependencies": {
    "vibe-d:http": { "optional": true, "version": "*" }
}

Last update: April 2, 2024
Created: September 1, 2023

Dependencies

Dependency syntax

version

version + optional

version + optional + default=false

path

repository