Merge pull request #18 from control-toolbox/17-dev-add-aqua-and-blue-…

…style

add aqua and blue

.github/workflows/Formatter.yml

@@ -17,7 +17,7 @@ jobs:
       - name: Install JuliaFormatter and format
         run: |
           julia  -e 'import Pkg; Pkg.add("JuliaFormatter")'
-          julia  -e 'using JuliaFormatter; format(".")'
+          julia  -e 'using JuliaFormatter; format(".", BlueStyle())'
       # https://github.com/marketplace/actions/create-pull-request
       # https://github.com/peter-evans/create-pull-request#reference-example
       - name: Create Pull Request

Project.toml

@@ -2,3 +2,6 @@ name = "GeometricPreconditioner"
 uuid = "4fb4c77a-c2a1-4666-8b47-e5158870c0af"
 authors = ["Olivier Cots <olivier.cots@irit.fr>"]
 version = "0.1.1"
+
+[compat]
+julia = "1.10"

README.md

@@ -12,14 +12,22 @@
 [doc-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
 [doc-stable-url]: https://control-toolbox.org/preconditioning/stable/
 
+[licence-img]: https://img.shields.io/badge/License-MIT-yellow.svg
+[licence-url]: https://github.com/control-toolbox/preconditioning/blob/master/LICENSE
+
+[aqua-img]: https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg
+[aqua-url]: https://github.com/JuliaTesting/Aqua.jl
+
 This repo is part of the [control-toolbox ecosystem](https://github.com/control-toolbox). 
 The control-toolbox ecosystem gathers Julia packages for mathematical control and applications. The root package is [OptimalControl.jl](https://github.com/control-toolbox/OptimalControl.jl) which aims to provide tools to modelise and solve optimal control problems with ordinary differential equations by direct and indirect methods. 
 
 [![doc OptimalControl.jl](https://img.shields.io/badge/Documentation-OptimalControl.jl-blue)](http://control-toolbox.org/OptimalControl.jl)
 
-| **Documentation**  | **Code Status**  |
-|:-------------------|:-----------------|
-| [![Documentation][doc-stable-img]][doc-stable-url] [![Documentation][doc-dev-img]][doc-dev-url] | [![Build Status][ci-img]][ci-url] [![Covering Status][co-img]][co-url] |
+| **Name**          | **Badge**         |
+:-------------------|:------------------|
+| Documentation     | [![Documentation][doc-stable-img]][doc-stable-url] [![Documentation][doc-dev-img]][doc-dev-url]                   | 
+| Code Status       | [![Build Status][ci-img]][ci-url] [![Covering Status][co-img]][co-url] [![Aqua.jl][aqua-img]][aqua-url] |
+| Licence           | [![License: MIT][licence-img]][licence-url]   |
 
 ## Contributing
 

test/Project.toml

@@ -1,2 +1,7 @@
 [deps]
+Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+
+[compat]
+Aqua = "0.8"
+julia = "1.10"

test/runtests.jl

@@ -1,9 +1,10 @@
-using Test
+using Aqua
 using GeometricPreconditioner
+using Test
 
 #
 @testset verbose = true showtiming = true "Base" begin
-    for name ∈ (:default,)
+    for name ∈ (:aqua, :default)
         @testset "$(name)" begin
             test_name = Symbol(:test_, name)
             include("$(test_name).jl")

test/test_aqua.jl

@@ -0,0 +1,13 @@
+function test_aqua()
+    @testset "Aqua.jl" begin
+        Aqua.test_all(
+            GeometricPreconditioner;
+            ambiguities=false,
+            #stale_deps=(ignore=[:SomePackage],),
+            deps_compat=(ignore=[:LinearAlgebra, :Unicode],),
+            piracies=true,
+        )
+        # do not warn about ambiguities in dependencies
+        Aqua.test_ambiguities(GeometricPreconditioner)
+    end
+end