857935c3
Gregory Mullen
.{
857935c3
Gregory Mullen
// This is the default name used by packages depending on this one. For
857935c3
Gregory Mullen
// example, when a user runs `zig fetch --save <url>`, this field is used
857935c3
Gregory Mullen
// as the key in the `dependencies` table. Although the user can choose a
857935c3
Gregory Mullen
// different name, most users will stick with this provided value.
857935c3
Gregory Mullen
//
857935c3
Gregory Mullen
// It is redundant to include "zig" in this name because it is already
857935c3
Gregory Mullen
// within the Zig package namespace.
857935c3
Gregory Mullen
.name = "zig^2bee",
857935c3
Gregory Mullen
857935c3
Gregory Mullen
// This is a [Semantic Version](https://semver.org/).
857935c3
Gregory Mullen
// In a future version of Zig it will be used for package deduplication.
857935c3
Gregory Mullen
.version = "0.0.0",
857935c3
Gregory Mullen
857935c3
Gregory Mullen
// This field is optional.
857935c3
Gregory Mullen
// This is currently advisory only; Zig does not yet do anything
857935c3
Gregory Mullen
// with this value.
857935c3
Gregory Mullen
//.minimum_zig_version = "0.11.0",
857935c3
Gregory Mullen
857935c3
Gregory Mullen
// This field is optional.
857935c3
Gregory Mullen
// Each dependency must either provide a `url` and `hash`, or a `path`.
857935c3
Gregory Mullen
// `zig build --fetch` can be used to fetch all dependencies of a package, recursively.
857935c3
Gregory Mullen
// Once all dependencies are fetched, `zig build` no longer requires
857935c3
Gregory Mullen
// internet connectivity.
857935c3
Gregory Mullen
.dependencies = .{
857935c3
Gregory Mullen
// See `zig fetch --save <url>` for a command-line interface for adding dependencies.
857935c3
Gregory Mullen
//.example = .{
857935c3
Gregory Mullen
// // When updating this field to a new URL, be sure to delete the corresponding
857935c3
Gregory Mullen
// // `hash`, otherwise you are communicating that you expect to find the old hash at
857935c3
Gregory Mullen
// // the new URL.
857935c3
Gregory Mullen
// .url = "https://example.com/foo.tar.gz",
857935c3
Gregory Mullen
//
857935c3
Gregory Mullen
// // This is computed from the file contents of the directory of files that is
857935c3
Gregory Mullen
// // obtained after fetching `url` and applying the inclusion rules given by
857935c3
Gregory Mullen
// // `paths`.
857935c3
Gregory Mullen
// //
857935c3
Gregory Mullen
// // This field is the source of truth; packages do not come from a `url`; they
857935c3
Gregory Mullen
// // come from a `hash`. `url` is just one of many possible mirrors for how to
857935c3
Gregory Mullen
// // obtain a package matching this `hash`.
857935c3
Gregory Mullen
// //
857935c3
Gregory Mullen
// // Uses the [multihash](https://multiformats.io/multihash/) format.
857935c3
Gregory Mullen
// .hash = "...",
857935c3
Gregory Mullen
//
857935c3
Gregory Mullen
// // When this is provided, the package is found in a directory relative to the
857935c3
Gregory Mullen
// // build root. In this case the package's hash is irrelevant and therefore not
857935c3
Gregory Mullen
// // computed. This field and `url` are mutually exclusive.
857935c3
Gregory Mullen
// .path = "foo",
857935c3
Gregory Mullen
857935c3
Gregory Mullen
// // When this is set to `true`, a package is declared to be lazily
857935c3
Gregory Mullen
// // fetched. This makes the dependency only get fetched if it is
857935c3
Gregory Mullen
// // actually used.
857935c3
Gregory Mullen
// .lazy = false,
857935c3
Gregory Mullen
//},
857935c3
Gregory Mullen
},
857935c3
Gregory Mullen
857935c3
Gregory Mullen
// Specifies the set of files and directories that are included in this package.
857935c3
Gregory Mullen
// Only files and directories listed here are included in the `hash` that
857935c3
Gregory Mullen
// is computed for this package. Only files listed here will remain on disk
857935c3
Gregory Mullen
// when using the zig package manager. As a rule of thumb, one should list
857935c3
Gregory Mullen
// files required for compilation plus any license(s).
857935c3
Gregory Mullen
// Paths are relative to the build root. Use the empty string (`""`) to refer to
857935c3
Gregory Mullen
// the build root itself.
857935c3
Gregory Mullen
// A directory listed here means that all files within, recursively, are included.
857935c3
Gregory Mullen
.paths = .{
857935c3
Gregory Mullen
"build.zig",
857935c3
Gregory Mullen
"build.zig.zon",
857935c3
Gregory Mullen
"src",
857935c3
Gregory Mullen
// For example...
857935c3
Gregory Mullen
//"LICENSE",
857935c3
Gregory Mullen
//"README.md",
857935c3
Gregory Mullen
},
857935c3
Gregory Mullen
}