Term

ANSICode(color; bg::Bool=false)

Create ANSI tags for colors.

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

Theme

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

Measure(seg::Segment)

gives the measure of a segment

Measure(segments::Vector{Segment})

gives the measure of a vector of segments

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

custom ANSI lexer for Highlighters.jl

Split a string into a vector of Chars.

cleantext(str::AbstractString)

Remove all style information from a string.

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

Apply fn to each line in the text.

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

remove_ansi(str::AbstractString)::AbstractString

Replace each squared bracket with a double copy of itself

get_last_valid_str_idx(str::AbstractString, idx::Int)

Get valid index to cut a string at.

When indexing a string, the number of indices is given by the the sum of the ncodeunits of each Char, but some indices will not be valid. This function ensures that given a (potentially) not valid index, the last valid one is elected.

getnextvalidstridx(str::AbstractString, idx::Int)

Get valid index to cut a string at.

When indexing a string, the number of indices is given by the the sum of the ncodeunits of each Char, but some indices will not be valid. This function ensures that given a (potentially) not valid index, the next valid one is elected.

get_valid_chars!(valid_chars::Vector{Int}, tag, δ::Int)

Recursively extract valid characters (i.e. not in markup tags) from a string.

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.

join_lines(lines)

Merge a vector of strings in a single string.

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

nospaces(text::AbstractString)

Remove all spaces from 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.

reinsert_double_brackets(text::AbstractString)::AbstractString

Insert previously replaced double brackets

remove_ansi(str::AbstractString)::AbstractString

Remove all ANSI tags from a string of text

remove_brackets(text::AbstractString)

Remove all () brackets from a string.

remove_markup(input_text::AbstractString)::AbstractString

Remove all markup tags from a string of text.

remove_markup_open(text::AbstractString)

Remove all opening markup tags from a string of text

replace_double_brackets(text::AbstractString)::AbstractString

Replace double brackets with %% and ±± to avoid them being picked up by markup extraction

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.

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

Reshape text to have a given width.

When text is longer than width, it gets cut into multiple lines. This is done carefully to preserve style information by: avoiding cutting inside style markup and copying markup tags over to new lines so that the style is correctly applied.

split_lines(text::AbstractString)

Split a string into its composing lines.

split_lines(renderable)

Split a renderable's text.

square_to_round_brackets(text::AbstractString)

Replace square brackets with round ones.

textlen(x::AbstractString)

Get length of text after all style information is removed.

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

Shorten a string of text to a target width

unescape_brackets(text::AbstractString)::AbstractString

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