Runic formatting, update template (#73)

Author: mtfishman

.JuliaFormatter.toml

@@ -2,7 +2,7 @@ name: "CompatHelper"
 
 on:
   schedule:
-    - cron: 0 0 * * *
+    - cron: '0 0 * * *'
   workflow_dispatch:
 permissions:
   contents: write

.github/workflows/CompatHelper.yml

@@ -1,11 +1,14 @@
 name: "Format Check"
 
 on:
-  push:
-    branches:
-      - 'main'
-    tags: '*'
-  pull_request:
+  pull_request_target:
+    paths: ['**/*.jl']
+    types: [opened, synchronize, reopened, ready_for_review]
+
+permissions:
+  contents: read
+  actions: write
+  pull-requests: write
 
 jobs:
   format-check:

.github/workflows/FormatCheck.yml

@@ -9,6 +9,10 @@
 .vscode/
 Manifest.toml
 benchmark/*.json
+dev/
+docs/LocalPreferences.toml
 docs/Manifest.toml
 docs/build/
 docs/src/index.md
+examples/LocalPreferences.toml
+test/LocalPreferences.toml

.gitignore

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

.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 name = "GradedArrays"
 uuid = "bc96ca6e-b7c8-4bb6-888e-c93f838762c2"
 authors = ["ITensor developers <[email protected]> and contributors"]
-version = "0.5.0"
+version = "0.5.1"
 
 [deps]
 ArrayLayouts = "4c555306-a7a7-4459-81d9-ec55ddd5c99a"

Project.toml

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

docs/make.jl

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

docs/make_index.jl

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

docs/make_readme.jl

@@ -1,5 +1,5 @@
 # # GradedArrays.jl
-# 
+#
 # [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://itensor.github.io/GradedArrays.jl/stable/)
 # [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://itensor.github.io/GradedArrays.jl/dev/)
 # [![Build Status](https://github.com/ITensor/GradedArrays.jl/actions/workflows/Tests.yml/badge.svg?branch=main)](https://github.com/ITensor/GradedArrays.jl/actions/workflows/Tests.yml?query=branch%3Amain)