Remove byte_range from default printing of SyntaxNode (#207)

The byte range is probably most useful for debugging JuliaSyntax than
general use. So disable this by default.

Author: c42f

README.md

@@ -53,14 +53,14 @@ the `call` has the infix `-i` flag):
 julia> using JuliaSyntax: JuliaSyntax, SyntaxNode, GreenNode
 
 julia> JuliaSyntax.parse(SyntaxNode, "(x + y)*z", filename="foo.jl")
-line:col│ byte_range  │ tree                                   │ file_name
-   1:1  │     1:9     │[call-i]                                │foo.jl
-   1:2  │     2:6     │  [call-i]
-   1:2  │     2:2     │    x
-   1:4  │     4:4     │    +
-   1:6  │     6:6     │    y
-   1:8  │     8:8     │  *
-   1:9  │     9:9     │  z
+line:col│ tree                                   │ file_name
+   1:1  │[call-i]                                │foo.jl
+   1:2  │  [call-i]
+   1:2  │    x
+   1:4  │    +
+   1:6  │    y
+   1:8  │  *
+   1:9  │  z
 ```
 
 Internally this has a full representation of all syntax trivia (whitespace and

src/syntax_tree.jl

@@ -174,10 +174,13 @@ function interpolate_literal(node::SyntaxNode, val)
     SyntaxNode(node.source, node.raw, node.position, node.parent, true, val)
 end
 
-function _show_syntax_node(io, current_filename, node::AbstractSyntaxNode, indent)
+function _show_syntax_node(io, current_filename, node::AbstractSyntaxNode, indent, show_byte_offsets)
     fname = node.source.filename
     line, col = source_location(node.source, node.position)
-    posstr = "$(lpad(line, 4)):$(rpad(col,3))│$(lpad(first_byte(node),6)):$(rpad(last_byte(node),6))│"
+    posstr = "$(lpad(line, 4)):$(rpad(col,3))│"
+    if show_byte_offsets
+        posstr *= "$(lpad(first_byte(node),6)):$(rpad(last_byte(node),6))│"
+    end
     val = node.val
     nodestr = haschildren(node) ? "[$(untokenize(head(node)))]" :
               isa(val, Symbol) ? string(val) : repr(val)
@@ -192,7 +195,7 @@ function _show_syntax_node(io, current_filename, node::AbstractSyntaxNode, inden
     if haschildren(node)
         new_indent = indent*"  "
         for n in children(node)
-            _show_syntax_node(io, current_filename, n, new_indent)
+            _show_syntax_node(io, current_filename, n, new_indent, show_byte_offsets)
         end
     end
 end
@@ -217,9 +220,9 @@ function _show_syntax_node_sexpr(io, node::AbstractSyntaxNode)
     end
 end
 
-function Base.show(io::IO, ::MIME"text/plain", node::AbstractSyntaxNode)
-    println(io, "line:col│ byte_range  │ tree                                   │ file_name")
-    _show_syntax_node(io, Ref{Union{Nothing,String}}(nothing), node, "")
+function Base.show(io::IO, ::MIME"text/plain", node::AbstractSyntaxNode; show_byte_offsets=false)
+    println(io, "line:col│$(show_byte_offsets ? " byte_range  │" : "") tree                                   │ file_name")
+    _show_syntax_node(io, Ref{Union{Nothing,String}}(nothing), node, "", show_byte_offsets)
 end
 
 function Base.show(io::IO, ::MIME"text/x.sexpression", node::AbstractSyntaxNode)

test/syntax_tree.jl

@@ -40,3 +40,27 @@
     node[2] = parse(SyntaxNode, "y")
     @test sourcetext(child(node, 2)) == "y"
 end
+
+@testset "SyntaxNode pretty printing" begin
+    t = parse(SyntaxNode, "f(a*b,\n  c)", filename="foo.jl")
+    @test sprint(show, MIME("text/plain"), t) == """
+    line:col│ tree                                   │ file_name
+       1:1  │[call]                                  │foo.jl
+       1:1  │  f
+       1:3  │  [call-i]
+       1:3  │    a
+       1:4  │    *
+       1:5  │    b
+       2:3  │  c
+    """
+    @test sprint(io->show(io, MIME("text/plain"), t, show_byte_offsets=true)) == """
+    line:col│ byte_range  │ tree                                   │ file_name
+       1:1  │     1:11    │[call]                                  │foo.jl
+       1:1  │     1:1     │  f
+       1:3  │     3:5     │  [call-i]
+       1:3  │     3:3     │    a
+       1:4  │     4:4     │    *
+       1:5  │     5:5     │    b
+       2:3  │    10:10    │  c
+    """
+end