deps.zig Reference
This file is generated by zigmod fetch or zigmod ci and is an amalgamation of all of the sources and dependencies used in this project. Many of the fields listed here align with fields present in zigmod.yml but contain those values for the entire dependency tree.
cache
- Type:
[]const u8The relative path root to which all dependency sources are saved. Currently always.zigmod/deps.Note: only available when made with
zigmod fetch.
fetch
- Type:
pub fn (exe: *std.build.LibExeObjStep) voidA helper function to automatically pull in dependencies, purely from thezig buildsystem without the need to havezigmodinstalled.Note: only available when made with
zigmod generate.
addAllTo
- Type:
pub fn (exe: *std.build.LibExeObjStep) voidA helper function to add all of the packages, C files, and system libraries to the passed exectuable. It will also automatically link libC in the event that any C files are found in the dependency tree.
Package
pub const Package = struct {
directory: string,
pkg: ?Pkg = null,
c_include_dirs: []const string = &.{},
c_source_files: []const string = &.{},
c_source_flags: []const string = &.{},
system_libs: []const string = &.{},
frameworks: []const string = &.{},
};
package_data
- Type:
struct<ID, Package>This is a meta struct that associates ID’s to their relavantPackagedefinition.
packages
- Type:
[]PackageThis is a an array of all of the items inpackage_data, but only contains the final versions ofdev_dependencies.
pkgs
- Type:
struct<NAME, Package>This is a struct that associates the package name to the relavantPackage. The only packages listed are the dependencies of the root project.
imports
- Type:
struct<NAME, @import(main)>This is a struct that contains the imports of yourdev_dependencies. Added in response to zig#2206.