Term

Term.jl

Welcome to Term.jl! Term.jl is a Julia library for producing styled, beautiful terminal output.

Documentation

See https://fedeclaudi.github.io/Term.jl for documentation.

Demonstration

using Term
const term_demo = joinpath(dirname(pathof(Term)), "..", "README.jl")
include(term_demo) # view demo
less(term_demo) # see demo code

Example

julia begin println(@green "this is green") println(@blue "and this is blue") println() println(@bold "this is bold") println(@underline "and this is underlined") end ```

Custom hilighting theme for Highlighters.jl https://juliadocs.github.io/Highlights.jl/stable/man/theme/

Measure(segments::AbstractVector)

gives the measure of a vector of segments

Measure(seg::Segment)

gives the measure of a segment

Theme

Stores colors for different semantically relevant items, used to style outputs to terminal.

Format.render(io::IO, ::MIME"text/ansi", tokens::Format.TokenIterator)

custom ANSI lexer for Highlighters.jl

calc_nrows_ncols(n, aspect::Union{Nothing,Number,NTuple} = nothing)

Computes the number of rows and columns to fit a given number n of subplots in a figure with aspect aspect. If aspect is nothing, chooses the best fir between a default and a unit aspect ratios.

Adapted from: stackoverflow.com/a/43366784

Split a string into a vector of Chars.

cleantext(str::AbstractString)

Remove all style information from a string.

do_by_line(fn::Function, text::String)

Apply fn to each line in the text.

The function fn should accept a single ::String argument.

escape_brackets(text)::Stringremove_ansi(str)::String

Replace each curly bracket with a double copy of itself

excise_link_display_text(link::String)

Given a link string of the form: "]8;;LINKDESTINATION\LINKDISPLAYTEXT]8;;\" this function returns "LINKDISPLAY_TEXT" alone.

Get a clean string representation of an expression

fillin(text::String)::String

Ensure that each line in a multi-line text has the same width.

Same as fix_markup_across_lines but for ANSI style tags.

fix_markup_across_lines(lines::Vector{AbstractString})::Vector{AbstractString}

When splitting text with markup tags across multiple lines, tags can get separated across lines. This is a problem when the text gets printed side by side with other text with style information. This fixes that by copying/closing markup tags across lines as requested. Essentially, if a tag is opened but not closed in a line, close it at the end of the line and add the same open tag at the start of the next, taking care of doing things in the correct order when multiple tags are in the same line.

get_bg_color(style::String)

Add "on_" to background style info.

Given an ANSI tag, get the correct closer tag

getfileformat(nbytes; suffix="B")

Return a string with formatted file size.

getlrwidths(width::Int)

To split something with width in 2, get the lengths of the left/right widths.

When width is even that's easy, when it's odd we need to be careful.

has_ansi(text::String)

Returns true if text includes a MarkupTag

has_markup(text::String)

Returns true if text includes a MarkupTag

highlight(text::AbstractString, theme::Theme, like::Symbol)

Hilights an entire text as if it was a type of semantically relevant text of type :like.

highlight(text::AbstractString, theme::Theme)

Highlighs a text introducing markup to style semantically relevant segments, colors specified by a theme object.

highlight_syntax(code::AbstractString; style::Bool=true)

Highlight Julia code syntax in a string.

Check if an ANSI tag is a closer

join_lines(lines)

Merge a vector of strings in a single string.

justify(text::AbstractString, width::Int)::String

Justify a piece of text spreading out text to fill in a given width.

load_code_and_highlight(path::AbstractString, lineno::Int; δ::Int=3, width::INt=120)

Load a file, get the code and format it. Return styled text

load_code_and_highlight(path::AbstractString)::String

Load and highlight the syntax of an entire file

loop_last(v)

Returns an iterable yielding tuples (is_last, value).

ltrim_str(str, width)

Cut a chunk of width width form the left of a string

read_file_lines(path::String, start::Int, stop::Int)

Read a file and select only lines in range start -> stop.

Returns a vector of tuples with the line number and line content.

remove_ansi(input_text::AbstractString)::AbstractString

Remove all ANSI tags from a string of text

remove_markup(input_text::AbstractString)::AbstractString

Remove all markup tags from a string of text.

multiple strings replacement.

replace_text(text::AbstractString, start::Int, stop::Int, char::Char='_')

Replace a section of a text between start and stop with another string composed of repeats of a given character char.

replace_text(text::AbstractString, start::Int, stop::Int, replace::AbstractString)

Replace a section of a text between start and stop with replace.

Reshaping strings with Julia code requires particular care

reshape_text(text::AbstractString, width::Int)

Reshape a text to have a given width.

Insert newline characters in a string so that each line is within the given width.

rtrim_str(str, width)

Cut a chunk of width width form the right of a string

split_lines(text::AbstractString)

Split a string into its composing lines.

str_trunc(text::AbstractString, width::Int)

Shorten a string of text to a target width

string_type(x)

Return the type of x if it's an AbstractString, else String

text_to_width(text::AbstractString, width::Int)::String

Cast a text to have a given width by reshaping, it and padding. It includes an option to justify the text (:left, :right, :center, :justify).

textlen(x::AbstractString)

Get length of text after all style information is removed.

tview(text, start::Int, stop::Int)

Get a view object with appropriate indices

unescape_brackets(text)::String

Replece every double squared parenthesis with a single copy of itself

unspace_commas(text::AbstractString)

Remove spaces after commas.

Macro to create macros such as @green which colors text accordingly

Macro to create macros such as @underline which styles text accordingly.

@style "text" style1 style2...

Applies a sequence of styles to a piece of text, such that

println(@style "my text" bold green underline)

will print my text as bold, green and underlined