Purge grimoire

[dpsutton]

@arrdem has deprecated grimoire and is redirecting to clojure docs. So now cider-grimoire yields the following:

I spent a few minutes looking at clojuredocs to see if there's an api and I don't believe there is. We'll need to either swap over to clojuredocs or remove this feature.

I'd hope to see it moved towards Clojure docs. @cursive-ide does this and it is very slick. I really enjoy the in-editor docs and I'll miss the fruits of @arrdem 's work. Thanks so much for the great project and happy endeavors going forward.

[bbatsov]

Seems there's some API as there's an old client for it - https://github.com/dakrone/clojuredocs-client/blob/master/src/cd_client/core.clj Not sure if that works still, but I think it might be a nice idea to create some middleware for dealing with ClojureDocs if we decide to support it. This would also allow us to show examples in docs, etc.

[cursive-ghost]

I don't think there's an API, but there is an archive available at: https://clojuredocs.org/clojuredocs-export.json. I just prompt the user at startup to download that, and then check for its existence when showing the doc. I think the archive is updated daily.

[dpsutton]

Thanks @cursive-ide ! I was wondering how you did it. Your implementation is very slick and convenient.

[dpsutton]

Added a comment to an existing request for an API to see what kind of permissions are given/needed for this data. Seems its about 3mb so maybe could just throw it in an edn file and distribute with orchard or cider-nrepl?

[bbatsov]

@dpsutton I agree. That's what we did for see-also.edn in Orchard - it's just an export from clojuredocs we update from time to time. We just need to add a couple of lein/make tasks to simplify those exports.

[bbatsov]

See also clojure-emacs/orchard#60 which links to how we've extracted see-also.edn from ClojureDocs in the past.

[arrdem]

/me waves sadly

[liquidz]

@bbatsov I'm testing to use clojuredocs-export.json in vim-iced.
https://github.com/liquidz/iced-nrepl/blob/feature/clojuredocs/src/iced/nrepl/document.clj

In my implementation, I try to receive json-path and cache the JSON data because it seems to change frequenty unlike see-also.edn.

I can contribute this codes to orchard or cider-nrepl. What do you think about this implementation?

[bbatsov]

@liquidz The implementation seems reasonable to me, it's just a bit disappointing that there's no EDN export and now we need a third-party dep to parse the JSON. This means that we have to do this in cider-nrepl, not orchard, as ideally Orchard should stay deps free (outside of Clojure/ClojureScript that is).

Anyways, I guess that's good enough for now. Thanks for offering to help out!

[liquidz]

@bbatsov Thanks!
I'm confirming about EDN format exporting to clojuredocs.
If there is no plan to export data as EDN format, I'll create a PR to cider-nrepl repository.

[bbatsov]

Great!

If there is no plan to export data as EDN format, I'll create a PR to cider-nrepl repository.

Btw, I've been thinking that we might make this happen ourselves as well, because all we need is some trivial web service deployed to Heroku (or whatever) that just pull json export daily and converts it to EDN. Still, I hope @zk would be able to help us with some EDN export straight from the source.

[liquidz]

@bbatsov

Btw, I've been thinking that we might make this happen ourselves as well, because all we need is some trivial web service deployed to Heroku (or whatever) that just pull json export daily and converts it to EDN.

How about using Netlify?
I made a simple project as a test to deply converted EDN file to Netlify daily.

• https://clojuredocs-edn.netlify.com/export.edn
• https://github.com/liquidz/clojuredocs-export-edn
  • Deploying EDN file daily via schedule configulation in CircleCI
    • https://github.com/liquidz/clojuredocs-export-edn/blob/master/.circleci/config.yml#L42-L43

[bbatsov]

@liquidz Awesome! That's exactly what I had in mind.

Now you can add the functionality straight to Orchard and cider-nrepl will feature just a think wrapper around it.