Add tests with Aqua.jl (JuliaArrays#1212)

* remove coveralls badge

* move docs badges to the top

* add Aqua badge

* rename test/ambiguities.jl -> test/aqua.jl

* add Aqua.jl as a test dependency

* use Aqua.jl in test

* disable Project.toml formatting in Julia v1.6

* add compat for Aqua.jl

Author: hyrodium

Project.toml

@@ -16,11 +16,13 @@ Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
 StaticArraysStatisticsExt = "Statistics"
 
 [compat]
+Aqua = "0.7"
 PrecompileTools = "1"
 StaticArraysCore = "~1.4.0"
 julia = "1.6"
 
 [extras]
+Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
 BenchmarkTools = "6e4b80f9-dd63-53aa-95a3-0cdb28fa8baf"
 InteractiveUtils = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
 OffsetArrays = "6fe1bfb0-de20-5000-8ca7-80f57d26f881"
@@ -29,4 +31,4 @@ Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 Unitful = "1986cc42-f94f-5a68-af5c-568840ba703d"
 
 [targets]
-test = ["InteractiveUtils", "Test", "BenchmarkTools", "OffsetArrays", "Statistics", "Unitful"]
+test = ["InteractiveUtils", "Test", "BenchmarkTools", "OffsetArrays", "Statistics", "Unitful", "Aqua"]

README.md

@@ -2,11 +2,11 @@
 
 *Statically sized arrays for Julia*
 
-[![Build Status](https://github.com/JuliaArrays/StaticArrays.jl/workflows/CI/badge.svg)](https://github.com/JuliaArrays/StaticArrays.jl/actions?query=workflow%3ACI)
-[![Coverage Status](https://coveralls.io/repos/github/JuliaArrays/StaticArrays.jl/badge.svg?branch=master)](https://coveralls.io/github/JuliaArrays/StaticArrays.jl?branch=master)
-[![codecov.io](https://codecov.io/github/JuliaArrays/StaticArrays.jl/branch/master/graph/badge.svg)](http://codecov.io/github/JuliaArrays/StaticArrays.jl/branch/master)
 [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://JuliaArrays.github.io/StaticArrays.jl/stable)
 [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://JuliaArrays.github.io/StaticArrays.jl/dev)
+[![Build Status](https://github.com/JuliaArrays/StaticArrays.jl/workflows/CI/badge.svg)](https://github.com/JuliaArrays/StaticArrays.jl/actions?query=workflow%3ACI)
+[![codecov.io](https://codecov.io/github/JuliaArrays/StaticArrays.jl/branch/master/graph/badge.svg)](http://codecov.io/github/JuliaArrays/StaticArrays.jl/branch/master)
+[![Aqua QA](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)
 [![deps](https://juliahub.com/docs/StaticArrays/deps.svg)](https://juliahub.com/ui/Packages/StaticArrays/yY9vm?t=2)
 [![version](https://juliahub.com/docs/StaticArrays/version.svg)](https://juliahub.com/ui/Packages/StaticArrays/yY9vm)
 

test/ambiguities.jl

@@ -0,0 +1,44 @@
+if VERSION ≥ v"1.7-"
+    Aqua.test_all(StaticArrays, piracy=false)
+    Aqua.test_piracy(StaticArrays, treat_as_own=[
+            StaticArray
+            Size
+            SArray
+            MArray
+            SizedArray
+            FieldArray
+            StaticArrays.StaticArrayStyle
+            StaticArrays.SOneTo
+            StaticArrays.StaticArraysCore
+            StaticArrays.check_array_parameters
+            StaticArrays.convert_ntuple
+        ],
+        broken=true)
+
+elseif VERSION ≥ v"1.6-"
+    Aqua.test_all(StaticArrays, piracy=false, ambiguities=false, project_toml_formatting=false)
+    Aqua.test_piracy(StaticArrays, treat_as_own=[
+            StaticArray
+            Size
+            SArray
+            MArray
+            SizedArray
+            FieldArray
+            StaticArrays.StaticArrayStyle
+            StaticArrays.SOneTo
+            StaticArrays.StaticArraysCore
+            StaticArrays.check_array_parameters
+            StaticArrays.convert_ntuple
+        ],
+        broken=true)
+
+    # Allow no new ambiguities (see #18), unless you fix some old ones first!
+    # TODO: Revisit and fix. See
+    #   https://github.com/JuliaLang/julia/pull/36962
+    #   https://github.com/JuliaLang/julia/issues/36951
+    # Let's not allow new ambiguities. If any change makes the ambiguity count decrease, the
+    # change should decrement `allowable_ambiguities` accordingly
+    allowable_ambiguities = 1
+    @test length(detect_ambiguities(StaticArrays)) == allowable_ambiguities
+
+end

test/aqua.jl

@@ -1,5 +1,6 @@
 using StaticArrays, Test, Random, LinearAlgebra
 using InteractiveUtils
+using Aqua
 
 # We generate a lot of matrices using rand(), but unit tests should be
 # deterministic. Therefore seed the RNG here (and further down, to avoid test
@@ -45,7 +46,7 @@ if TEST_GROUP ∈ ["", "all", "group-A"]
         addtests("empty_array_syntax.jl")
     end
 
-    addtests("ambiguities.jl")
+    addtests("aqua.jl")
     addtests("unbound_args.jl")
     addtests("custom_types.jl")
     addtests("convert.jl")