Add a middleware to find docs from ClojureDocs #628
Conversation
liquidz
force-pushed
the
feature/clojuredocs
branch
3 times, most recently
from
77c98b2
to
ececb7d
Compare
src/cider/nrepl.clj
Outdated
| @@ -478,12 +478,32 @@ | |||
| :returns {"fn-deps" "A list of function deps." | |||
| "status" "done"}}}}) | |||
|
|
|||
| (def-wrapper wrap-clojuredocs cider.nrepl.middleware.clojuredocs/handle-clojuredocs | |||
| {:doc "Middleware to find a documents from ClojureDocs." | |||
| :handles {"load-clojuredocs-cache!" | |||
There was a problem hiding this comment.
I don't think clients will need to call this explicitly, probably they'll just need the ability to reload the cache.
There was a problem hiding this comment.
Apart from refreshing cache, I thought it could be used for cache loading in the background (e.g. when connecting nREPL).
But once the cache file is generated, loading of the cache is fast enough, so it seems that just refreshing is good.
src/cider/nrepl.clj
Outdated
| :requires {} | ||
| :optional {"export-edn-url" "EDN file URL exported from ClojureDocs. Defaults to \"https://clojuredocs-edn.netlify.com/export.edn\"."} | ||
| :returns {"status" "\"ok\" if loading was successful"}} | ||
| "clean-clojuredocs-cache!" |
There was a problem hiding this comment.
Same with this one - probably we can expose a single "clojuredocs-refresh-cache" op instead of two.
src/cider/nrepl.clj
Outdated
| {:doc "Clean a cached file and documents" | ||
| :requires {} | ||
| :returns {"status" "\"ok\" if cleaning was successful"}} | ||
| "clojuredocs" |
There was a problem hiding this comment.
I think clojuredocs-lookup is a more informative name for this one.
Makefile
Outdated
| .inline-deps: | ||
| lein inline-deps | ||
| touch .inline-deps | ||
|
|
||
| inline-deps: .inline-deps | ||
|
|
||
| test: .inline-deps | ||
| test: .inline-deps test/resources/clojuredocs/export.edn |
There was a problem hiding this comment.
It's best to put resources under the cider/nrepl package for consistency with the existing resources.
liquidz
force-pushed
the
feature/clojuredocs
branch
from
ececb7d
to
2cdc44b
Compare
|
@bbatsov Thank you for your reviewing! |
|
Excellent! I'll cut a new beta now. |
Introduce a middleware to find docs from not Grimoire but ClojureDocs.
See also clojure-emacs/cider#2663 and clojure-emacs/orchard#64