Merge pull request #75 from jpthiele/precommit

[CI/Infra] Add pre-commit to repo

.codespellrc

@@ -0,0 +1,2 @@
+[codespell]
+ignore-words-list = missings,rcall,linke,fo

.github/workflows/ci.yml

@@ -77,4 +77,4 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
-
+

.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]

.gitignore

@@ -6,4 +6,4 @@ docs/src/*examples
 Manifest*.toml
 .repl_history.jl
 quarry
-*.vtu
+*.vtu

.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

CHANGELOG.md

@@ -1143,5 +1143,3 @@ added DocStringExtensions
 - Add Printf in Project.toml
 
 - Fixed compat...
-
-

docs/src/coordinatesystem.md

@@ -17,4 +17,3 @@ coordinatesystems() #hide
 Modules = [ExtendableGrids]
 Pages = ["coordinatesystem.jl"]
 ```
-

docs/src/elementgeometry.md

@@ -16,4 +16,3 @@ elementgeometries() #hide
 Modules = [ExtendableGrids]
 Pages = ["elementgeometry.jl"]
 ```
-

docs/src/extendablegrid.md

@@ -77,4 +77,3 @@ show(g[NodeCells])
 Modules = [ExtendableGrids]
 Pages = ["extendablegrid.jl"]
 ```
-

docs/src/gridconstructors.md

@@ -13,4 +13,3 @@ Private = false
 Modules = [ExtendableGrids]
 Pages = ["commongrids.jl"]
 ```
-

docs/src/index.md

@@ -4,4 +4,3 @@ Markdown.parse("""
 $(read("../../README.md",String))
 """)
 ````
-

docs/src/more.md

@@ -5,4 +5,3 @@
 Modules = [ExtendableGrids]
 Pages = ["derived.jl","more.jl"]
 ```
-

docs/src/refinement.md

@@ -5,4 +5,3 @@
 Modules = [ExtendableGrids]
 Pages = ["meshrefinements.jl","adaptive_meshrefinements.jl"]
 ```
-

docs/src/regionedit.md

@@ -9,4 +9,3 @@ bfacemask!
 rect!
 bedgemask!
 ```
-

docs/src/shape_specs.md

@@ -8,5 +8,3 @@
 Modules = [ExtendableGrids]
 Pages = ["shape_specs.jl"]
 ```
-
-

docs/src/subgrid.md

@@ -30,4 +30,3 @@ println(subv)
 Modules = [ExtendableGrids]
 Pages = ["subgrid.jl"]
 ```
-

docs/src/tdict.md

@@ -47,4 +47,3 @@ See above ...
 #### Cons
 - Implemented using a Dict, so access is inherently slower than access to a component
   of a struct. Therefore it is not well suited for inner loops.
-

docs/src/tokenstream.md

@@ -9,5 +9,3 @@ reading of tokenizable ASCII files
 Modules = [ExtendableGrids]
 Pages = ["tokenstream.jl"]
 ```
-
-

docs/src/voronoi.md

@@ -5,4 +5,3 @@
 Modules = [ExtendableGrids]
 Pages = ["voronoi.jl"]
 ```
-

examples/experimental/adjacency.jl

@@ -200,4 +200,3 @@ function test_adj_performance(n=100_000)
     """
     nothing
 end
-

examples/vtk_write.jl

@@ -44,4 +44,4 @@ function grid1D_test(filename::String)
     writeVTK(filename::String, g, true; point_data = point_data, 
                               cell_data = cell_data, 
                               field_data = field_data)
-end
+end

src/assemblytypes.jl

@@ -90,4 +90,3 @@ GridComponentGeometries4AssemblyType(AT::Type{<:AssemblyType}) = GridComponent4T
 GridComponentUniqueGeometries4AssemblyType(AT::Type{<:AssemblyType}) = GridComponent4TypeProperty(ItemType4AssemblyType(AT),PROPERTY_UNIQUEGEOMETRY)
 GridComponentRegions4AssemblyType(AT::Type{<:AssemblyType}) = GridComponent4TypeProperty(ItemType4AssemblyType(AT),PROPERTY_REGION)
 GridComponentAssemblyGroups4AssemblyType(AT::Type{<:AssemblyType}) = GridComponent4TypeProperty(ItemType4AssemblyType(AT),PROPERTY_ASSEMBLYGROUP)
-

src/commongrids.jl

@@ -252,4 +252,3 @@ function ringsector(rad,ang; eltype=Triangle2D)
     end
     simplexgrid(coord,cells,cellregions,bfaces,bfaceregions)
 end
-

src/deprecated.jl

@@ -5,4 +5,4 @@ export NodeInParent
 function ExtendableGrids.instantiate(xgrid::ExtendableGrid, ::Type{NodeInParent})
     @warn "NodeInParents is deprecated, use NodeParents instead"
     xgrid[NodeParents]
-end
+end

src/derived.jl

@@ -1347,4 +1347,4 @@ function ExtendableGrids.instantiate(xgrid::ExtendableGrid{Tc,Ti}, ::Type{BEdgeA
         append!(xGeometryGroups, findall(==(EG), xBEdgeGeometries))
     end
     xGeometryGroups
-end
+end

src/serialadjacency.jl

@@ -72,4 +72,4 @@ Append a column to adjacency.
 """
 function Base.append!(adj::SerialVariableTargetAdjacency,len)
     push!(adj.colstart,adj.colstart[end]+len)
-end
+end

src/subgrid.jl

@@ -340,6 +340,3 @@ $(TYPEDSIGNATURES)
 Return size of vector view.
 """
 Base.size(a::SubgridVectorView)=(size(a.node_in_parent,1),)
-
-
-

src/tokenstream.jl

@@ -169,4 +169,3 @@ function trytoken(tks::TokenStream,expected::String)
     end
     return true
 end
-

src/typehierarchy.jl

@@ -46,4 +46,3 @@ function allsubtypes(TApex)
     end
     allsubtypes!(Type[],TApex)
 end
-

src/vectorofconstants.jl

@@ -56,9 +56,3 @@ $(TYPEDSIGNATURES)
 Shortcut for unique
 """
 Base.unique(v::VectorOfConstants)=[v.val]
-
-
-
-
-
-

test/testbinned.jl

@@ -24,4 +24,3 @@ end
 @test testbinning(rand(2, 10000))
 @test testbinning(rand(3, 10))
 @test testbinning(rand(3, 10000))
-

test/tritet.jl

@@ -93,4 +93,3 @@ end
     @test isa(prism(),ExtendableGrid)
     @test isa(material_prism(),ExtendableGrid)
 end
-