|
| 1 | +.{ |
| 2 | + // This is the default name used by packages depending on this one. For |
| 3 | + // example, when a user runs `zig fetch --save <url>`, this field is used |
| 4 | + // as the key in the `dependencies` table. Although the user can choose a |
| 5 | + // different name, most users will stick with this provided value. |
| 6 | + // |
| 7 | + // It is redundant to include "zig" in this name because it is already |
| 8 | + // within the Zig package namespace. |
| 9 | + .name = "zfetch", |
| 10 | + |
| 11 | + // This is a [Semantic Version](https://semver.org/). |
| 12 | + // In a future version of Zig it will be used for package deduplication. |
| 13 | + .version = "0.0.0", |
| 14 | + |
| 15 | + // Together with name, this represents a globally unique package |
| 16 | + // identifier. This field is generated by the Zig toolchain when the |
| 17 | + // package is first created, and then *never changes*. This allows |
| 18 | + // unambiguous detection of one package being an updated version of |
| 19 | + // another. |
| 20 | + // |
| 21 | + // When forking a Zig project, this id should be regenerated (delete the |
| 22 | + // field and run `zig build`) if the upstream project is still maintained. |
| 23 | + // Otherwise, the fork is *hostile*, attempting to take control over the |
| 24 | + // original project's identity. Thus it is recommended to leave the comment |
| 25 | + // on the following line intact, so that it shows up in code reviews that |
| 26 | + // modify the field. |
| 27 | + .fingerprint = 0x5fb01b5abcaf00bb, // Changing this has security and trust implications. |
| 28 | + |
| 29 | + // Tracks the earliest Zig version that the package considers to be a |
| 30 | + // supported use case. |
| 31 | + .minimum_zig_version = "0.14.0", |
| 32 | + |
| 33 | + // This field is optional. |
| 34 | + // Each dependency must either provide a `url` and `hash`, or a `path`. |
| 35 | + // `zig build --fetch` can be used to fetch all dependencies of a package, recursively. |
| 36 | + // Once all dependencies are fetched, `zig build` no longer requires |
| 37 | + // internet connectivity. |
| 38 | + .dependencies = .{ |
| 39 | + // See `zig fetch --save <url>` for a command-line interface for adding dependencies. |
| 40 | + //.example = .{ |
| 41 | + // // When updating this field to a new URL, be sure to delete the corresponding |
| 42 | + // // `hash`, otherwise you are communicating that you expect to find the old hash at |
| 43 | + // // the new URL. If the contents of a URL change this will result in a hash mismatch |
| 44 | + // // which will prevent zig from using it. |
| 45 | + // .url = "https://example.com/foo.tar.gz", |
| 46 | + // |
| 47 | + // // This is computed from the file contents of the directory of files that is |
| 48 | + // // obtained after fetching `url` and applying the inclusion rules given by |
| 49 | + // // `paths`. |
| 50 | + // // |
| 51 | + // // This field is the source of truth; packages do not come from a `url`; they |
| 52 | + // // come from a `hash`. `url` is just one of many possible mirrors for how to |
| 53 | + // // obtain a package matching this `hash`. |
| 54 | + // // |
| 55 | + // // Uses the [multihash](https://multiformats.io/multihash/) format. |
| 56 | + // .hash = "...", |
| 57 | + // |
| 58 | + // // When this is provided, the package is found in a directory relative to the |
| 59 | + // // build root. In this case the package's hash is irrelevant and therefore not |
| 60 | + // // computed. This field and `url` are mutually exclusive. |
| 61 | + // .path = "foo", |
| 62 | + // |
| 63 | + // // When this is set to `true`, a package is declared to be lazily |
| 64 | + // // fetched. This makes the dependency only get fetched if it is |
| 65 | + // // actually used. |
| 66 | + // .lazy = false, |
| 67 | + //}, |
| 68 | + }, |
| 69 | + |
| 70 | + // Specifies the set of files and directories that are included in this package. |
| 71 | + // Only files and directories listed here are included in the `hash` that |
| 72 | + // is computed for this package. Only files listed here will remain on disk |
| 73 | + // when using the zig package manager. As a rule of thumb, one should list |
| 74 | + // files required for compilation plus any license(s). |
| 75 | + // Paths are relative to the build root. Use the empty string (`""`) to refer to |
| 76 | + // the build root itself. |
| 77 | + // A directory listed here means that all files within, recursively, are included. |
| 78 | + .paths = .{ |
| 79 | + "build.zig", |
| 80 | + "build.zig.zon", |
| 81 | + "src", |
| 82 | + // For example... |
| 83 | + //"LICENSE", |
| 84 | + //"README.md", |
| 85 | + }, |
| 86 | +} |
0 commit comments