Merge pull request #154 from jpthiele/precommit

[CI/Infra] Add pre-commit to repo

.github/workflows/pre-commit.yml

@@ -0,0 +1,21 @@
+name: pre-commit
+
+on:
+  pull_request:
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: julia-actions/setup-julia@v2
+      with:
+        version: 1.11
+    - run: |
+          julia --project=@runic -e '
+            using Pkg
+            Pkg.add("Runic")'
+      env:
+        PYTHON: ""
+    - uses: actions/setup-python@v5
+    - uses: pre-commit/[email protected]

.pre-commit-config.yaml

@@ -0,0 +1,21 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v5.0.0
+  hooks:
+  - id: check-added-large-files
+    args: [--maxkb=8192]
+  - id: check-merge-conflict
+  - id: check-toml
+  - id: check-yaml
+    args: [--allow-multiple-documents]
+  - id: end-of-file-fixer
+  - id: no-commit-to-branch
+    args: [--branch,master]
+- repo: https://github.com/gitleaks/gitleaks
+  rev: v8.16.3
+  hooks:
+  - id: gitleaks
+- repo: https://github.com/codespell-project/codespell
+  rev: v2.2.4
+  hooks:
+  - id: codespell

CITATIONS.bib

@@ -224,6 +224,3 @@ @inproceedings{cances2020four
   doi="10.1007/978-3-030-43651-3_13",
   organization={Springer}
 }
-
-
-

docs/src/devel.md

@@ -6,8 +6,3 @@ The pluto notebooks in this package are "triple use":
 - As typical Pluto notebooks, they are self-contained in the senses that they contain their own Project and Manifest files. So users can just download and execute them.
 - If they run with the environment variable `PLUTO_PROJECT` set to some julia environment, this environment will activated at the start of the notebook. In particular, they use `Revise.jl` so they can be run during development of VoronoiFVM.jl. See also  https://github.com/fonsp/Pluto.jl/issues/1788 .
 - During CI tests, they are run as scripts. For this purpose they are wrapped into temporary modules, and @test macros can be used in the notebooks.
-
-
-
-
-

docs/src/grid.md

@@ -48,6 +48,3 @@ Pages = [
 ]
 Order = [:function]
 ```
-
-
-

docs/src/impedance-derivation.tex

@@ -366,13 +366,3 @@ \section{Algorithmic implementation}
 \end{description}
 
 \end{document}
-
-
-
-
-
-
-
-
-
-

docs/src/index.md

@@ -13,5 +13,3 @@ Please consider a pull request updating `CITATION.bib` if you have published wor
 ```@bibliography
 *
 ```
-
-

docs/src/method.md

@@ -165,5 +165,3 @@ The entities describing the discrete system can be subdivided into two categorie
 
 The solution of the nonlinear systems of equations is performed by Newton's method combined with various direct and iterative linear solvers. The Jacobi matrices used in Newton's method are assembled from the constitutive functions
 with the help of forward mode automatic differentiation implemented in  [ForwardDiff.jl](https://github.com/JuliaDiff/ForwardDiff.jl).
-
-

docs/src/notebooks.md

@@ -3,4 +3,3 @@ About the notebooks
 [Pluto.jl](https://github.com/fonsp/Pluto.jl) notebooks provide a great opportunity to put together code, text and graphics 
 in a reproducible and accessible way. Therefore, the examples for this package are being  amended by a series of Pluto notebooks.
 Like the example code, the notebook code is tested during CI.
-

docs/src/post.md

@@ -63,4 +63,3 @@ after the solution of the unexcited stationary system.
 Modules = [VoronoiFVM]
 Pages = ["vfvm_impedance.jl"]
 ```
-

docs/src/solutions.md

@@ -23,4 +23,3 @@ Pages=["vfvm_sparsesolution.jl"]
 Modules = [VoronoiFVM]
 Pages=["vfvm_transientsolution.jl"]
 ```
-

docs/src/solver.md

@@ -160,4 +160,3 @@ NoBlock
 EquationBlock
 PointBlock
 ```
-

docs/src/system.md

@@ -121,4 +121,3 @@ VoronoiFVM.SparseSystem
 viewK
 viewL
 ```
-

examples/.JuliaFormatter.toml

@@ -1,4 +1,3 @@
 style = "sciml"
 always_for_in = false
 separate_kwargs_with_semicolon = true
-

src/vfvm_history.jl

@@ -169,4 +169,3 @@ history_details(sol) = details(sol.history)
 Return summary of solver history from last `solve` call, if `log` was set to true.
 """
 history_summary(sol) = summary(sol.history)
-

test/runtests.jl

@@ -96,7 +96,3 @@ elseif haskey(ENV,"NOTEBOOKS_ONLY")
 else
     run_all_tests(; run_notebooks = VERSION < v"1.12.0-DEV.0" , notebooksonly = false)
 end
-
-
-
-

test/test_formfactors.jl

@@ -25,4 +25,3 @@ end
 
 
 end
-

test/test_state.jl

@@ -49,4 +49,3 @@ function runtests()
 
 end
 end
-