Format .jl files (ITensorFormatter)

Author: mtfishman

Project.toml

@@ -1,7 +1,7 @@
 name = "VisualizationBase"
 uuid = "19e8930c-b694-45c7-b48f-ae1a17da5712"
+version = "0.1.1"
 authors = ["ITensor developers <support@itensor.org> and contributors"]
-version = "0.1.0"
 
 [deps]
 BackendSelection = "680c2d7c-f67a-4cc9-ae9c-da132b1447a5"

docs/make.jl

@@ -1,24 +1,25 @@
-using VisualizationBase: VisualizationBase
 using Documenter: Documenter, DocMeta, deploydocs, makedocs
+using VisualizationBase: VisualizationBase
 
 DocMeta.setdocmeta!(
-  VisualizationBase, :DocTestSetup, :(using VisualizationBase); recursive=true
+    VisualizationBase, :DocTestSetup, :(using VisualizationBase); recursive = true,
 )
 
 include("make_index.jl")
 
 makedocs(;
-  modules=[VisualizationBase],
-  authors="ITensor developers <support@itensor.org> and contributors",
-  sitename="VisualizationBase.jl",
-  format=Documenter.HTML(;
-    canonical="https://itensor.github.io/VisualizationBase.jl",
-    edit_link="main",
-    assets=["assets/favicon.ico", "assets/extras.css"],
-  ),
-  pages=["Home" => "index.md", "Reference" => "reference.md"],
+    modules = [VisualizationBase],
+    authors = "ITensor developers <support@itensor.org> and contributors",
+    sitename = "VisualizationBase.jl",
+    format = Documenter.HTML(;
+        canonical = "https://itensor.github.io/VisualizationBase.jl",
+        edit_link = "main",
+        assets = ["assets/favicon.ico", "assets/extras.css"],
+    ),
+    pages = ["Home" => "index.md", "Reference" => "reference.md"],
 )
 
 deploydocs(;
-  repo="github.com/ITensor/VisualizationBase.jl", devbranch="main", push_preview=true
+    repo = "github.com/ITensor/VisualizationBase.jl", devbranch = "main",
+    push_preview = true,
 )

docs/make_index.jl

@@ -2,20 +2,20 @@ using Literate: Literate
 using VisualizationBase: VisualizationBase
 
 function ccq_logo(content)
-  include_ccq_logo = """
+    include_ccq_logo = """
     ```@raw html
     <img class="display-light-only" src="assets/CCQ.png" width="20%" alt="Flatiron Center for Computational Quantum Physics logo."/>
     <img class="display-dark-only" src="assets/CCQ-dark.png" width="20%" alt="Flatiron Center for Computational Quantum Physics logo."/>
     ```
     """
-  content = replace(content, "{CCQ_LOGO}" => include_ccq_logo)
-  return content
+    content = replace(content, "{CCQ_LOGO}" => include_ccq_logo)
+    return content
 end
 
 Literate.markdown(
-  joinpath(pkgdir(VisualizationBase), "examples", "README.jl"),
-  joinpath(pkgdir(VisualizationBase), "docs", "src");
-  flavor=Literate.DocumenterFlavor(),
-  name="index",
-  postprocess=ccq_logo,
+    joinpath(pkgdir(VisualizationBase), "examples", "README.jl"),
+    joinpath(pkgdir(VisualizationBase), "docs", "src");
+    flavor = Literate.DocumenterFlavor(),
+    name = "index",
+    postprocess = ccq_logo,
 )

docs/make_readme.jl

@@ -2,20 +2,20 @@ using Literate: Literate
 using VisualizationBase: VisualizationBase
 
 function ccq_logo(content)
-  include_ccq_logo = """
+    include_ccq_logo = """
     <picture>
       <source media="(prefers-color-scheme: dark)" width="20%" srcset="docs/src/assets/CCQ-dark.png">
       <img alt="Flatiron Center for Computational Quantum Physics logo." width="20%" src="docs/src/assets/CCQ.png">
     </picture>
     """
