Skip to content

Commit

Permalink
First version of a help cli with clj -M/-X
Browse files Browse the repository at this point in the history
  • Loading branch information
@mk
mk committed Oct 12, 2022
1 parent 36a3733 commit 8be0871
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 22 deletions.
9 changes: 3 additions & 6 deletions deps.edn
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,12 @@
rewrite-clj/rewrite-clj {:mvn/version "1.1.45"}}

:aliases {:nextjournal/clerk {:extra-deps {org.slf4j/slf4j-nop {:mvn/version "1.7.36"}
org.babashka/cli {:mvn/version "0.4.37"}}
org.babashka/cli {:mvn/version "0.5.40"}}
:extra-paths ["notebooks"]
:exec-fn nextjournal.clerk/build!
:exec-args {:paths-fn nextjournal.clerk.builder/clerk-docs}
:main-opts ["-m" "babashka.cli.exec"]
:nextjournal.clerk/aliases [:demo]}
:clerk {:extra-deps {org.slf4j/slf4j-nop {:mvn/version "1.7.36"}
org.babashka/cli {:mvn/version "0.4.37"}}
:exec-fn nextjournal.clerk/serve!
:main-opts ["-m" "babashka.cli.exec"]}
:sci {:extra-deps {applied-science/js-interop {:mvn/version "0.3.3"}
org.babashka/sci {:mvn/version "0.4.33"}
reagent/reagent {:mvn/version "1.1.1"}
Expand All @@ -44,7 +40,8 @@
binaryage/devtools {:mvn/version "1.0.3"}
cider/cider-nrepl {:mvn/version "0.28.3"}
thheller/shadow-cljs {:mvn/version "2.16.7"}
org.slf4j/slf4j-nop {:mvn/version "1.7.36"}}
org.slf4j/slf4j-nop {:mvn/version "1.7.36"}
org.babashka/cli {:mvn/version "0.5.40"}}
:extra-paths ["dev" "notebooks"]
:jvm-opts ["-Dclerk.resource_manifest={\"/js/viewer.js\" \"/js/viewer.js\"}" "-Dpolyglot.engine.WarnInterpreterOnly=false" "-XX:-OmitStackTraceInFastThrow"]
:main-opts ["-m" "shadow.cljs.devtools.cli"]
Expand Down
69 changes: 53 additions & 16 deletions src/nextjournal/clerk.clj
View file
Original file line number Diff line number Diff line change
Expand Up @@ -351,6 +351,9 @@
(set/rename-keys opts #_(into {} (map (juxt identity #(keyword (str (name %) "?")))) [:bundle :browse :dashboard])
{:bundle :bundle?, :browse :browse?, :dashboard :dashboard?}))

(defn ^:private started-via-bb-cli? [opts]
(contains? (meta opts) :org.babashka/cli))

