Support skip_files to ignore specific files. (#142)

Author: fredrikekre

Project.toml

@@ -1,7 +1,7 @@
 name = "LiveServer"
 uuid = "16fef848-5104-11e9-1b77-fb7a48bbb589"
 authors = ["Jonas Asprion <jonas.asprion@gmx.ch", "Thibaut Lienart <tlienart@me.com>"]
-version = "0.9.0"
+version = "0.9.1"
 
 [deps]
 Crayons = "a8cc5b0e-0ffa-5ad4-8c14-923d3ee1735f"

src/server.jl

@@ -112,7 +112,7 @@ Append `/` to the path part of `url`; i.e., transform `a/b` to `a/b/` and `/a/b?
 """
 function append_slash(url_str::AbstractString)
     uri = HTTP.URI(url_str)
-    return string(endswith(uri.path, "/") ? uri : merge(uri; path = uri.path * "/"))
+    return string(endswith(uri.path, "/") ? uri : HTTP.URI(uri; path = uri.path * "/"))
 end
 
 """

src/utils.jl

@@ -22,14 +22,18 @@ function servedocs_callback!(
             path2makejl::AbstractString,
             literate::Union{Nothing,String},
             skip_dirs::Vector{String},
+            skip_files::Vector{String},
             foldername::String,
             buildfoldername::String)
     # ignore things happening in the build folder (generated files etc)
     startswith(fp, joinpath(foldername, buildfoldername)) && return nothing
-    # ignore things happening in any skip_dirs
+    # ignore files skip_dirs and skip_files
     for dir in skip_dirs
         startswith(fp, dir) && return nothing
     end
+    for file in skip_files
+        fp == file && return nothing
+    end
 
     # if the file that was changed is the `make.jl` file, assume that maybe
     # new files have been generated and so refresh the vector of watched files
@@ -167,6 +171,7 @@ subfolder `docs`.
                  `skip_dir=joinpath("docs","src","examples")`.
 * `skip_dirs=[]`: same as `skip_dir` but for a list of such dirs. Takes
                   precedence over `skip_dir`.
+* `skip_files=[]`: a vector of files that should not trigger regeneration.
 * `foldername="docs"`: specify a different path for the content.
 * `buildfoldername="build"`: specify a different path for the build.
 * `makejl="make.jl"`: path of the script generating the documentation relative
@@ -182,6 +187,7 @@ function servedocs(;
             doc_env::Bool=false,
             skip_dir::String="",
             skip_dirs::Vector{String}=String[],
+            skip_files::Vector{String}=String[],
             foldername::String="docs",
             buildfoldername::String="build",
             makejl::String="make.jl",
@@ -193,6 +199,8 @@ function servedocs(;
     if isempty(skip_dirs) && !isempty(skip_dir)
         skip_dirs = [skip_dir]
     end
+    skip_dirs = abspath.(skip_dirs)
+    skip_files = abspath.(skip_files)
 
     path2makejl = joinpath(foldername, makejl)
 
@@ -203,7 +211,7 @@ function servedocs(;
         docwatcher,
         fp -> servedocs_callback!(
                 docwatcher, fp, path2makejl,
-                literate, skip_dirs, foldername, buildfoldername
+                literate, skip_dirs, skip_files, foldername, buildfoldername
         )
     )
 

test/utils.jl

@@ -23,7 +23,7 @@
     include(abspath(makejl))
     @test readmake() == 1
 
-    def = (nothing, String[], "docs", "build")
+    def = (nothing, String[], String[], "docs", "build")
 
     # callback function
     dw = LS.SimpleWatcher()
@@ -107,7 +107,7 @@ end
     # callback function
     dw = LS.SimpleWatcher()
 
-    LS.servedocs_callback!(dw, makejl, makejl, "", String[], "site", "build")
+    LS.servedocs_callback!(dw, makejl, makejl, "", String[], String[], "site", "build")
 
     @test length(dw.watchedfiles) == 3
     @test dw.watchedfiles[1].path == joinpath("site", "make.jl")
@@ -118,14 +118,14 @@ end
 
     # let's now remove `index2.md`
     rm(joinpath("site", "src", "index2.md"))
-    LS.servedocs_callback!(dw, makejl, makejl, "", String[], "site", "build")
+    LS.servedocs_callback!(dw, makejl, makejl, "", String[], String[], "site", "build")
 
     # the file has been removed
     @test length(dw.watchedfiles) == 2
     @test readmake() == 3
 
     # let's check there's an appropriate trigger for index
-    LS.servedocs_callback!(dw, joinpath("site", "src", "index.md"), makejl, "", String[], "site", "build")
+    LS.servedocs_callback!(dw, joinpath("site", "src", "index.md"), makejl, "", String[], String[], "site", "build")
     @test length(dw.watchedfiles) == 2
     @test readmake() == 4