-  content = replace(content, "{CCQ_LOGO}" => include_ccq_logo)
-  return content
+    content = replace(content, "{CCQ_LOGO}" => include_ccq_logo)
+    return content
 end
 
 Literate.markdown(
-  joinpath(pkgdir(VisualizationBase), "examples", "README.jl"),
-  joinpath(pkgdir(VisualizationBase));
-  flavor=Literate.CommonMarkFlavor(),
-  name="README",
-  postprocess=ccq_logo,
+    joinpath(pkgdir(VisualizationBase), "examples", "README.jl"),
+    joinpath(pkgdir(VisualizationBase));
+    flavor = Literate.CommonMarkFlavor(),
+    name = "README",
+    postprocess = ccq_logo,
 )

examples/README.jl

@@ -1,5 +1,5 @@
 # # VisualizationBase.jl
-# 
+#
 # [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://itensor.github.io/VisualizationBase.jl/stable/)
 # [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://itensor.github.io/VisualizationBase.jl/dev/)
 # [![Build Status](https://github.com/ITensor/VisualizationBase.jl/actions/workflows/Tests.yml/badge.svg?branch=main)](https://github.com/ITensor/VisualizationBase.jl/actions/workflows/Tests.yml?query=branch%3Amain)
@@ -43,8 +43,8 @@ julia> Pkg.add("VisualizationBase")
 
 # ## Examples
 
-using VisualizationBase: @visualize
 using Test: @test
+using VisualizationBase: @visualize
 
 x = [2, 3]
 y = @visualize x

src/VisualizationBase.jl

@@ -5,71 +5,81 @@ using BackendSelection: @Backend_str, AbstractBackend, Backend
 export @visualize, visualize
 
 macro visualize(x, kwargs...)
-  all(kwarg -> Meta.isexpr(kwarg, :(=)), kwargs) ||
-    throw(ArgumentError("All keyword arguments must be of the form `kw=value`."))
-  kwargs′ = if all(kwarg -> kwarg.args[1] ≠ :name, kwargs)
-    (kwargs..., :(name=$(string(x))))
-  else
-    kwargs
-  end
-  return :(visualize($(esc(x)); $(esc.(kwargs′)...)); $(esc(x)))
+    all(kwarg -> Meta.isexpr(kwarg, :(=)), kwargs) ||
+        throw(ArgumentError("All keyword arguments must be of the form `kw=value`."))
+    kwargs′ = if all(kwarg -> kwarg.args[1] ≠ :name, kwargs)
+        (kwargs..., :(name = $(string(x))))
+    else
+        kwargs
+    end
+    return :(visualize($(esc(x)); $(esc.(kwargs′)...)); $(esc(x)))
 end
 
-function visualize(io::IO, x; backend=Backend"Default", name=nothing, kwargs...)
-  return visualize(io, to_backend(backend; kwargs...), x; name)
+function visualize(io::IO, x; backend = Backend"Default", name = nothing, kwargs...)
+    return visualize(io, to_backend(backend; kwargs...), x; name)
 end
 
-function visualize(x; backend=Backend"Default", name=nothing, io::IO=stdout, kwargs...)
-  return visualize(io, to_backend(backend; kwargs...), x; name)
+function visualize(
+        x;
+        backend = Backend"Default",
+        name = nothing,
+        io::IO = stdout,
+        kwargs...,
+    )
+    return visualize(io, to_backend(backend; kwargs...), x; name)
 end
 
-function visualize(io::IO, backend::AbstractBackend, x; name=nothing)
-  name = get(backend, :name, name)
-  if isnothing(name)
-    visualize_unnamed(io, backend, x)
+function visualize(io::IO, backend::AbstractBackend, x; name = nothing)
+    name = get(backend, :name, name)
+    if isnothing(name)
+        visualize_unnamed(io, backend, x)
+        return nothing
+    end
+    visualize_named(io, backend, name, x)
     return nothing
-  end
-  visualize_named(io, backend, name, x)
-  return nothing
 end
 
-function visualize(backend::Backend"Default", x; name=nothing)
-  io = get(backend, :io, stdout)
-  visualize(io, backend, x; name)
-  return nothing
+function visualize(backend::Backend"Default", x; name = nothing)
+    io = get(backend, :io, stdout)
+    visualize(io, backend, x; name)
+    return nothing
 end
 
 function visualize_named(io::IO, backend::Backend"Default", name, x)
