no longer print bold by default in print_with_color

Author: KristofferC

NEWS.md

@@ -54,6 +54,12 @@ Library improvements
     For example, to get orange warning messages, simply set `ENV["JULIA_WARN_COLOR"] = 208`.
     Please note that not all terminals support 256 colors.
 
+  * The function `print_with_color` no longer prints text in bold by default ([#18628]).
+    Instead, the function now take a keyword argument `bold::Bool` which determines whether to print in bold or not.
+    On some terminals, printing a color in non bold results in slightly darker colors being printed than when printing in bold.
+    Therefore, light versions of the colors are now supported.
+    For the available colors see the help entry on `print_with_color`.
+
   * The default color for info messages has been changed from blue to cyan ([#18442]).
     This can be changed back to the original color by setting the environment variable `JULIA_INFO_COLOR` to `"blue"`.
     One way of doing this is by adding `ENV["JULIA_INFO_COLOR"] = :blue` to the `.juliarc.jl` file.
@@ -719,6 +725,7 @@ Language tooling improvements
 [#18473]: https://github.com/JuliaLang/julia/issues/18473
 [#18644]: https://github.com/JuliaLang/julia/issues/18644
 [#18690]: https://github.com/JuliaLang/julia/issues/18690
+[#18628]: https://github.com/JuliaLang/julia/issues/18628
 [#18839]: https://github.com/JuliaLang/julia/issues/18839
 [#18931]: https://github.com/JuliaLang/julia/issues/18931
 [#18977]: https://github.com/JuliaLang/julia/issues/18977

base/LineEdit.jl

@@ -629,6 +629,7 @@ function write_prompt(terminal, p::Prompt)
     prefix = isa(p.prompt_prefix,Function) ? p.prompt_prefix() : p.prompt_prefix
     suffix = isa(p.prompt_suffix,Function) ? p.prompt_suffix() : p.prompt_suffix
     write(terminal, prefix)
+    write(terminal, Base.text_colors[:bold])
     write(terminal, p.prompt)
     write(terminal, Base.text_colors[:normal])
     write(terminal, suffix)

base/REPL.jl

@@ -111,8 +111,8 @@ function ip_matches_func(ip, func::Symbol)
 end
 
 function display_error(io::IO, er, bt)
+    print_with_color(Base.error_color(), io, "ERROR: "; bold = true)
     Base.with_output_color(Base.error_color(), io) do io
-        print(io, "ERROR: ")
         # remove REPL-related frames from interactive printing
         eval_ind = findlast(addr->ip_matches_func(addr, :eval), bt)
         if eval_ind != 0

base/client.jl

@@ -4,26 +4,40 @@
 ##             and REPL
 
 const text_colors = AnyDict(
-    :black   => "\033[1m\033[30m",
-    :red     => "\033[1m\033[31m",
-    :green   => "\033[1m\033[32m",
-    :yellow  => "\033[1m\033[33m",
-    :blue    => "\033[1m\033[34m",
-    :magenta => "\033[1m\033[35m",
-    :cyan    => "\033[1m\033[36m",
-    :white   => "\033[1m\033[37m",
-    :normal  => "\033[0m",
-    :bold    => "\033[1m",
+    :black         => "\033[30m",
+    :red           => "\033[31m",
+    :green         => "\033[32m",
+    :yellow        => "\033[33m",
+    :blue          => "\033[34m",
+    :magenta       => "\033[35m",
+    :cyan          => "\033[36m",
+    :white         => "\033[37m",
+    :light_black   => "\033[90m", # gray
+    :light_red     => "\033[91m",
+    :light_green   => "\033[92m",
+    :light_yellow  => "\033[93m",
+    :light_blue    => "\033[94m",
+    :light_magenta => "\033[95m",
+    :light_cyan    => "\033[96m",
+    :normal        => "\033[0m",
+    :default       => "\033[39m",
+    :bold          => "\033[1m",
+)
+
+const disable_text_style = AnyDict(
+    :bold => "\033[22m",
+    :normal => "",
+    :default => "",
 )
 
 for i in 0:255
-    text_colors[i] = "\033[1m\033[38;5;$(i)m"
+    text_colors[i] = "\033[38;5;$(i)m"
 end
 
 # Create a docstring with an automatically generated list
 # of colors.
-const possible_formatting_symbols = [:normal, :bold]
 available_text_colors = collect(Iterators.filter(x -> !isa(x, Integer), keys(text_colors)))
+const possible_formatting_symbols = [:normal, :bold, :default]
 available_text_colors = cat(1,
     sort(intersect(available_text_colors, possible_formatting_symbols), rev=true),
     sort(setdiff(  available_text_colors, possible_formatting_symbols)))
@@ -35,12 +49,15 @@ const available_text_colors_docstring =
 """Dictionary of color codes for the terminal.
 
 Available colors are: $available_text_colors_docstring as well as the integers 0 to 255 inclusive.
+
+The color `:default` will print text in the default color while the color `:normal`
+will print text with all text properties (like boldness) reset.
 """
 text_colors
 
 have_color = false
-default_color_warn = :red
-default_color_error = :red
+default_color_warn = :light_red
+default_color_error = :light_red
 default_color_info = :cyan
 if is_windows()
     default_color_input = :normal
@@ -59,10 +76,12 @@ function repl_color(key, default)
 end
 
 error_color() = repl_color("JULIA_ERROR_COLOR", default_color_error)
-warn_color()   = repl_color("JULIA_WARN_COLOR", default_color_warn)
-info_color()   = repl_color("JULIA_INFO_COLOR", default_color_info)
-input_color()  = text_colors[repl_color("JULIA_INPUT_COLOR", default_color_input)]
-answer_color() = text_colors[repl_color("JULIA_ANSWER_COLOR", default_color_answer)]
+warn_color()  = repl_color("JULIA_WARN_COLOR" , default_color_warn)
+info_color()  = repl_color("JULIA_INFO_COLOR" , default_color_info)
+
+# Print input and answer in bold.
+input_color()  = text_colors[:bold] * text_colors[repl_color("JULIA_INPUT_COLOR", default_color_input)]
+answer_color() = text_colors[:bold] * text_colors[repl_color("JULIA_ANSWER_COLOR", default_color_answer)]
 
 function repl_cmd(cmd, out)
     shell = shell_split(get(ENV,"JULIA_SHELL",get(ENV,"SHELL","/bin/sh")))
@@ -103,8 +122,8 @@ end
 
 display_error(er) = display_error(er, [])
 function display_error(er, bt)
+    print_with_color(Base.error_color(), STDERR, "ERROR: "; bold = true)
     with_output_color(Base.error_color(), STDERR) do io
-        print(io, "ERROR: ")
         showerror(io, er, bt)
         println(io)
     end

base/test.jl

@@ -43,7 +43,7 @@ immutable Pass <: Result
     value
 end
 function Base.show(io::IO, t::Pass)
-    print_with_color(:green, io, "Test Passed\n")
+    print_with_color(:green, io, "Test Passed\n"; bold = true)
     if !(t.orig_expr === nothing)
         print(io, "  Expression: ", t.orig_expr)
     end
@@ -70,7 +70,7 @@ type Fail <: Result
     value
 end
 function Base.show(io::IO, t::Fail)
-    print_with_color(:red, io, "Test Failed\n")
+    print_with_color(:light_red, io, "Test Failed\n"; bold = true)
     print(io, "  Expression: ", t.orig_expr)
     if t.test_type == :test_throws_wrong
         # An exception was thrown, but it was of the wrong type
@@ -102,7 +102,7 @@ type Error <: Result
     backtrace
 end
 function Base.show(io::IO, t::Error)
-    print_with_color(:red, io, "Error During Test\n")
+    print_with_color(:light_red, io, "Error During Test\n"; bold = true)
     if t.test_type == :test_nonbool
         println(io, "  Expression evaluated to non-Boolean")
         println(io, "  Expression: ", t.orig_expr)
@@ -140,7 +140,7 @@ type Broken <: Result
     orig_expr
 end
 function Base.show(io::IO, t::Broken)
-    print_with_color(:yellow, io, "Test Broken\n")
+    print_with_color(:yellow, io, "Test Broken\n"; bold = true)
     if t.test_type == :skipped && !(t.orig_expr === nothing)
         println(io, "  Skipped: ", t.orig_expr)
     elseif !(t.orig_expr === nothing)
@@ -478,21 +478,21 @@ function print_test_results(ts::DefaultTestSet, depth_pad=0)
     # recursively walking the tree of test sets
     align = max(get_alignment(ts, 0), length("Test Summary:"))
     # Print the outer test set header once
-    print_with_color(:white, rpad("Test Summary:",align," "), " | ")
+    print_with_color(:white, rpad("Test Summary:",align," "), " | "; bold = true)
     if pass_width > 0
-        print_with_color(:green, lpad("Pass",pass_width," "), "  ")
+        print_with_color(:green, lpad("Pass",pass_width," "), "  "; bold = true)
     end
     if fail_width > 0
-        print_with_color(:red, lpad("Fail",fail_width," "), "  ")
+        print_with_color(:light_red, lpad("Fail",fail_width," "), "  "; bold = true)
     end
     if error_width > 0
-        print_with_color(:red, lpad("Error",error_width," "), "  ")
+        print_with_color(:light_red, lpad("Error",error_width," "), "  "; bold = true)
     end
     if broken_width > 0
-        print_with_color(:yellow, lpad("Broken",broken_width," "), "  ")
+        print_with_color(:yellow, lpad("Broken",broken_width," "), "  "; bold = true)
     end
     if total_width > 0
-        print_with_color(:blue, lpad("Total",total_width, " "))
+        print_with_color(:blue, lpad("Total",total_width, " "); bold = true)
     end
     println()
     # Recursively print a summary at every level
@@ -595,40 +595,40 @@ function print_counts(ts::DefaultTestSet, depth, align,
 
     np = passes + c_passes
     if np > 0
-        print_with_color(:green, lpad(string(np), pass_width, " "), "  ")
+        print_with_color(:green, lpad(string(np), pass_width, " "), "  "; bold = true)
     elseif pass_width > 0
         # No passes at this level, but some at another level
         print(lpad(" ", pass_width), "  ")
     end
 
     nf = fails + c_fails
     if nf > 0
-        print_with_color(:red, lpad(string(nf), fail_width, " "), "  ")
+        print_with_color(:light_red, lpad(string(nf), fail_width, " "), "  "; bold = true)
     elseif fail_width > 0
         # No fails at this level, but some at another level
         print(lpad(" ", fail_width), "  ")
     end
 
     ne = errors + c_errors
     if ne > 0
-        print_with_color(:red, lpad(string(ne), error_width, " "), "  ")
+        print_with_color(:light_red, lpad(string(ne), error_width, " "), "  "; bold = true)
     elseif error_width > 0
         # No errors at this level, but some at another level
         print(lpad(" ", error_width), "  ")
     end
 
     nb = broken + c_broken
     if nb > 0
-        print_with_color(:yellow, lpad(string(nb), broken_width, " "), "  ")
+        print_with_color(:yellow, lpad(string(nb), broken_width, " "), "  "; bold = true)
     elseif broken_width > 0
         # None broken at this level, but some at another level
         print(lpad(" ", broken_width), "  ")
     end
 
     if np == 0 && nf == 0 && ne == 0 && nb == 0
-        print_with_color(:blue, "No tests")
+        print_with_color(:blue, "No tests"; bold = true)
     else
-        print_with_color(:blue, lpad(string(subtotal), total_width, " "))
+        print_with_color(:blue, lpad(string(subtotal), total_width, " "); bold = true)
     end
     println()
 

base/util.jl

@@ -303,35 +303,39 @@ end
 
 ## printing with color ##
 
-function with_output_color(f::Function, color::Union{Int, Symbol}, io::IO, args...)
+function with_output_color(f::Function, color::Union{Int, Symbol}, io::IO, args...; bold::Bool = false)
     buf = IOBuffer()
+    have_color && bold && print(buf, text_colors[:bold])
     have_color && print(buf, get(text_colors, color, color_normal))
     try f(IOContext(buf, io), args...)
     finally
-        have_color && print(buf, color_normal)
+        have_color && print(buf, get(disable_text_style, color, text_colors[:default]))
+        have_color && (bold || color == :bold) && print(buf, disable_text_style[:bold])
         print(io, String(take!(buf)))
     end
 end
 
 """
-    print_with_color(color::Union{Symbol, Int}, [io], strings...)
+    print_with_color(color::Union{Symbol, Int}, [io], strings...; bold::Bool = false)
 
 Print strings in a color specified as a symbol.
 
 `color` may take any of the values $(Base.available_text_colors_docstring)
 or an integer between 0 and 255 inclusive. Note that not all terminals support 256 colors.
+If the keyword `bold` is given as `true`, the result will be printed in bold.
 """
-print_with_color(color::Union{Int, Symbol}, io::IO, msg::AbstractString...) =
-    with_output_color(print, color, io, msg...)
-print_with_color(color::Union{Int, Symbol}, msg::AbstractString...) =
-    print_with_color(color, STDOUT, msg...)
-println_with_color(color::Union{Int, Symbol}, io::IO, msg::AbstractString...) =
-    with_output_color(println, color, io, msg...)
-println_with_color(color::Union{Int, Symbol}, msg::AbstractString...) =
-    println_with_color(color, STDOUT, msg...)
+print_with_color(color::Union{Int, Symbol}, io::IO, msg::AbstractString...; bold::Bool = false) =
+    with_output_color(print, color, io, msg...; bold = bold)
+print_with_color(color::Union{Int, Symbol}, msg::AbstractString...; bold::Bool = false) =
+    print_with_color(color, STDOUT, msg...; bold = bold)
+println_with_color(color::Union{Int, Symbol}, io::IO, msg::AbstractString...; bold::Bool = false) =
+    with_output_color(println, color, io, msg...; bold = bold)
+println_with_color(color::Union{Int, Symbol}, msg::AbstractString...; bold::Bool = false) =
+    println_with_color(color, STDOUT, msg...; bold = bold)
 
 ## warnings and messages ##
 
+
 """
     info(msg...; prefix="INFO: ")
 
@@ -349,7 +353,8 @@ MY INFO: hello world
 ```
 """
 function info(io::IO, msg...; prefix="INFO: ")
-    println_with_color(info_color(), io, prefix, chomp(string(msg...)))
+    print_with_color(info_color(), io, prefix; bold = true)
+    println_with_color(info_color(), io, chomp(string(msg...)))
 end
 info(msg...; prefix="INFO: ") = info(STDERR, msg..., prefix=prefix)
 
@@ -371,7 +376,8 @@ function warn(io::IO, msg...;
         (key in have_warned) && return
         push!(have_warned, key)
     end
-    print_with_color(warn_color(), io, prefix, str)
+    print_with_color(warn_color(), io, prefix; bold = true)
+    print_with_color(warn_color(), io, str)
     if bt !== nothing
         show_backtrace(io, bt)
     end

doc/src/manual/interacting-with-julia.md

@@ -310,18 +310,21 @@ end
 atreplinit(customize_colors)
 ```
 
-The available color keys in `Base.text_colors` are `:black`, `:red`, `:green`, `:yellow`, `:blue`,
-`:magenta`, `:cyan`, `:white`, `:normal`, and `:bold` as well as the integers 0 to 255 for terminals
-with 256 color support. Similarly, you can change the colors for the help and shell prompts and
+The available color keys can be seen by typing `Base.text_colors` in the help mode of the REPL.
+In addition, the integers 0 to 255 can be used as color keys for terminals
+with 256 color support.
+
+You can also change the colors for the help and shell prompts and
 input and answer text by setting the appropriate field of `repl` in the `customize_colors` function
 above (respectively, `help_color`, `shell_color`, `input_color`, and `answer_color`). For the
 latter two, be sure that the `envcolors` field is also set to false.
 
-You can also customize the color used to render warning and informational messages by setting
-the appropriate environment variable. For instance, to render warning messages in yellow and informational
-messages in cyan you can add the following to your `juliarc.jl` file:
+You can also customize the color used to render warning and informational messages by
+setting the appropriate environment variables. For instance, to render error, warning, and informational
+messages respectively in magenta, yellow, and cyan you can add the following to your `juliarc.jl` file:
 
 ```julia
+ENV["JULIA_ERROR_COLOR"] = :magenta
 ENV["JULIA_WARN_COLOR"] = :yellow
 ENV["JULIA_INFO_COLOR"] = :cyan
 ```

test/misc.jl

@@ -483,3 +483,20 @@ let
     end
     @test c_18711 == 1
 end
+
+let
+    old_have_color = Base.have_color
+    try
+        eval(Base, :(have_color = true))
+        buf = IOBuffer()
+        print_with_color(:red, buf, "foo")
+        # Check that we get back to normal text color in the end
+        @test String(take!(buf)) == "\e[31mfoo\e[39m"
+
+        # Check that boldness is turned off
+        print_with_color(:red, buf, "foo"; bold = true)
+        @test String(take!(buf)) == "\e[1m\e[31mfoo\e[39m\e[22m"
+    finally
+        eval(Base, :(have_color = $(old_have_color)))
+    end
+end