Skip to content

Commit 236fb91

Browse files
committed
seriously people, don't put "zig-" in your package names
related #20178
1 parent e9388fd commit 236fb91

File tree

2 files changed

+16
-0
lines changed

2 files changed

+16
-0
lines changed

doc/build.zig.zon.md

+8
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,14 @@ build.zig.
1212

1313
String. Required.
1414

15+
This is the default name used by packages depending on this one. For example,
16+
when a user runs `zig fetch --save <url>`, this field is used as the key in the
17+
`dependencies` table. Although the user can choose a different name, most users
18+
will stick with this provided value.
19+
20+
It is redundant to include "zig" in this name because it is already within the
21+
Zig package namespace.
22+
1523
### `version`
1624

1725
String. Required.

lib/init/build.zig.zon

+8
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
.{
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.
29
.name = "$",
10+
311
// This is a [Semantic Version](https://semver.org/).
412
// In a future version of Zig it will be used for package deduplication.
513
.version = "0.0.0",

0 commit comments

Comments
 (0)