warnings on unmatched files (#87)

Author: johnnychen94

src/preview.jl

@@ -57,7 +57,7 @@ function preview_demos(demo_path::String;
     copy_assets_and_configs(page_dir, build_dir)
 
     cd(build_dir) do
-        page = DemoPage(page_dir)
+        page = @suppress_err DemoPage(page_dir)
 
         if theme === missing
             theme = page.theme

src/types/card.jl

@@ -1,5 +1,9 @@
 abstract type AbstractDemoCard end
 
+struct UnmatchedCard <: AbstractDemoCard
+    path::String
+end
+
 """
     democard(path::String)::T
 
@@ -8,8 +12,9 @@ Constructs a concrete AbstractDemoCard instance.
 The return type `T` is determined by the extension of the path
 to your demofile. Currently supported types are:
 
-* [`MarkdownDemoCard`](@ref)
-* [`JuliaDemoCard`](@ref)
+* [`MarkdownDemoCard`](@ref) for markdown files
+* [`JuliaDemoCard`](@ref) for julia files
+* [`UnmatchedCard`](@ref) for unmatched files
 
 """
 function democard(path::String)::AbstractDemoCard
@@ -20,7 +25,7 @@ function democard(path::String)::AbstractDemoCard
     elseif ext in julia_exts
         return JuliaDemoCard(path)
     else
-        throw(ArgumentError("unrecognized democard format $(path)"))
+        return UnmatchedCard(path)
     end
 end
 

src/types/section.jl

@@ -94,8 +94,23 @@ function DemoSection(root::String)::DemoSection
     config_file = joinpath(root, config_filename)
     config = isfile(config_file) ? JSON.parsefile(config_file) : Dict()
 
+    # For files that `democard` fails to recognized, dummy
+    # `UnmatchedCard` will be generated. Currently, we only
+    # throw warnings for it.
+    cards = map(democard, card_paths)
+    unmatches = filter(cards) do x
+        x isa UnmatchedCard
+    end
+    if !isempty(unmatches)
+        msg = join(map(basename, unmatches), "\", \"")
+        @warn "skip unmatched file: \"$msg\"" section_dir=root
+    end
+    cards = filter!(cards) do x
+        !(x isa UnmatchedCard)
+    end
+
     section = DemoSection(root,
-                          map(democard, card_paths),
+                          cards,
                           map(DemoSection, section_paths),
                           "",
                           "")

test/assets/section/dirty/card_2.md

@@ -36,4 +36,13 @@
     # invalid cases
     @test_throws ArgumentError @suppress_err DemoSection(joinpath(root, "partial_order"))
     @test_throws ArgumentError @suppress_err DemoSection(joinpath(root, "cards_and_subsections"))
+
+    @testset "unmatched dirty files" begin
+        msg = @capture_err DemoSection(joinpath(root, "dirty"))
+        @test occursin("skip unmatched file: \"data.csv\", \"script.py\"", msg)
+        sec = @suppress_err DemoSection(joinpath(root, "dirty"))
+
+        # unmatched files are excluded during the structure building stage.
+        @test length(sec.cards) == 1
+    end
 end