From 83964d821f09547258f17a325be6dc99267dcd4e Mon Sep 17 00:00:00 2001 From: mtfishman <7855256+mtfishman@users.noreply.github.com> Date: Tue, 11 Nov 2025 01:16:41 +0000 Subject: [PATCH] Format .jl files (Runic) --- Project.toml | 2 +- docs/make.jl | 22 +++++------ docs/make_index.jl | 16 ++++---- docs/make_readme.jl | 16 ++++---- examples/README.jl | 2 +- src/VisualizationBase.jl | 84 ++++++++++++++++++++-------------------- test/runtests.jl | 80 +++++++++++++++++++------------------- test/test_aqua.jl | 2 +- test/test_basics.jl | 20 +++++----- 9 files changed, 123 insertions(+), 121 deletions(-) diff --git a/Project.toml b/Project.toml index 975593a..1c51288 100644 --- a/Project.toml +++ b/Project.toml @@ -1,7 +1,7 @@ name = "VisualizationBase" uuid = "19e8930c-b694-45c7-b48f-ae1a17da5712" +version = "0.1.1" authors = ["ITensor developers and contributors"] -version = "0.1.0" [deps] BackendSelection = "680c2d7c-f67a-4cc9-ae9c-da132b1447a5" diff --git a/docs/make.jl b/docs/make.jl index 17b4552..d1f494d 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -2,23 +2,23 @@ using VisualizationBase: VisualizationBase using Documenter: Documenter, DocMeta, deploydocs, makedocs DocMeta.setdocmeta!( - VisualizationBase, :DocTestSetup, :(using VisualizationBase); recursive=true + VisualizationBase, :DocTestSetup, :(using VisualizationBase); recursive = true ) include("make_index.jl") makedocs(; - modules=[VisualizationBase], - authors="ITensor developers 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 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 ) diff --git a/docs/make_index.jl b/docs/make_index.jl index 30252ee..b8e7c9b 100644 --- a/docs/make_index.jl +++ b/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 Flatiron Center for Computational Quantum Physics logo. 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, ) diff --git a/docs/make_readme.jl b/docs/make_readme.jl index d0c1e81..bb9831a 100644 --- a/docs/make_readme.jl +++ b/docs/make_readme.jl @@ -2,20 +2,20 @@ using Literate: Literate using VisualizationBase: VisualizationBase function ccq_logo(content) - include_ccq_logo = """ + include_ccq_logo = """ 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)); - 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, ) diff --git a/examples/README.jl b/examples/README.jl index e103b12..59a6390 100644 --- a/examples/README.jl +++ b/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) diff --git a/src/VisualizationBase.jl b/src/VisualizationBase.jl index fd7cb85..83bcb67 100644 --- a/src/VisualizationBase.jl +++ b/src/VisualizationBase.jl @@ -5,71 +5,71 @@ 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 diff --git a/test/runtests.jl b/test/runtests.jl index 98b2d2b..0008050 100644 --- a/test/runtests.jl +++ b/test/runtests.jl @@ -6,60 +6,62 @@ 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`" 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`" 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 diff --git a/test/test_aqua.jl b/test/test_aqua.jl index 34ce1a7..ebd332d 100644 --- a/test/test_aqua.jl +++ b/test/test_aqua.jl @@ -3,5 +3,5 @@ using Aqua: Aqua using Test: @testset @testset "Code quality (Aqua.jl)" begin - Aqua.test_all(VisualizationBase) + Aqua.test_all(VisualizationBase) end diff --git a/test/test_basics.jl b/test/test_basics.jl index 3613907..eae6da9 100644 --- a/test/test_basics.jl +++ b/test/test_basics.jl @@ -2,14 +2,14 @@ using VisualizationBase: VisualizationBase, @visualize, visualize using Test: @test, @testset @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