Replace test_filter/custom_tests by a single testsuite argument.

Project.toml

@@ -1,7 +1,7 @@
 name = "ParallelTestRunner"
 uuid = "d3525ed8-44d0-4b2c-a655-542cee43accc"
 authors = ["Valentin Churavy <[email protected]>"]
-version = "1.0.3"
+version = "2.0.0"
 
 [deps]
 Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"

README.md

@@ -40,19 +40,41 @@ using ParallelTestRunner
 runtests(MyModule, ARGS)
 ```
 
-### Filtering
+### Customizing the test suite
 
-`runtests` takes a keyword argument that acts as a filter function
+By default, `runtests` automatically discovers all `.jl` files in your `test/` directory (excluding `runtests.jl` itself) using the `find_tests` function. You can customize which tests to run by providing a custom `testsuite` dictionary:
 
 ```julia
-function test_filter(test)
-    if Sys.iswindows() && test == "ext/specialfunctions"
-        return false
+# Manually define your test suite
+testsuite = Dict(
+    "basic" => quote
+        include("basic.jl")
+    end,
+    "advanced" => quote
+        include("advanced.jl")
+    end
+)
+
+runtests(MyModule, ARGS; testsuite)
+```
+
+You can also use `find_tests` to automatically discover tests and then filter or modify them. This requires manually parsing arguments so that filtering is only applied when the user did not request specific tests to run:
+
+```julia
+# Start with autodiscovered tests
+testsuite = find_tests(pwd())
+
+# Parse arguments
+args = parse_args(ARGS)
+
+if filter_tests!(testsuite, args)
+    # Remove tests that shouldn't run on Windows
+    if Sys.iswindows()
+        delete!(testsuite, "ext/specialfunctions")
     end
-    return true
 end
 
-runtests(MyModule, ARGS; test_filter)
+runtests(MyModule, args; testsuite)
 ```
 
 ### Provide defaults