Update templates

Author: lkdvos

templates/docs/docs/make.jl

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

templates/docs/docs/make_index.jl

@@ -2,20 +2,20 @@ using Literate: Literate
 using {PKGNAME}: {PKGNAME}
 
 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({PKGNAME}), "examples", "README.jl"),
-  joinpath(pkgdir({PKGNAME}), "docs", "src");
-  flavor=Literate.DocumenterFlavor(),
-  name="index",
-  postprocess=ccq_logo,
+    joinpath(pkgdir({PKGNAME}), "examples", "README.jl"),
+    joinpath(pkgdir({PKGNAME}), "docs", "src");
+    flavor = Literate.DocumenterFlavor(),
+    name = "index",
+    postprocess = ccq_logo,
 )

templates/docs/docs/make_readme.jl

@@ -2,20 +2,20 @@ using Literate: Literate
 using {PKGNAME}: {PKGNAME}
 
 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({PKGNAME}), "examples", "README.jl"),
-  joinpath(pkgdir({PKGNAME}));
-  flavor=Literate.CommonMarkFlavor(),
-  name="README",
-  postprocess=ccq_logo,
+    joinpath(pkgdir({PKGNAME}), "examples", "README.jl"),
+    joinpath(pkgdir({PKGNAME}));
+    flavor = Literate.CommonMarkFlavor(),
+    name = "README",
+    postprocess = ccq_logo,
 )

templates/examples/examples/README.jl

@@ -22,13 +22,13 @@
 ```julia
 julia> using Pkg: Pkg
 
-julia> Pkg.Registry.add(url="https://github.com/ITensor/ITensorRegistry")
+julia> Pkg.Registry.add(url = "https://github.com/ITensor/ITensorRegistry")
 ```
 =#
 # or:
 #=
 ```julia
-julia> Pkg.Registry.add(url="git@github.com:ITensor/ITensorRegistry.git")
+julia> Pkg.Registry.add(url = "git@github.com:ITensor/ITensorRegistry.git")
 ```
 =#
 # if you want to use SSH credentials, which can make it so you don't have to enter your Github ursername and password when registering packages.

templates/formatter/.JuliaFormatter.toml

@@ -1,5 +1,11 @@
 name: "Format Check"
 
+permissions:
+  contents: read
+  checks: write
+  issues: write
+  pull-requests: write
+
 on:
   push:
     branches:

templates/github/.github/workflows/FormatCheck.yml

@@ -1,5 +1,5 @@
 ci:
-  skip: [julia-formatter]
+  skip: [runic]
 
 repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
@@ -11,7 +11,7 @@ repos:
   - id: end-of-file-fixer
     exclude_types: [markdown]  # incompatible with Literate.jl
 
-- repo: "https://github.com/domluna/JuliaFormatter.jl"
-  rev: v2.1.6
+- repo: https://github.com/fredrikekre/runic-pre-commit
+  rev: v2.0.1
   hooks:
-  - id: "julia-formatter"
+    - id: runic

templates/precommit/.pre-commit-config.yaml

@@ -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

templates/test/test/runtests.jl

@@ -3,5 +3,5 @@ using Aqua: Aqua
 using Test: @testset
 
 @testset "Code quality (Aqua.jl)" begin
-  Aqua.test_all({PKGNAME})
+    Aqua.test_all({PKGNAME})
 end

templates/test/test/test_aqua.jl

@@ -2,5 +2,5 @@ using {PKGNAME}: {PKGNAME}
 using Test: @test, @testset
 
 @testset "{PKGNAME}" begin
-  # Tests go here.
+    # Tests go here.
 end