-  mime = get(backend, :mime, MIME"text/plain"())
-  println(io, name, " = ")
-  show_indented(io, mime, x)
-  println(io)
-  return nothing
+    mime = get(backend, :mime, MIME"text/plain"())
+    println(io, name, " = ")
+    show_indented(io, mime, x)
+    println(io)
+    return nothing
 end
 
 function visualize_unnamed(io::IO, ::Backend"Default", x)
-  show(io, MIME"text/plain"(), x)
-  println(io)
-  return nothing
+    show(io, MIME"text/plain"(), x)
+    println(io)
+    return nothing
 end
 
-function show_indented(io::IO, mime::MIME, x; indent=" ")
-  str = sprint(show, mime, x)
-  str = join((indent * s for s in split(str, '\n')), '\n')
-  print(io, str)
-  return nothing
+function show_indented(io::IO, mime::MIME, x; indent = " ")
+    str = sprint(show, mime, x)
+    str = join((indent * s for s in split(str, '\n')), '\n')
+    print(io, str)
+    return nothing
 end
 
 function to_backend(::Type{B}; kwargs...) where {B}
-  return B(; kwargs...)
+    return B(; kwargs...)
 end
-function to_backend(backend::Union{Symbol,String}; kwargs...)
-  return Backend(backend; kwargs...)
+function to_backend(backend::Union{Symbol, String}; kwargs...)
+    return Backend(backend; kwargs...)
 end
 function to_backend(backend::AbstractBackend; kwargs...)
-  isempty(kwargs) ||
-    throw(ArgumentError("Keyword arguments must be passed as part of the backend object."))
-  return backend
+    isempty(kwargs) ||
+        throw(
+        ArgumentError(
+            "Keyword arguments must be passed as part of the backend object.",
+        ),
+    )
+    return backend
 end
 
 end

test/runtests.jl

@@ -6,60 +6,67 @@ using Suppressor: Suppressor
 const pat = r"(?:--group=)(\w+)"
 arg_id = findfirst(contains(pat), ARGS)
 const GROUP = uppercase(
-  if isnothing(arg_id)
-    get(ENV, "GROUP", "ALL")
-  else
-    only(match(pat, ARGS[arg_id]).captures)
-  end,
+    if isnothing(arg_id)
+        get(ENV, "GROUP", "ALL")
+    else
+        only(match(pat, ARGS[arg_id]).captures)
+    end,
 )
 
-"match files of the form `test_*.jl`, but exclude `*setup*.jl`"
+"""
+match files of the form `test_*.jl`, but exclude `*setup*.jl`
+"""
 function istestfile(fn)
-  return endswith(fn, ".jl") && startswith(basename(fn), "test_") && !contains(fn, "setup")
+    return endswith(fn, ".jl") && startswith(basename(fn), "test_") &&
+        !contains(fn, "setup")
 end
-"match files of the form `*.jl`, but exclude `*_notest.jl` and `*setup*.jl`"
+"""
+match files of the form `*.jl`, but exclude `*_notest.jl` and `*setup*.jl`
+"""
 function isexamplefile(fn)
-  return endswith(fn, ".jl") && !endswith(fn, "_notest.jl") && !contains(fn, "setup")
+    return endswith(fn, ".jl") && !endswith(fn, "_notest.jl") && !contains(fn, "setup")
 end
 
 @time begin
-  # tests in groups based on folder structure
-  for testgroup in filter(isdir, readdir(@__DIR__))
-    if GROUP == "ALL" || GROUP == uppercase(testgroup)
-      groupdir = joinpath(@__DIR__, testgroup)
-      for file in filter(istestfile, readdir(groupdir))
-        filename = joinpath(groupdir, file)
-        @eval @safetestset $file begin
-          include($filename)
+    # tests in groups based on folder structure
+    for testgroup in filter(isdir, readdir(@__DIR__))
+        if GROUP == "ALL" || GROUP == uppercase(testgroup)
+            groupdir = joinpath(@__DIR__, testgroup)
+            for file in filter(istestfile, readdir(groupdir))
+                filename = joinpath(groupdir, file)
+                @eval @safetestset $file begin
+                    include($filename)
+                end
+            end
         end
