Add --test flag for app (#166)

* add `--test` flag to app

* add test

Author: ericphanson

README.md

@@ -270,6 +270,8 @@ OPTIONS
            Show this message
        --check
            Run checks instead of printing. If --checklist is not specified, all checks are run
+       --test
+           Run Test.jl-style checks instead of printing
        --checklist <check1,check2>,...
            Run checks specified by <check1>,<check2>,...
            This will imply --check.

src/main.jl

@@ -135,6 +135,8 @@ function print_help()
     println(io, "       --check")
     println(io,
             "           Run checks instead of printing. If --checklist is not specified, all checks are run")
+    println(io, "       --test")
+    println(io, "           Run Test.jl-style checks instead of printing")
     println(io, "       --checklist <check1,check2>,...")
     println(io,
             """           Run checks specified by <check1>,<check2>,...
@@ -160,6 +162,7 @@ function main(args)
     valid_check_values = [CHECKS; "all"; EXCLUDE_PREFIX .* CHECKS]
     selected_checks = copy(CHECKS)
     should_run_checks = false
+    should_run_tests = false
     should_print = false
     path = "."
 
@@ -172,6 +175,8 @@ function main(args)
             return 0
         elseif x == "--check"
             should_run_checks = true
+        elseif x == "--test"
+            should_run_tests = true
         elseif x == "--print"
             should_print = true
         elseif x == "--checklist"
@@ -216,8 +221,12 @@ function main(args)
         end
     end
 
+    if should_run_tests && should_run_checks
+        return err("Arguments `--test` and `--check`/`--checklist` are mutually exclusive.")
+    end
+
     # Print by default
-    if !should_run_checks && !should_print
+    if !should_run_checks && !should_run_tests && !should_print
         should_print = true
     end
 
@@ -237,6 +246,15 @@ function main(args)
             return 1
         end
     end
+    if should_run_tests
+        try
+            @eval Main $ExplicitImports.test_explicit_imports($package)
+        catch e
+            printstyled(stderr, "ERROR: "; bold=true, color=:red)
+            Base.showerror(stderr, e)
+            return 1
+        end
+    end
     if should_run_checks
         if length(selected_checks) == 0
             return err("The passed combination of checks $values made the selection empty.")

test/main.jl

@@ -7,6 +7,7 @@ if isdefined(Base, Symbol("@main")) && VERSION >= v"1.12.0-DEV.102"
                        r"\s+" => " ")
         @test contains(help, "SYNOPSIS")
         @test contains(help, "Path to the root directory")
+        @test contains(help, "--test")
         run1 = replace(readchomp(`$cmd --project=$(dir) -m ExplicitImports $dir`),
                        r"\s+" => " ")
         @test contains(run1, "is not relying on any implicit imports.")
@@ -30,6 +31,7 @@ end
                    r"\s+" => " ")
     @test contains(help, "SYNOPSIS")
     @test contains(help, "Path to the root directory")
+    @test contains(help, "--test")
     run1 = replace(readchomp(`$cmd --project=$(dir) -e "using ExplicitImports: main; exit(main([\"$(dir)\"]))"`),
                    r"\s+" => " ")
     @test contains(run1, "is not relying on any implicit imports.")
@@ -45,6 +47,26 @@ end
                    "is not a supported flag, directory, or file. See the output of `--help` for usage details")
 end
 
+@testset "Test --test flag" begin
+    mktempdir() do tmp
+        proj_path = joinpath(tmp, "Project.toml")
+        src_dir = joinpath(tmp, "src")
+        mkpath(src_dir)
+        write(proj_path,
+              "name = \"TmpPkg\"\n" *
+              "uuid = \"00000000-0000-0000-0000-000000000001\"\n" *
+              "version = \"0.1.0\"\n")
+        write(joinpath(src_dir, "TmpPkg.jl"),
+              "module TmpPkg\n\n" *
+              "greet() = \"hello\"\n\n" *
+              "end # module\n")
+        @test ExplicitImports.main([tmp, "--test"]) == 0
+        @test ExplicitImports.main([tmp, "--test", "--print"]) == 0
+        @test ExplicitImports.main([tmp, "--test", "--check"]) == 1
+        @test ExplicitImports.main([tmp, "--test", "--checklist", "all"]) == 1
+    end
+end
+
 @testset "Test checks" begin
     # Expected failure on no_implicit_imports due to DataFramesExt
     dir = joinpath(@__DIR__, "TestPkg")