Draft: Run initial JuliaFormatter with BlueStyle

[nickrobinson251]

• Do not merge
• This is a test to see what changes are made when running JuliaFomatter using BlueStyle - implement top 3 issues domluna/JuliaFormatter.jl#295

julia> format(
                  "src";
                  style=BlueStyle(),
                  always_use_return=true,
                  short_to_long_function_def=true,
                  whitespace_ops_in_indices=true,
                  remove_extra_newlines=true,
                  always_for_in=true,
                  import_to_using=true,
                  pipe_to_function_call=true,
                  whitespace_in_kwargs=false,
                  whitespace_typedefs=true,
             )

---

EDIT Now re-run with format("src", BlueStyle()) using JuliaFormatter v0.9.1

[nickrobinson251]

This seems like the only particularly odd/unfortunate change

[iamed2]

I think this is something we should add to the style guide (to prefer what previously existed).

The placement of the rest of the text and the closing triple quote relative to the opening triple quote makes no difference to the content of the string.

[nickrobinson251]

yes please!
JuliaDiff/BlueStyle#60

[nickrobinson251]

JuliaDiff/BlueStyle#71

[nickrobinson251]

Interestingly, the formatter seems to have been confused here by where the opening triple quotes

By BlueStyle, this should be

@template TYPES = """
        (TYPEDEF)

    (DOCSTRING)

    ## Fields:
    (TYPEDFIELDS)
    """

And JuliaFormatter (v0.9) would leave that as is

julia> str = """
       @template TYPES = \"\"\"
               (TYPEDEF)

           (DOCSTRING)

           ## Fields:
           (TYPEDFIELDS)
           \"\"\"
           """;

julia> println(format_text(str, BlueStyle()))
@template TYPES = """
        (TYPEDEF)

    (DOCSTRING)

    ## Fields:
    (TYPEDFIELDS)
    """

But the actual code here right now has the opening triple-quot on the line below i.e. it is

@template TYPES =
    """
        (TYPEDEF)

    (DOCSTRING)

    ## Fields:
    (TYPEDFIELDS)
    """

which seems to confuse the formatter (?), which changes this to

julia> str = """
       @template TYPES =
           \"\"\"
               (TYPEDEF)

           (DOCSTRING)

           ## Fields:
           (TYPEDFIELDS)
           \"\"\"
           """;

julia> println(format_text(str, BlueStyle()))
@template TYPES = """
                      (TYPEDEF)

                  (DOCSTRING)

                  ## Fields:
                  (TYPEDFIELDS)
                  """

Perhaps @domluna knows if this is intended behaviour (which just needs overloading for BlueStyle) or if something funky is going on?

[domluna]

this is intended, the idea being that the indentation of the string changes based on where the tripe quote opener is moved. This allows it to be moved around intact.

In this case (TYPEDEF) is 4 spaces in behind the opening quote so when the quote is moved up a line, (TYPEDEF) follows to be 4 spaces behind the new position.

[nickrobinson251]

okay, cool - thanks - makes sense! BlueStyle prefers something different, so in time it'd be nice to support that for BlueStyle() domluna/JuliaFormatter.jl#283 (comment)

[nickrobinson251]

i wonder if this case further motivates JuliaDiff/BlueStyle#59 ?

[nickrobinson251]

Updated formatting with JuliaFormatter v0.9.7.

There are a few open style questions:

• Exempting literal strings from line limits? JuliaDiff/BlueStyle#59
• Short-circuit logic used as control flow should only be used on a single line JuliaDiff/BlueStyle#72
• Style for (sub)modules? JuliaDiff/BlueStyle#75

Aside from those, I think the only formatter-specific "issue" is the wrong indenting of the multi-line string literal (https://github.com/invenia/LibPQ.jl/pull/197/files#r496234944)

How do you think the format changes in this PR are looking, @iamed2?