authorgravatar for andrew@ziglang.orgAndrew Kelley <andrew@ziglang.org> 2023-10-20 00:51:44-04:00
committergravatar for noreply@github.comGitHub <noreply@github.com> 2023-10-20 00:51:44-04:00
log5d8bc56ab67c01f9c1b6de6227356c1c74852464
tree33a0cf26027e6ba2fc50fe4226440770bcde52cf
parentfee09009a8bbe2e315fa9f05842098e598b3cbc3
parentb795925ee421cb7d12eed37e98ceb2dacce6a729
signaturebadge-question-mark Signed by PGP key 4AEE18F83AFDEB23

Merge pull request #15268 from DraagrenKirneh/feature/14475-minimum-zig-version

#14475 minimal_zig_version in build.zig.zon

2 files changed, 83 insertions(+), 2 deletions(-)

doc/build.zig.zon.md+9
......@@ -24,6 +24,15 @@ Struct.
2424
2525Each dependency must either provide a `url` and `hash`, or a `path`.
2626
27### `minimum_zig_version`
28
29String. Optional.
30
31[semver](https://semver.org/)
32
33This is currently advisory only; the compiler does does not yet do anything
34with this version.
35
2736#### `url`
2837
2938String.
src/Package/Manifest.zig+74-2
......@@ -57,6 +57,7 @@ name: []const u8,
5757version: std.SemanticVersion,
5858dependencies: std.StringArrayHashMapUnmanaged(Dependency),
5959paths: std.StringArrayHashMapUnmanaged(void),
60minimum_zig_version: ?std.SemanticVersion,
6061
6162errors: []ErrorMessage,
6263arena_state: std.heap.ArenaAllocator.State,
......@@ -87,6 +88,7 @@ pub fn parse(gpa: Allocator, ast: std.zig.Ast, options: ParseOptions) Error!Mani
8788 .dependencies = .{},
8889 .paths = .{},
8990 .allow_missing_paths_field = options.allow_missing_paths_field,
91 .minimum_zig_version = null,
9092 .buf = .{},
9193 };
9294 defer p.buf.deinit(gpa);
......@@ -104,6 +106,7 @@ pub fn parse(gpa: Allocator, ast: std.zig.Ast, options: ParseOptions) Error!Mani
104106 .version = p.version,
105107 .dependencies = try p.dependencies.clone(p.arena),
106108 .paths = try p.paths.clone(p.arena),
109 .minimum_zig_version = p.minimum_zig_version,
107110 .errors = try p.arena.dupe(ErrorMessage, p.errors.items),
108111 .arena_state = arena_instance.state,
109112 };
......@@ -160,6 +163,7 @@ const Parse = struct {
160163 dependencies: std.StringArrayHashMapUnmanaged(Dependency),
161164 paths: std.StringArrayHashMapUnmanaged(void),
162165 allow_missing_paths_field: bool,
166 minimum_zig_version: ?std.SemanticVersion,
163167
164168 const InnerError = error{ ParseFailure, OutOfMemory };
165169
......@@ -198,6 +202,12 @@ const Parse = struct {
198202 break :v undefined;
199203 };
200204 have_version = true;
205 } else if (mem.eql(u8, field_name, "minimum_zig_version")) {
206 const version_text = try parseString(p, field_init);
207 p.minimum_zig_version = std.SemanticVersion.parse(version_text) catch |err| v: {
208 try appendError(p, main_tokens[field_init], "unable to parse semantic version: {s}", .{@errorName(err)});
209 break :v null;
210 };
201211 } else {
202212 // Ignore unknown fields so that we can add fields in future zig
203213 // versions without breaking older zig versions.
......@@ -528,6 +538,7 @@ test "basic" {
528538 \\.{
529539 \\ .name = "foo",
530540 \\ .version = "3.2.1",
541 \\ .paths = .{""},
531542 \\ .dependencies = .{
532543 \\ .bar = .{
533544 \\ .url = "https://example.com/baz.tar.gz",
......@@ -542,9 +553,10 @@ test "basic" {
542553
543554 try testing.expect(ast.errors.len == 0);
544555
545 var manifest = try Manifest.parse(gpa, ast);
556 var manifest = try Manifest.parse(gpa, ast, .{});
546557 defer manifest.deinit(gpa);
547558
559 try testing.expect(manifest.errors.len == 0);
548560 try testing.expectEqualStrings("foo", manifest.name);
549561
550562 try testing.expectEqual(@as(std.SemanticVersion, .{
......@@ -557,10 +569,70 @@ test "basic" {
557569 try testing.expectEqualStrings("bar", manifest.dependencies.keys()[0]);
558570 try testing.expectEqualStrings(
559571 "https://example.com/baz.tar.gz",
560 manifest.dependencies.values()[0].url,
572 manifest.dependencies.values()[0].location.url,
561573 );
562574 try testing.expectEqualStrings(
563575 "1220f1b680b6065fcfc94fe777f22e73bcb7e2767e5f4d99d4255fe76ded69c7a35f",
564576 manifest.dependencies.values()[0].hash orelse return error.TestFailed,
565577 );
578
579 try testing.expect(manifest.minimum_zig_version == null);
580}
581
582test "minimum_zig_version" {
583 const gpa = testing.allocator;
584
585 const example =
586 \\.{
587 \\ .name = "foo",
588 \\ .version = "3.2.1",
589 \\ .paths = .{""},
590 \\ .minimum_zig_version = "0.11.1",
591 \\}
592 ;
593
594 var ast = try std.zig.Ast.parse(gpa, example, .zon);
595 defer ast.deinit(gpa);
596
597 try testing.expect(ast.errors.len == 0);
598
599 var manifest = try Manifest.parse(gpa, ast, .{});
600 defer manifest.deinit(gpa);
601
602 try testing.expect(manifest.errors.len == 0);
603 try testing.expect(manifest.dependencies.count() == 0);
604
605 try testing.expect(manifest.minimum_zig_version != null);
606
607 try testing.expectEqual(@as(std.SemanticVersion, .{
608 .major = 0,
609 .minor = 11,
610 .patch = 1,
611 }), manifest.minimum_zig_version.?);
612}
613
614test "minimum_zig_version - invalid version" {
615 const gpa = testing.allocator;
616
617 const example =
618 \\.{
619 \\ .name = "foo",
620 \\ .version = "3.2.1",
621 \\ .minimum_zig_version = "X.11.1",
622 \\ .paths = .{""},
623 \\}
624 ;
625
626 var ast = try std.zig.Ast.parse(gpa, example, .zon);
627 defer ast.deinit(gpa);
628
629 try testing.expect(ast.errors.len == 0);
630
631 var manifest = try Manifest.parse(gpa, ast, .{});
632 defer manifest.deinit(gpa);
633
634 try testing.expect(manifest.errors.len == 1);
635 try testing.expect(manifest.dependencies.count() == 0);
636
637 try testing.expect(manifest.minimum_zig_version == null);
566638}