Aqua + typos CI

Author: ArnoStrouwen

.github/workflows/SpellCheck.yml

@@ -0,0 +1,13 @@
+name: Spell Check
+
+on: [pull_request]
+
+jobs:
+  typos-check:
+    name: Spell Check with Typos
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Actions Repository
+        uses: actions/checkout@v3
+      - name: Check spelling
+        uses: crate-ci/typos@v1.16.23 

.typos.toml

@@ -0,0 +1 @@
+[default.extend-words]

Project.toml

@@ -17,21 +17,25 @@ StochasticDiffEq = "789caeaf-c7a9-5a7d-9973-96adeb23e2a0"
 TreeViews = "a2a6695c-b41b-5b7d-aed9-dbfdeacea5d7"
 
 [compat]
+Aqua = "0.8"
 DiffEqBase = "6.5"
 FiniteDiff = "2.3"
 ForwardDiff = "0.10"
 OrdinaryDiffEq = "5.33, 6"
 RecursiveArrayTools = "1,2"
+SafeTestsets = "0.1"
 SparseDiffTools = "1.6, 2"
 Statistics = "1"
 StochasticDiffEq = "6.13"
+Test = "1"
 TreeViews = "0.3"
 julia = "1.6"
 
 [extras]
+Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
 OrdinaryDiffEq = "1dea7af3-3e70-54e6-95c3-0bf5283fa5ed"
 SafeTestsets = "1bc83da4-3b8d-516f-aca4-4fe02f6d838f"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]
-test = ["OrdinaryDiffEq", "SafeTestsets", "Test"]
+test = ["Aqua", "OrdinaryDiffEq", "SafeTestsets", "Test"]

README.md

@@ -64,7 +64,7 @@ Let's build a version of this. Using the constructors we can directly construct
 cell1 = Cell([1.0; 2.0; 3.0])
 cell2 = Cell([4.0; 5.0])
 ```
-and build types higher up in the hierarchy by using the `constuct` method. The method
+and build types higher up in the hierarchy by using the `construct` method. The method
 is `construct(T::AbstractMultiScaleArray, nodes, values)`, though if `values` is not given it's
 taken to be empty.
 ```julia

docs/src/index.md

@@ -60,7 +60,7 @@ cell1 = Cell([1.0; 2.0; 3.0])
 cell2 = Cell([4.0; 5.0])
 ```
 
-and build types higher up in the hierarchy by using the `constuct` method. The method
+and build types higher up in the hierarchy by using the `construct` method. The method
 is `construct(T::AbstractMultiScaleArray, nodes, values)`, though, if `values` is not given, it's
 taken to be empty.
 

test/qa.jl

@@ -0,0 +1,12 @@
+using MultiScaleArrays, Aqua
+@testset "Aqua" begin
+    Aqua.find_persistent_tasks_deps(MultiScaleArrays)
+    Aqua.test_ambiguities(MultiScaleArrays, recursive = false)
+    Aqua.test_deps_compat(MultiScaleArrays)
+    Aqua.test_piracies(MultiScaleArrays,
+        treat_as_own = [])
+    Aqua.test_project_extras(MultiScaleArrays)
+    Aqua.test_stale_deps(MultiScaleArrays)
+    Aqua.test_unbound_args(MultiScaleArrays)
+    Aqua.test_undefined_exports(MultiScaleArrays)
+end

test/runtests.jl

@@ -1,6 +1,7 @@
 using MultiScaleArrays, OrdinaryDiffEq, DiffEqBase, StochasticDiffEq, SafeTestsets
 using Test
 
+@time @safetestset "Quality Assurance" begin include("qa.jl") end
 @time @testset "Tuple Nodes" begin include("tuple_nodes.jl") end
 @time @testset "Bisect Search Tests" begin include("bisect_search_tests.jl") end
 @time @testset "Indexing and Creation Tests" begin include("indexing_and_creation_tests.jl") end