JuliaFormatter.DefaultStyle — TypeDefaultStyleThe default formatting style. See the Style section of the documentation for more details.
See also: BlueStyle, YASStyle, SciMLStyle, MinimalStyle
JuliaFormatter.DefaultStyle — TypeDefaultStyleThe default formatting style. See the Style section of the documentation for more details.
See also: BlueStyle, YASStyle, SciMLStyle, MinimalStyle
JuliaFormatter.FST — TypeFormatted Syntax Tree
JuliaFormatter.MinimalStyle — TypeMinimalStyle()JuliaFormatter.add_node! — Methodadd_node!(
+manually added by the user since the formatter would only use 0 or 1 whitespaces.JuliaFormatter.DefaultStyle — TypeDefaultStyleThe default formatting style. See the Style section of the documentation for more details.
See also: BlueStyle, YASStyle, SciMLStyle, MinimalStyle
JuliaFormatter.FST — TypeFormatted Syntax Tree
JuliaFormatter.MinimalStyle — TypeMinimalStyle()JuliaFormatter.add_node! — Methodadd_node!(
t::FST,
n::FST,
s::State;
join_lines::Bool = false,
max_padding::Int = -1,
override_join_lines_based_on_source::Bool = false,
-)Appends n to t.
join_lines if false a NEWLINE node will be added and n will appearon the next line, otherwise it will appear on the same line as the previous node (when printing).
max_padding >= 0 indicates margin of t should be based on whether the marginof n + max_padding is greater than the current margin of t. Otherwise the margin n will be added to t.
override_join_lines_based_on_source is only used when join_lines_based_on_source option is true. In whichn is added to t as if join_lines_based_on_source was false.
JuliaFormatter.align_binaryopcalls! — Methodalign_binaryopcalls!(fst::FST, op_inds::Vector{Int})Aligns binary operator expressions.
Additionally handles the case where a keyword such as const is used prior to the binary op call.
JuliaFormatter.align_conditional! — Methodalign_conditional!(fst::FST)Aligns a conditional expression.
JuliaFormatter.align_matrix! — MethodAdjust whitespace in between matrix elements such that it's the same as the original source file.
JuliaFormatter.align_struct! — Methodalign_struct!(fst::FST)Aligns struct fields.
JuliaFormatter.annotate_typefields_with_any! — Methodannotate_typefields_with_any!(fst::FST, s::State)Annotates fields in a type definitions with ::Any if no type annotation is provided.
JuliaFormatter.binaryop_to_whereop! — Methodbinaryop_to_whereop(fst::FST, s::State)Handles the case of a function def defined as:
foo(a::A)::R where A = bodyIn this case instead of it being parsed as (1):
Binary
+)Appends n to t.
join_lines if false a NEWLINE node will be added and n will appearon the next line, otherwise it will appear on the same line as the previous node (when printing).
max_padding >= 0 indicates margin of t should be based on whether the marginof n + max_padding is greater than the current margin of t. Otherwise the margin n will be added to t.
override_join_lines_based_on_source is only used when join_lines_based_on_source option is true. In whichn is added to t as if join_lines_based_on_source was false.
JuliaFormatter.align_binaryopcalls! — Methodalign_binaryopcalls!(fst::FST, op_inds::Vector{Int})Aligns binary operator expressions.
Additionally handles the case where a keyword such as const is used prior to the binary op call.
JuliaFormatter.align_conditional! — Methodalign_conditional!(fst::FST)Aligns a conditional expression.
JuliaFormatter.align_matrix! — MethodAdjust whitespace in between matrix elements such that it's the same as the original source file.
JuliaFormatter.align_struct! — Methodalign_struct!(fst::FST)Aligns struct fields.
JuliaFormatter.annotate_typefields_with_any! — Methodannotate_typefields_with_any!(fst::FST, s::State)Annotates fields in a type definitions with ::Any if no type annotation is provided.
JuliaFormatter.binaryop_to_whereop! — Methodbinaryop_to_whereop(fst::FST, s::State)Handles the case of a function def defined as:
foo(a::A)::R where A = bodyIn this case instead of it being parsed as (1):
Binary
- Where
- OP
- RHSIt's parsed as (2):
Binary
@@ -25,7 +25,7 @@
- R
- ...
- OP
- - RHS(1) is preferrable since it's the same parsed result as:
foo(a::A) where A = bodyThis transformation converts (2) to (1).
ref https://github.com/julia-vscode/CSTParser.jl/issues/93
JuliaFormatter.eq_to_in_normalization! — Methodeq_to_in_normalization!(fst::FST, always_for_in::Bool, for_in_replacement::String)
+ - RHS(1) is preferrable since it's the same parsed result as:
foo(a::A) where A = bodyThis transformation converts (2) to (1).
ref https://github.com/julia-vscode/CSTParser.jl/issues/93
JuliaFormatter.eq_to_in_normalization! — Methodeq_to_in_normalization!(fst::FST, always_for_in::Bool, for_in_replacement::String)
eq_to_in_normalization!(fst::FST, always_for_in::Nothing, for_in_replacement::String)Transforms
for i = iter body end
=>
@@ -34,16 +34,16 @@
=>
-for i = 1:10 body endalways_for_in=nothing disables this normalization behavior.
JuliaFormatter.flatten_binaryopcall — MethodFlattens a binary operation call tree if the operation repeats 2 or more times. "a && b && c" will be transformed while "a && b" will not.
JuliaFormatter.format — Methodformat(path, style::AbstractStyle; options...)::BoolJuliaFormatter.format — Methodformat(
+for i = 1:10 body endalways_for_in=nothing disables this normalization behavior.
JuliaFormatter.flatten_binaryopcall — MethodFlattens a binary operation call tree if the operation repeats 2 or more times. "a && b && c" will be transformed while "a && b" will not.
JuliaFormatter.format — Methodformat(path, style::AbstractStyle; options...)::BoolJuliaFormatter.format — Methodformat(
paths; # a path or collection of paths
options...,
-)::BoolRecursively descend into files and directories, formatting any .jl files.
See format_file and format_text for a description of the options.
This function will look for .JuliaFormatter.toml in the location of the file being formatted, and searching up the file tree until a config file is (or isn't) found. When found, the configurations in the file will overwrite the given options. See Configuration File for more details.
Output
Returns a boolean indicating whether the file was already formatted (true) or not (false).
JuliaFormatter.format — Methodformat(mod::Module, args...; options...)JuliaFormatter.format_file — Methodformat_file(
+)::BoolRecursively descend into files and directories, formatting any .jl files.
See format_file and format_text for a description of the options.
This function will look for .JuliaFormatter.toml in the location of the file being formatted, and searching up the file tree until a config file is (or isn't) found. When found, the configurations in the file will overwrite the given options. See Configuration File for more details.
Output
Returns a boolean indicating whether the file was already formatted (true) or not (false).
JuliaFormatter.format — Methodformat(mod::Module, args...; options...)JuliaFormatter.format_file — Methodformat_file(
filename::AbstractString;
overwrite::Bool = true,
verbose::Bool = false,
format_markdown::Bool = false,
format_options...,
-)::BoolFormats the contents of filename assuming it's a .jl, .md, .jmd or .qmd file.
File Options
overwrite
default:
true
If true the file will be reformatted in place, overwriting the existing file; if it is false, the formatted version of foo.jl will not be written anywhere.
verbose
default:
false
If true details related to formatting the file will be printed to stdout.
format_markdown
default:
false
If true, Markdown files are also formatted. Julia code blocks will be formatted in addition to the Markdown being normalized.
Formatting Options
See format_text for description of formatting options.
Output
Returns a boolean indicating whether the file was already formatted (true) or not (false).
JuliaFormatter.format_md — Methodformat_md(text::AbstractString; style::AbstractStyle = DefaultStyle(), kwargs...)Normalizes the Markdown source and formats Julia code blocks.
See format_text for description of formatting options.
JuliaFormatter.format_text — Methodformat_text(
+)::BoolFormats the contents of filename assuming it's a .jl, .md, .jmd or .qmd file.
File Options
overwrite
default:
true
If true the file will be reformatted in place, overwriting the existing file; if it is false, the formatted version of foo.jl will not be written anywhere.
verbose
default:
false
If true details related to formatting the file will be printed to stdout.
format_markdown
default:
false
If true, Markdown files are also formatted. Julia code blocks will be formatted in addition to the Markdown being normalized.
Formatting Options
See format_text for description of formatting options.
Output
Returns a boolean indicating whether the file was already formatted (true) or not (false).
JuliaFormatter.format_md — Methodformat_md(text::AbstractString; style::AbstractStyle = DefaultStyle(), kwargs...)Normalizes the Markdown source and formats Julia code blocks.
See format_text for description of formatting options.
JuliaFormatter.format_text — Methodformat_text(
text::AbstractString;
style::AbstractStyle = DefaultStyle(),
indent::Int = 4,
@@ -184,7 +184,7 @@
Can be used when `always_for_in` is `true` to replace the default `in` with `∈` (`\in`),
or `=` instead. The replacement options are `("in", "=", "∈")`.
-julia for a = 1:10 end
formatted with alwaysforin = true, forinreplacement = "∈"
for a ∈ 1:10 end ```
JuliaFormatter.has_semicolon — Methodhas_semicolon(d::Document, line::Integer)Returns whether d has a valid semicolon grouping on line.
JuliaFormatter.is_dot_op — Methodis_dot_op(x::CSTParser.EXPR)Checks if the binary operation is a dot operation (e.g. x.y, x..z, x...z). This is different from a dot or broadcast operation.
JuliaFormatter.is_iterable_arg — MethodReturns whether fst can be an iterable argument. For example in the case of a function call, which is of type Call:
(a, b, c; k1=v1)This would return true for a, b, c and k1=v1 and false for all other nodes.
JuliaFormatter.is_standalone_shortcircuit — Methodis_standalone_shortcircuit(cst::CSTParser.EXPR)Returns true if the cst is a short-circuit expression (uses &&, ||) and is standalone, meaning it's not directly associated with another statement or expression.
Examples
# this IS a standalone short-circuit
+julia for a = 1:10 end
formatted with alwaysforin = true, forinreplacement = "∈"
for a ∈ 1:10 end ```
JuliaFormatter.has_semicolon — Methodhas_semicolon(d::Document, line::Integer)Returns whether d has a valid semicolon grouping on line.
JuliaFormatter.is_dot_op — Methodis_dot_op(x::CSTParser.EXPR)Checks if the binary operation is a dot operation (e.g. x.y, x..z, x...z). This is different from a dot or broadcast operation.
JuliaFormatter.is_iterable_arg — MethodReturns whether fst can be an iterable argument. For example in the case of a function call, which is of type Call:
(a, b, c; k1=v1)This would return true for a, b, c and k1=v1 and false for all other nodes.
JuliaFormatter.is_standalone_shortcircuit — Methodis_standalone_shortcircuit(cst::CSTParser.EXPR)Returns true if the cst is a short-circuit expression (uses &&, ||) and is standalone, meaning it's not directly associated with another statement or expression.
Examples
# this IS a standalone short-circuit
a && b
# this IS NOT a standalone short-circuit
@@ -199,21 +199,21 @@
# operation inside parenthesis IS NOT a standalone short-circuit
# operation outside parenthesis IS a standalone short-circuit
-(a && b) && cJuliaFormatter.length_to — Method`length_to(x::FST, ntyps; start::Int = 1)`Returns the length to any node type in ntyps based off the start index.
JuliaFormatter.long_to_short_function_def! — Methodlong_to_short_function_def!(fst::FST, s::State)Transforms a long function definition
function f(arg2, arg2)
+(a && b) && cJuliaFormatter.length_to — Method`length_to(x::FST, ntyps; start::Int = 1)`Returns the length to any node type in ntyps based off the start index.
JuliaFormatter.long_to_short_function_def! — Methodlong_to_short_function_def!(fst::FST, s::State)Transforms a long function definition
function f(arg2, arg2)
body
-endto a short function definition
f(arg1, arg2) = bodyJuliaFormatter.move_at_sign_to_the_end — Methodmove_at_sign_to_the_end(fst::FST, s::State)NOTE: Assumes fst is the caller name of a macrocall such as @macro or Module.@macro.
Moves @ to the last identifier.
Example:
@Module.macroto
Module.@macroJuliaFormatter.nest_if_over_margin! — Methodnest_if_over_margin!(
+endto a short function definition
f(arg1, arg2) = bodyJuliaFormatter.move_at_sign_to_the_end — Methodmove_at_sign_to_the_end(fst::FST, s::State)NOTE: Assumes fst is the caller name of a macrocall such as @macro or Module.@macro.
Moves @ to the last identifier.
Example:
@Module.macroto
Module.@macroJuliaFormatter.nest_if_over_margin! — Methodnest_if_over_margin!(
style,
fst::FST,
s::State,
idx::Int;
stop_idx::Union{Int,Nothing} = nothing,
-)::BoolConverts the node at idx to a NEWLINE if the current margin plus the additional margin from fst[idx:stop_idx-1] is greater than the allowed margin.
If stop_idx == nothing the range is fst[idx:end].
Returns whether nesting occurred.
JuliaFormatter.p_macrostr_identifier — MethodThis is a special prettifier to handle the case of string macros. As such it is not part of pretty.
format"hello"The above "format" identifier is parsed by CSTParser as if the text is "@format_str". This creates problems when we format without intervention:
JuliaFormatter.parent_is — MethodReturns whether the first unignored parent of cst matches the criteria determined by valid, which is a function that returns a boolean. ignore can be used to ignore certain parent nodes if desired, also a function which returns a boolean.
JuliaFormatter.pipe_to_function_call_pass! — Methodpipe_to_function_call_pass!(fst::FST)Rewrites x |> f to f(x).
JuliaFormatter.prepend_return! — Methodprepend_return!(fst::FST, s::State)Prepends return to the last expression of a block if applicable.
function foo()
+)::BoolConverts the node at idx to a NEWLINE if the current margin plus the additional margin from fst[idx:stop_idx-1] is greater than the allowed margin.
If stop_idx == nothing the range is fst[idx:end].
Returns whether nesting occurred.
JuliaFormatter.p_macrostr_identifier — MethodThis is a special prettifier to handle the case of string macros. As such it is not part of pretty.
format"hello"The above "format" identifier is parsed by CSTParser as if the text is "@format_str". This creates problems when we format without intervention:
JuliaFormatter.parent_is — MethodReturns whether the first unignored parent of cst matches the criteria determined by valid, which is a function that returns a boolean. ignore can be used to ignore certain parent nodes if desired, also a function which returns a boolean.
JuliaFormatter.pipe_to_function_call_pass! — Methodpipe_to_function_call_pass!(fst::FST)Rewrites x |> f to f(x).
JuliaFormatter.prepend_return! — Methodprepend_return!(fst::FST, s::State)Prepends return to the last expression of a block if applicable.
function foo()
a = 2 * 3
a / 3
endto
function foo()
a = 2 * 3
return a / 3
-endJuliaFormatter.remove_superfluous_whitespace! — Methodremove_superfluous_whitespace!(fst::FST)Soft deletes WHITESPACE or PLACEHOLDER that's directly followed by a NEWLINE or INLINECOMMENT node.
JuliaFormatter.separate_kwargs_with_semicolon! — Methodseparate_kwargs_with_semicolon!(fst::FST)Ensures keyword arguments are separated by a ";".
Examples
Replace "," with ";".
a = f(x, y = 3)
+endJuliaFormatter.remove_superfluous_whitespace! — Methodremove_superfluous_whitespace!(fst::FST)Soft deletes WHITESPACE or PLACEHOLDER that's directly followed by a NEWLINE or INLINECOMMENT node.
JuliaFormatter.separate_kwargs_with_semicolon! — Methodseparate_kwargs_with_semicolon!(fst::FST)Ensures keyword arguments are separated by a ";".
Examples
Replace "," with ";".
a = f(x, y = 3)
->
@@ -221,6 +221,6 @@
->
-a = f(; x = 1, y = 2)JuliaFormatter.short_to_long_function_def! — Methodshort_to_long_function_def!(fst::FST, s::State)Transforms a short function definition
f(arg1, arg2) = bodyto a long function definition
function f(arg2, arg2)
+a = f(; x = 1, y = 2)JuliaFormatter.short_to_long_function_def! — Methodshort_to_long_function_def!(fst::FST, s::State)Transforms a short function definition
f(arg1, arg2) = bodyto a long function definition
function f(arg2, arg2)
body
-endJuliaFormatter.unnestable_node — Methodcst is assumed to be a single child node. Returns true if the node is of the syntactic form {...}, [...], or (...).
JuliaFormatter.walk — Methodwalk(f, fst::FST, s::State)Walks fst calling f on each node.
In situations where descending further into a subtree is not desirable f should return a value other than nothing.
This function mutates the State's (s) line_offset. If this is not desired you should save the value before calling this function and restore it after.
Settings
This document was generated with Documenter.jl version 1.1.0 on Wednesday 4 October 2023. Using Julia version 1.9.3.