-      end
     end
-  end
 
-  # single files in top folder
-  for file in filter(istestfile, readdir(@__DIR__))
-    (file == basename(@__FILE__)) && continue # exclude this file to avoid infinite recursion
-    @eval @safetestset $file begin
-      include($file)
+    # single files in top folder
+    for file in filter(istestfile, readdir(@__DIR__))
+        (file == basename(@__FILE__)) && continue # exclude this file to avoid infinite recursion
+        @eval @safetestset $file begin
+            include($file)
+        end
     end
-  end
 
-  # test examples
-  examplepath = joinpath(@__DIR__, "..", "examples")
-  for (root, _, files) in walkdir(examplepath)
-    contains(chopprefix(root, @__DIR__), "setup") && continue
-    for file in filter(isexamplefile, files)
-      filename = joinpath(root, file)
-      @eval begin
-        @safetestset $file begin
-          $(Expr(
-            :macrocall,
-            GlobalRef(Suppressor, Symbol("@suppress")),
-            LineNumberNode(@__LINE__, @__FILE__),
-            :(include($filename)),
-          ))
+    # test examples
+    examplepath = joinpath(@__DIR__, "..", "examples")
+    for (root, _, files) in walkdir(examplepath)
+        contains(chopprefix(root, @__DIR__), "setup") && continue
+        for file in filter(isexamplefile, files)
+            filename = joinpath(root, file)
+            @eval begin
+                @safetestset $file begin
+                    $(
+                        Expr(
+                            :macrocall,
+                            GlobalRef(Suppressor, Symbol("@suppress")),
+                            LineNumberNode(@__LINE__, @__FILE__),
+                            :(include($filename)),
+                        )
+                    )
+                end
+            end
         end
-      end
     end
-  end
 end

test/test_aqua.jl

@@ -1,7 +1,7 @@
-using VisualizationBase: VisualizationBase
 using Aqua: Aqua
 using Test: @testset
+using VisualizationBase: VisualizationBase
 
 @testset "Code quality (Aqua.jl)" begin
-  Aqua.test_all(VisualizationBase)
+    Aqua.test_all(VisualizationBase)
 end

test/test_basics.jl

@@ -1,15 +1,15 @@
-using VisualizationBase: VisualizationBase, @visualize, visualize
 using Test: @test, @testset
+using VisualizationBase: VisualizationBase, @visualize, visualize
 
 @testset "VisualizationBase" begin
-  x = [2, 3]
-  @test sprint(visualize, x) ==
-    "2-element Vector{Int64}:\n 2\n 3\n" ==
-    sprint((io, x) -> display(TextDisplay(io), x), x)
-  @test sprint((io, x) -> visualize(io, x; name="y"), x) ==
-    "y = \n 2-element Vector{Int64}:\n  2\n  3\n"
-  @test sprint((io, x) -> @visualize(x, io=io), x) ==
-    "x = \n 2-element Vector{Int64}:\n  2\n  3\n"
-  @test sprint((io, x) -> @visualize(x, io=io, name="y"), x) ==
-    "y = \n 2-element Vector{Int64}:\n  2\n  3\n"
+    x = [2, 3]
+    @test sprint(visualize, x) ==
+        "2-element Vector{Int64}:\n 2\n 3\n" ==
+        sprint((io, x) -> display(TextDisplay(io), x), x)
+    @test sprint((io, x) -> visualize(io, x; name = "y"), x) ==
+        "y = \n 2-element Vector{Int64}:\n  2\n  3\n"
+    @test sprint((io, x) -> @visualize(x, io = io), x) ==
+        "x = \n 2-element Vector{Int64}:\n  2\n  3\n"
+    @test sprint((io, x) -> @visualize(x, io = io, name = "y"), x) ==
+        "y = \n 2-element Vector{Int64}:\n  2\n  3\n"
 end