Merge pull request #10 from jpthiele/pre-commit

jpthiele · web-flow · commit e491f74398e8 · 2024-11-26T13:07:30.000+01:00
[CI/Infra] Add pre-commit to repo
diff --git a/.codespellrc b/.codespellrc
@@ -0,0 +1,2 @@
+[codespell]
+ignore-words-list = missings,rcall,linke,fo,bloc
diff --git a/.github/workflows/pre-commit.yml b/.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/action@v3.0.1
diff --git a/.pre-commit-config.yaml b/.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
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -14,4 +14,4 @@ DiffResults = "163ba53b-c6d8-5494-b064-1a9d43ac40c5"
 ForwardDiff = "f6369f11-7733-5829-9624-2563aa707210"
 
 [compat]
-Literate = ">=0.2.7"
+Literate = ">=0.2.7"
diff --git a/docs/src/examples_intro.md b/docs/src/examples_intro.md
@@ -25,4 +25,4 @@ julia> include("ExampleXXX.jl")`
 julia> ExampleXXX.main()
 ```
 - Some examples offer visual output via the optional argument Plotter = PyPlot or Plotter = GLMakie
-(provided the package PyPlot/GLMakie is installed and loaded)
+(provided the package PyPlot/GLMakie is installed and loaded)
diff --git a/docs/src/feevaluator.md b/docs/src/feevaluator.md
@@ -7,4 +7,4 @@ FEEvaluators provide a structure that handles the evaluation of finite element b
 Modules = [ExtendableFEMBase]
 Pages = ["feevaluator.jl"]
 Order   = [:type, :function]
-```
+```
diff --git a/docs/src/fematrix.md b/docs/src/fematrix.md
@@ -6,4 +6,4 @@ A FEMatrix consists of FEMatrixBlocks that share a common ExtendableSparseMatrix
 Modules = [ExtendableFEMBase]
 Pages = ["fematrix.jl"]
 Order   = [:type, :function]
-```
+```
diff --git a/docs/src/fems.md b/docs/src/fems.md
@@ -255,5 +255,3 @@ HCURLN1
 ```@docs
 H1BUBBLE
 ```
-
-
diff --git a/docs/src/fespace.md b/docs/src/fespace.md
@@ -27,4 +27,3 @@ The following DofMap subtypes are available and are used as keys to access the d
 | EdgeDofs           | degrees of freedom for each edge (in 3D)          | 
 | BFaceDofs          | degrees of freedom for each boundary face         |
 | BEdgeDofs          | degrees of freedom for each boundary edge (in 3D) |
-
diff --git a/docs/src/functionoperators.md b/docs/src/functionoperators.md
@@ -66,4 +66,4 @@ as well as for the P2-bubble (H1P2B) finite element type in two dimensions.
 
 ## Operator Pairs (experimental)
 
