Merge pull request WIAS-PDELib#33 from WIAS-PDELib/feature/runic

Add Runic Code Quality check and badge

Author: pjaap

.pre-commit-config.yaml

@@ -19,3 +19,7 @@ repos:
   rev: v2.4.1
   hooks:
   - id: codespell
+- repo: https://github.com/fredrikekre/runic-pre-commit
+  rev: v1.0.0
+  hooks:
+  - id: runic

README.md

@@ -2,6 +2,7 @@
 [![](https://img.shields.io/badge/docs-stable-blue.svg)](https://wias-pdelib.github.io/ExtendableFEMBase.jl/stable/index.html)
 [![](https://img.shields.io/badge/docs-dev-blue.svg)](https://wias-pdelib.github.io/ExtendableFEMBase.jl/dev/index.html)
 [![DOI](https://zenodo.org/badge/667751152.svg)](https://zenodo.org/doi/10.5281/zenodo.10563410)
+[![code style: runic](https://img.shields.io/badge/code_style-%E1%9A%B1%E1%9A%A2%E1%9A%BE%E1>
 
 # ExtendableFEMBase
 

docs/make.jl

@@ -7,42 +7,42 @@ using CairoMakie
 
 function make_all(; with_examples::Bool = true)
 
-	module_examples = []
-    pluto_examples = [] 
+    module_examples = []
+    pluto_examples = []
 
     if with_examples
-        
-		DocMeta.setdocmeta!(ExampleJuggler, :DocTestSetup, :(using ExampleJuggler); recursive = true)
-
-		example_dir = joinpath(@__DIR__, "..", "examples")
-		pluto_example_dir = joinpath(@__DIR__, "..", "pluto-examples")
-
-		modules = [
-			"Example200_LowLevelPoisson.jl",
-			"Example205_LowLevelSpaceTimePoisson.jl",
-			"Example210_LowLevelNavierStokes.jl",
-			"Example280_BasisPlotter.jl",
-			"Example281_DiscontinuousPlot.jl",
-			"Example290_InterpolationBetweenMeshes.jl",
-		]
-        
+
+        DocMeta.setdocmeta!(ExampleJuggler, :DocTestSetup, :(using ExampleJuggler); recursive = true)
+
+        example_dir = joinpath(@__DIR__, "..", "examples")
+        pluto_example_dir = joinpath(@__DIR__, "..", "pluto-examples")
+
+        modules = [
+            "Example200_LowLevelPoisson.jl",
+            "Example205_LowLevelSpaceTimePoisson.jl",
+            "Example210_LowLevelNavierStokes.jl",
+            "Example280_BasisPlotter.jl",
+            "Example281_DiscontinuousPlot.jl",
+            "Example290_InterpolationBetweenMeshes.jl",
+        ]
+
         notebooks = [
             "Low level Poisson" => "LowLevelPoisson.jl"
             "Low level Navier-Stokes" => "LowLevelNavierStokes.jl"
         ]
 
-		cleanexamples()
+        cleanexamples()
 
-		module_examples = @docmodules(example_dir, modules, Plotter = CairoMakie)
-        pluto_examples = @docplutonotebooks(pluto_example_dir, notebooks, iframe=false)
+        module_examples = @docmodules(example_dir, modules, Plotter = CairoMakie)
+        pluto_examples = @docplutonotebooks(pluto_example_dir, notebooks, iframe = false)
         pushfirst!(module_examples, "Introduction" => "examples_intro.md")
 
     end
 
     makedocs(
-        modules=[ExtendableFEMBase],
-        sitename="ExtendableFEMBase.jl",
-        authors="Christian Merdon",
+        modules = [ExtendableFEMBase],
+        sitename = "ExtendableFEMBase.jl",
+        authors = "Christian Merdon",
         format = Documenter.HTML(repolink = "https://github.com/WIAS-PDELib/ExtendableFEMBase.jl", size_threshold = 250000, mathengine = MathJax3()),
         clean = false,
         checkdocs = :none, # :all or :exports currently causes UndefVarError
@@ -53,26 +53,26 @@ function make_all(; with_examples::Bool = true)
             "Index" => "package_index.md",
             "List of Finite Elements" => "fems.md",
             "Base Structures" => Any[
-                    "fespace.md",
-                    "fevector.md",
-                    "fematrix.md",
-                    "functionoperators.md",
-                    "feevaluator.md",
-                    "interpolations.md",
-                    "quadrature.md"
-                ],
+                "fespace.md",
+                "fevector.md",
+                "fematrix.md",
+                "functionoperators.md",
+                "feevaluator.md",
+                "interpolations.md",
+                "quadrature.md",
+            ],
             "Advanced Stuff" => Any[
                 "pointevaluators.md",
                 "segmentintegrators.md",
-                "plots.md"
+                "plots.md",
             ],
             "Tutorial Notebooks" => pluto_examples,
             "Examples" => module_examples,
         ]
     )
 
-	cleanexamples()
-    
+    return cleanexamples()
+
 end
 
 make_all(; with_examples = true)