test: add DispatchDoctor (no type-stability) (#15)

Author: oameye

Project.toml

@@ -4,19 +4,22 @@ authors = ["Orjan Ameye <[email protected]>"]
 version = "0.1.0"
 
 [deps]
+DispatchDoctor = "8d63f2c5-f18a-4cf2-ba9d-b3f60fc568c8"
 DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
 LaTeXStrings = "b964fa9f-0449-5b57-a5c2-d3ea65f4040f"
 
 [compat]
 Aqua = "0.8.11"
 CheckConcreteStructs = "0.1"
-Documenter = "1.11"
+DispatchDoctor = "0.4.19"
 DocStringExtensions = "0.9.4"
+Documenter = "1.11"
 ExplicitImports = "1.11"
 JET = "0.9.18, 0.10"
 LaTeXStrings = "1.4"
 Test = "1.10"
 julia = "1.10"
+Preferences = "1"
 
 [extras]
 Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
@@ -25,6 +28,7 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 ExplicitImports = "7d51a73a-1435-4ff3-83d9-f097790105c7"
 JET = "c3a54625-cd67-489e-a8e7-0a5a0ff4e31b"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+Preferences = "21216c6a-2e73-6563-6e65-726566657250"
 
 [targets]
-test = ["JET", "CheckConcreteStructs", "ExplicitImports", "Test", "Aqua", "Documenter"]
+test = ["JET", "CheckConcreteStructs", "ExplicitImports", "Test", "Aqua", "Documenter", "Preferences"]

src/VanVleckRecursion.jl

@@ -2,20 +2,21 @@
 $(DocStringExtensions.README)
 """
 module VanVleckRecursion
+using DispatchDoctor: @stable
+@stable default_mode = "disable" begin
+    using DocStringExtensions: DocStringExtensions
+    using LaTeXStrings: LaTeXStrings
 
-using DocStringExtensions: DocStringExtensions
-using LaTeXStrings: LaTeXStrings
-
-# Export Kamiltonian and Generator functions
-export K, S, kamiltonian_get, generator_get, set_hamiltonian!, clear_caches!, latex
-export Terms, Term
-
-include("types.jl")
-include("operations.jl")
-include("comparison.jl")
-include("collections.jl")
-include("arithmetic.jl")
-include("display.jl")
-include("kamiltonian.jl")
+    # Export Kamiltonian and Generator functions
+    export K, S, kamiltonian_get, generator_get, set_hamiltonian!, clear_caches!, latex
+    export Terms, Term
 
+    include("types.jl")
+    include("operations.jl")
+    include("comparison.jl")
+    include("collections.jl")
+    include("arithmetic.jl")
+    include("display.jl")
+    include("kamiltonian.jl")
+end
 end # module VanVleckRecursion

test/runtests.jl

@@ -1,9 +1,3 @@
-"""
-Test suite for VanVleckRecursion.jl
-
-This test suite verifies the functionality of the Van Vleck recursion implementation.
-"""
-
 using Test
 using VanVleckRecursion
 
@@ -44,6 +38,10 @@ end
     all_concrete(VVR.Terms)
 end
 
+using Preferences: set_preferences!
+
+set_preferences!("VanVleckRecursion", "dispatch_doctor_mode" => "error")
+
 # Include all test files
 include("types.jl")
 include("operations.jl")