Skip to content

Latest commit

 

History

History
34 lines (27 loc) · 1.88 KB

README.md

File metadata and controls

34 lines (27 loc) · 1.88 KB

Aqua.jl: Auto QUality Assurance for Julia packages

Stable Dev GitHub Actions Build Status Codecov Coveralls GitHub commits since tagged version Aqua QA

Aqua.jl provides functions to run a few automatable checks for Julia packages:

  • There are no method ambiguities.
  • There are no undefined exports.
  • There are no unbound type parameters.
  • There are no stale dependencies listed in Project.toml (optional).
  • Check that test target of the root project Project.toml and test project (test/Project.toml) are consistent (optional).
  • Check that all external packages listed in deps have corresponding compat entry (optional).
  • Project.toml formatting is compatible with Pkg.jl output (optional).

Quick usage

Call Aqua.test_all(YourPackage) from test/runtests.jl, e.g.,

using YourPackage
using Aqua
Aqua.test_all(YourPackage)

See more in the documentation.