-Two function operators can be put into an OperatorPair so that one can provide effectively two operators in each argument of an assembly pattern. However, the user should make sure that both operators can be evaluated together reasonably (meaning both should be well-defined on the element geometries and the finite element space where the argument will be evaluated, and the action of the operator has to operate with coressponding input and result fields). This feature is still experimental and might have issues in some cases. OperatorTriple for a combination of three operators is also available.
+Two function operators can be put into an OperatorPair so that one can provide effectively two operators in each argument of an assembly pattern. However, the user should make sure that both operators can be evaluated together reasonably (meaning both should be well-defined on the element geometries and the finite element space where the argument will be evaluated, and the action of the operator has to operate with coressponding input and result fields). This feature is still experimental and might have issues in some cases. OperatorTriple for a combination of three operators is also available.
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -15,4 +15,4 @@ This package provides some low level structures like finite element spaces, inte
 [ForwardDiff.jl](https://github.com/JuliaDiff/ForwardDiff.jl)\
 [DiffResults.jl](https://github.com/JuliaDiff/DiffResults.jl)\
 [UnicodePlots.jl](https://github.com/JuliaPlots/UnicodePlots.jl)\
-[DocStringExtensions.jl](https://github.com/JuliaDocs/DocStringExtensions.jl)
+[DocStringExtensions.jl](https://github.com/JuliaDocs/DocStringExtensions.jl)
diff --git a/docs/src/notebooks_intro.md b/docs/src/notebooks_intro.md
@@ -4,4 +4,3 @@ This sections contains [Pluto.jl](https://github.com/fonsp/Pluto.jl) notebooks.
 
 Please note, that in the html version, interactive elements like sliders are disabled.
 Navigation via the table of contents does work, though.
-
diff --git a/docs/src/package_index.md b/docs/src/package_index.md
@@ -2,4 +2,4 @@
 ```@index
 Modules = [ExtendableFEMBase]
 Order   = [:function, :type]
-```
+```
diff --git a/docs/src/quadrature.md b/docs/src/quadrature.md
@@ -21,4 +21,4 @@ Internally a global integration uses an accumulating vector and calls the cell-w
 
 ```@docs
 AccumulatingVector
-```
+```
diff --git a/docs/src/segmentintegrators.md b/docs/src/segmentintegrators.md
@@ -6,4 +6,4 @@ Segment integrators allow to integrate a finite element function (FEVector) alon
 Modules = [ExtendableFEMBase]
 Pages = ["segment_integrator.jl"]
 Order   = [:type, :function]
-```
+```
diff --git a/examples/Example200_LowLevelPoisson.jl b/examples/Example200_LowLevelPoisson.jl
@@ -208,4 +208,4 @@ function runtests(; order = 2, kwargs...) #hide
 	@info "allocations in 2nd assembly: $loop_allocations"
 	@test loop_allocations == 0
 end #hide
-end #module
+end #module
diff --git a/examples/Example205_LowLevelSpaceTimePoisson.jl b/examples/Example205_LowLevelSpaceTimePoisson.jl
@@ -310,4 +310,4 @@ function generateplots(dir = pwd(); Plotter = nothing, kwargs...)
 	GridVisualize.save(joinpath(dir, "example205.png"), scene; Plotter = Plotter)
 end
 
-end #module
+end #module
diff --git a/ext/ExtendableFEMBaseUnicodePlotsExt.jl b/ext/ExtendableFEMBaseUnicodePlotsExt.jl
@@ -147,4 +147,4 @@ function unicode_scalarplot(
 	end
 end
 
-end
+end
diff --git a/src/.JuliaFormatter.toml b/src/.JuliaFormatter.toml
@@ -3,4 +3,4 @@ pipe_to_function_call = false
 always_for_in = false
 separate_kwargs_with_semicolon = true
 margin = 132
-yas_style_nesting = true
+yas_style_nesting = true
diff --git a/src/dofmaps.jl b/src/dofmaps.jl
@@ -878,4 +878,3 @@ function boundarydofs(FES; dofmap = BFaceDofs, regions = :all)
 		return unique(bdofs)
 	end
 end
-
diff --git a/src/fedefs/hdiv_rt0.jl b/src/fedefs/hdiv_rt0.jl
@@ -128,5 +128,3 @@ function get_coefficients(::Type{ON_CELLS}, FE::FESpace{Tv, Ti, <:HDIVRT0, APT},
 		return nothing
 	end
 end
-
-
diff --git a/src/fedefs/legendre.jl b/src/fedefs/legendre.jl
@@ -3,4 +3,4 @@
 L1(s) = 1
 L2(s) = s - 1//2
 L3(s) = s^2 - s + 1//6
-L4(s) = s^3 - s^2 / 2 + s / 10 - 1 // 20
+L4(s) = s^3 - s^2 / 2 + s / 10 - 1 // 20
diff --git a/src/feevaluator_hcurl.jl b/src/feevaluator_hcurl.jl
@@ -76,4 +76,3 @@ function update_basis!(FEBE::SingleFEEvaluator{<:Real, <:Real, <:Integer, <:Curl
 	end
 	return nothing
 end
-
diff --git a/src/fematrix.jl b/src/fematrix.jl
@@ -640,4 +640,4 @@ function submatrix(A::AbstractExtendableSparseMatrixCSC{Tv, Ti}, srows, scols) w
 	end
 	flush!(S)
 	return S
-end
+end
diff --git a/src/interpolations.jl b/src/interpolations.jl
@@ -1068,4 +1068,3 @@ function displace_mesh(xgrid::ExtendableGrid, source::FEVectorBlock; kwargs...)
 	displace_mesh!(xgrid_displaced, source; kwargs...)
 	return xgrid_displaced
 end
-
diff --git a/test/Project.toml b/test/Project.toml
@@ -11,4 +11,4 @@ Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
 UnicodePlots = "b8865327-cd53-5732-bb35-84acbb429228"
 
 [compat]
-Aqua = "0.8"
+Aqua = "0.8"

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+[codespell]`
	`2`	`+ignore-words-list = missings,rcall,linke,fo,bloc`
Original file line number	Diff line number	Diff line change
`@@ -66,4 +66,4 @@ as well as for the P2-bubble (H1P2B) finite element type in two dimensions.`
`66`	`66`
`67`	`67`	`## Operator Pairs (experimental)`
`68`	`68`
`69`		-Two function operators can be put into an OperatorPair so that one can provide effectively two operators in each argument of an assembly pattern. However, the user should make sure that both operators can be evaluated together reasonably (meaning both should be well-defined on the element geometries and the finite element space where the argument will be evaluated, and the action of the operator has to operate with coressponding input and result fields). This feature is still experimental and might have issues in some cases. OperatorTriple for a combination of three operators is also available.
	`69`	+Two function operators can be put into an OperatorPair so that one can provide effectively two operators in each argument of an assembly pattern. However, the user should make sure that both operators can be evaluated together reasonably (meaning both should be well-defined on the element geometries and the finite element space where the argument will be evaluated, and the action of the operator has to operate with coressponding input and result fields). This feature is still experimental and might have issues in some cases. OperatorTriple for a combination of three operators is also available.