authorgravatar for andrew@ziglang.orgAndrew Kelley <andrew@ziglang.org> 2023-06-22 06:54:15-07:00
committergravatar for noreply@github.comGitHub <noreply@github.com> 2023-06-22 06:54:15-07:00
log93e54f2354aa1b3de797a7ca5572bfa8c0f733f1
tree93fbbe87a2876a424e3fa267014cc109e3a8de26
parent64f0059cd33b571d6cf91df45f4cb2e0af9c0742
parente45d24c0de29eb6668e56ea927e15505674833a6
signaturebadge-question-mark Signed by PGP key 4AEE18F83AFDEB23

Merge pull request #16110 from dweiller/force-tty-color

std.io.tty: cleanup detectConfig

4 files changed, 22 insertions(+), 17 deletions(-)

doc/docgen.zig+1-1
......@@ -1305,7 +1305,7 @@ fn genHtml(
13051305 defer root_node.end();
13061306
13071307 var env_map = try process.getEnvMap(allocator);
1308 try env_map.put("ZIG_DEBUG_COLOR", "1");
1308 try env_map.put("YES_COLOR", "1");
13091309
13101310 const host = try std.zig.system.NativeTargetInfo.detect(.{});
13111311 const builtin_code = try getBuiltinCode(allocator, &env_map, zig_exe, opt_zig_lib_dir);
lib/build_runner.zig+1-1
......@@ -282,7 +282,7 @@ pub fn main() !void {
282282 const ttyconf = get_tty_conf(color, stderr);
283283 switch (ttyconf) {
284284 .no_color => try builder.env_map.put("NO_COLOR", "1"),
285 .escape_codes => try builder.env_map.put("ZIG_DEBUG_COLOR", "1"),
285 .escape_codes => try builder.env_map.put("YES_COLOR", "1"),
286286 .windows_api => {},
287287 }
288288
lib/std/io/tty.zig+19-14
......@@ -7,29 +7,34 @@ const native_os = builtin.os.tag;
77
88/// Detect suitable TTY configuration options for the given file (commonly stdout/stderr).
99/// This includes feature checks for ANSI escape codes and the Windows console API, as well as
10/// respecting the `NO_COLOR` environment variable.
10/// respecting the `NO_COLOR` and `YES_COLOR` environment variables to override the default.
1111pub fn detectConfig(file: File) Config {
12 if (builtin.os.tag == .wasi) {
13 // Per https://github.com/WebAssembly/WASI/issues/162 ANSI codes
14 // aren't currently supported.
15 return .no_color;
16 } else if (process.hasEnvVarConstant("ZIG_DEBUG_COLOR")) {
17 return .escape_codes;
18 } else if (process.hasEnvVarConstant("NO_COLOR")) {
19 return .no_color;
20 } else if (file.supportsAnsiEscapeCodes()) {
21 return .escape_codes;
22 } else if (native_os == .windows and file.isTty()) {
12 const force_color: ?bool = if (builtin.os.tag == .wasi)
13 null // wasi does not support environment variables
14 else if (process.hasEnvVarConstant("NO_COLOR"))
15 false
16 else if (process.hasEnvVarConstant("YES_COLOR"))
17 true
18 else
19 null;
20
21 if (force_color == false) return .no_color;
22
23 if (native_os == .windows and file.isTty()) {
2324 var info: windows.CONSOLE_SCREEN_BUFFER_INFO = undefined;
2425 if (windows.kernel32.GetConsoleScreenBufferInfo(file.handle, &info) != windows.TRUE) {
25 // TODO: Should this return an error instead?
26 return .no_color;
26 return if (force_color == true) .escape_codes else .no_color;
2727 }
2828 return .{ .windows_api = .{
2929 .handle = file.handle,
3030 .reset_attributes = info.wAttributes,
3131 } };
3232 }
33
34 if (force_color == true or file.supportsAnsiEscapeCodes()) {
35 return .escape_codes;
36 }
37
3338 return .no_color;
3439}
3540
test/src/StackTrace.zig+1-1
......@@ -81,7 +81,7 @@ fn addExpect(
8181 });
8282
8383 const run = b.addRunArtifact(exe);
84 run.removeEnvironmentVariable("ZIG_DEBUG_COLOR");
84 run.removeEnvironmentVariable("YES_COLOR");
8585 run.setEnvironmentVariable("NO_COLOR", "1");
8686 run.expectExitCode(1);
8787 run.expectStdOutEqual("");