(defn serve!
"Main entrypoint to Clerk taking an configurations map.
Expand All @@ -362,20 +365,37 @@
* a `:show-filter-fn` to restrict when to re-evaluate or show a notebook as a result of file system event. Useful for e.g. pinning a notebook. Will be called with the string path of the changed file.
Can be called multiple times and Clerk will happily serve you according to the latest config."
{:org.babashka/cli {:spec {:watch-paths {:desc "Paths on which to watch for changes and show a changed document."
:coerce []}
:port {:desc "Port number for the webserver to listen on, defaults to 7777."
:coerce :number}
:show-filter-fn {:desc "Symbol resolving to a fn to restrict when to show a notebook as a result of file system event."
:coerce :symbol}
:browse {:desc "Opens the browser on boot when set."
:coerge :boolean}}
:order [:watch-paths :port :show-filter-fn :browse]}}
[{:as config
:keys [browse? watch-paths port show-filter-fn]
:or {port 7777}}]
(webserver/serve! {:port port})
(reset! !show-filter-fn show-filter-fn)
(halt-watcher!)
(when (seq watch-paths)
(println "Starting new watcher for paths" (pr-str watch-paths))
(reset! !watcher {:paths watch-paths
:watcher (apply beholder/watch #(file-event %) watch-paths)}))
(when browse?
(browse/browse-url (str "http://localhost:" port)))
(if (:help config)
(if-let [format-opts (and (started-via-bb-cli? config) (requiring-resolve 'babashka.cli/format-opts))]
(println "Start the Clerk webserver with an optional a file watcher.\n\nOptions:"
(str "\n" (format-opts (-> #'serve! meta :org.babashka/cli))))
(println (-> #'serve! meta :doc)))
(do
(webserver/serve! {:port port})
(reset! !show-filter-fn show-filter-fn)
(halt-watcher!)
(when (seq watch-paths)
(println "Starting new watcher for paths" (pr-str watch-paths))
(reset! !watcher {:paths watch-paths
:watcher (apply beholder/watch #(file-event %) watch-paths)}))
(when browse?
(browse/browse-url (str "http://localhost:" port)))))
config)

#_(serve! (with-meta {:help true} {:org.babashka/cli {}}))

(defn halt!
"Stops the Clerk webserver and file watcher."
[]
Expand All @@ -394,7 +414,7 @@
Options:
- `:paths` - a vector of relative paths to notebooks to include in the build
- `:paths-fn` - a symbol resolving 0-arity function returning computed paths
- `:paths-fn` - a symbol resolving to a 0-arity function returning computed paths
- `:index` - a string allowing to override the name of the index file, will be added to `:paths`
Passing at least one of the above is required. When both `:paths`
Expand All @@ -406,13 +426,30 @@
- `:out-path` - a relative path to a folder to contain the static pages (defaults to `\"public/build\"`)
- `:git/sha`, `:git/url` - when both present, each page displays a link to `(str url \"blob\" sha path-to-notebook)`
"
{:org.babashka/cli {:coerce {:paths []
:paths-fn :symbol}}}
{:org.babashka/cli {:spec {:paths {:desc "Paths to notebooks toc include in the build, supports glob patterns."
:coerce []}
:paths-fn {:desc "Symbol resolving to a 0-arity function returning computed paths."
:coerce :symbol}
:index {:desc "Override the name of the index file (default `index.clj|md`), will be added to paths."}
:bundle {:desc "Flag to build a self-contained html file inlcuding inlined images"}
:browse {:desc "Opens the browser on boot when set."}
:dashboard {:desc "Flag to serve a dashboard with the build progress."}
:out-path {:desc "Path to an build output folder, defaults to \"public/build\"."}
:git/sha {:desc "Git sha to use for the backlink."}
:git/url {:desc "Git url to use for the backlink."}}
:order [:paths :paths-fn :index :browse :bundle :dashbaord :out-path :git/sha :git/url]}}
[build-opts]
(let [{:as build-opts-normalized :keys [dashboard?]} (normalize-opts build-opts)]
(when (and dashboard? (not @webserver/!server))
(serve! build-opts-normalized))
(builder/build-static-app! build-opts-normalized)))
(if (:help build-opts)
(if-let [format-opts (and (started-via-bb-cli? build-opts) (requiring-resolve 'babashka.cli/format-opts))]
(println "Start the Clerk webserver with an optional a file watcher.\n\nOptions:"
(str "\n" (format-opts (-> #'build! meta :org.babashka/cli))))
(println (-> #'build! meta :doc)))
(let [{:as build-opts-normalized :keys [dashboard?]} (normalize-opts build-opts)]
(when (and dashboard? (not @webserver/!server))
(serve! build-opts-normalized))
(builder/build-static-app! build-opts-normalized))))

#_(build! (with-meta {:help true} {:org.babashka/cli {}}))

(defn build-static-app! {:deprecated "0.11"} [build-opts]
(binding [*out* *err*] (println "`build-static-app!` has been deprecated, please use `build!` instead."))
Expand Down

0 comments on commit 8be0871

Please sign in to comment.