Invalid token in commented code

[bobf]

Zig Version

0.14.0-dev.1166+bb7050106

Steps to Reproduce and Observed Behavior

Compiling this build.zig:

const std = @import("std");

pub fn build(b: *std.Build) !void {
    const target = b.standardTargetOptions(.{});
    const optimize = b.standardOptimizeOption(.{});

    const dep_opts = .{ .target = target, .optimize = optimize };
    const metrics_module = b.dependency("metrics", dep_opts).module("metrics");
    const websocket_module = b.dependency("websocket", dep_opts).module("websocket");

    // const websocket_module = b.addModule("websocket", .{
    //  .source_file = .{.path = "../websocket.zig/src/websocket.zig"}
    // });

    const httpz_module = b.addModule("httpz", .{
        .root_source_file = b.path("src/httpz.zig"),
        .imports = &.{
            .{ .name = "metrics", .module = metrics_module },
            .{ .name = "websocket", .module = websocket_module },
        },
    });
    {
        const options = b.addOptions();
        options.addOption(bool, "force_blocking", false);
        httpz_module.addOptions("build", options);
    }

    {
        // demo
        const exe = b.addExecutable(.{
            .name = "http.zig demo",
            .root_source_file = b.path("example/main.zig"),
            .target = target,
            .optimize = optimize,
        });
        exe.root_module.addImport("httpz", httpz_module);
        exe.root_module.addImport("metrics", metrics_module);
        exe.root_module.addImport("websocket", websocket_module);
        b.installArtifact(exe);

        const run_cmd = b.addRunArtifact(exe);
        run_cmd.step.dependOn(b.getInstallStep());
        if (b.args) |args| {
            run_cmd.addArgs(args);
        }
        const run_step = b.step("run", "Run the app");
        run_step.dependOn(&run_cmd.step);
    }

    {
        // run tests in nonblocking mode (only meaningful where epoll/kqueue is supported)
        const tests = b.addTest(.{
            .root_source_file = b.path("src/httpz.zig"),
            .target = target,
            .optimize = optimize,
            .test_runner = b.path("test_runner.zig"),
        });
        tests.linkLibC();
        const options = b.addOptions();
        options.addOption(bool, "force_blocking", false);
        tests.root_module.addOptions("build", options);
        tests.root_module.addImport("metrics", metrics_module);
        tests.root_module.addImport("websocket", websocket_module);
        const run_test = b.addRunArtifact(tests);
        run_test.has_side_effects = true;

        const test_step = b.step("test", "Run tests");
        test_step.dependOn(&run_test.step);
    }

    {
        // run tests in blocking mode
        const tests = b.addTest(.{
            .root_source_file = b.path("src/httpz.zig"),
            .target = target,
            .optimize = optimize,
            .test_runner = b.path("test_runner.zig"),
        });
        tests.linkLibC();
        const options = b.addOptions();
        options.addOption(bool, "force_blocking", true);
        tests.root_module.addOptions("build", options);

        tests.root_module.addImport("metrics", metrics_module);
        tests.root_module.addImport("websocket", websocket_module);
        const run_test = b.addRunArtifact(tests);
        run_test.has_side_effects = true;

        const test_step = b.step("test_blocking", "Run tests");
        test_step.dependOn(&run_test.step);
    }
}

Gives this error:

/home/bob/.cache/zig/p/122089946af5ba1cdfae3f515f0fa1c96327f42a462515fbcecc719fe94fab38d9b8/build.zig:12:5: error: expected statement, found 'invalid token'
    //  .source_file = .{.path = "../websocket.zig/src/websocket.zig"}
    ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

@karlseguin FYI

Expected Behavior

Compiler does not error when evaluating commented code.

[castholm]

Duplicate of #20900.

This it not a bug but rather just a very poor and unhelpful error message; there's a tab character in the line comment (replaced with a control picture for clarity):

    // ␉.source_file = .{.path = "../websocket.zig/src/websocket.zig"}

Tabs in comments have always been in violation of the spec (https://github.com/ziglang/zig-spec/issues/38) but only recently was the tokenizer updated to conform to the spec, see #20885.

[bobf]

@castholm Thanks for the explanation. :+1: