Very cool stuff, Lee! And my sincere thanks for all the work you are doing to
make ClojureDocs.org even more useful than it is already.
I tried out clojuredocs on a project that depended on Clojure 1.3.0. When I
first tried "lein2 clojuredocs", I got an exception like this:
Exception in thread "main" java.lang.RuntimeException: Unable to resolve
symbol: mapv in this context, compiling:(cadastre/analyzer.clj:58)
Looks like cadastre uses mapv, and so depends on Clojure 1.4.0 or later.
Then I tried adding the following line to my project.clj:
:eval-in :leiningen
and repeated "lein2 clojuredocs", and it all appeared to work. I don't know
what I'm doing here, just hacking based upon the documentation for creating a
project.clj file for code that doesn't have one already (like Clojure's contrib
libs, which have only a pom.xml file).
If that :eval-in line looks like a good thing to recommend for everyone using
this, it would be good to add it to the README.md, right near the first mention
of the "lein2 clojuredocs" command. It might even be a good idea to show the
exception above with a note like "If you see this exception, remember to add
the :eval-in line to project.clj.
Does anyone know if there would be undesirable side effects to someone adding
that :eval-in to their project.clj long term, even if the initial reason they
added it was to run 'lein2 clojurecocs'? If there are, it would be good to
mention that the line should be removed after running clojuredocs.
Thanks,
Andy
On Nov 16, 2012, at 7:58 AM, Lee Hinman wrote:
> -----BEGIN PGP SIGNED MESSAGE-----
> Hash: SHA1
>
> Hi all,
> I'm pleased to announce three different projects, all related to the
> rewrite of ClojureDocs.
>
> - ---
> First, the lein-clojuredocs[1] leiningen plugin, which goes through
> your project's source code and produces a gzipped json file containing
> all the metadata about your project. This gzipped json file is
> intended to be uploaded to the new ClojureDocs in the future, see the
> github page[1] for usage, or add this to your ~/.lein/profiles.clj:
>
> {:user {:plugins [[lein-clojuredocs "1.0.2"]}}
>
>
> - ---
> Second, the cadastre[2] library, which is the actual metadata
> extraction library that lein-clojuredocs uses, provided as a separate
> library for any other personal use. It also provides a mechanism for
> extracting metadata from the Clojure project itself. It can be used
> from Clojars by specifying (in your project.clj):
>
> [cadastre "0.1.1"]
>
>
> - ---
> Finally, I'd also like to formally announce Eisago[3], which is the
> beginnings of an import mechanism, storage layer and API intended to
> replace ClojureDocs once completely finished. It includes the `lein
> eisago` plugin to import files generated by lein-clojuredocs into the
> database, a laeggen-based API, a migration tool to import existing
> clojuredocs examples, and a library to integrate with ElasticSearch
> (which is used as a database and search engine). If you are at all
> interested in ClojureDocs, I encourage you to check it out and try
> running it yourself, and provide feedback to make the project better.
> It is my intention to replace the http://clojuredocs.org site once the
> website portion has been completed.
>
> Eisago is not provided as a clojars artifact (since it's not a
> library), please clone the git repo to run it and provide feedback.
>
>
> - ---
> It is my hope with these 3 projects, the rewrite of ClojureDocs can
> proceed with more community interaction and better feedback. Please
> try all the projects with your libraries and projects and feel free to
> open github issues or send me an email with any issues you find.
>
>
> thanks,
> Lee Hinman
> @thnetos
--
You received this message because you are subscribed to the Google
Groups "Clojure" group.
To post to this group, send email to [email protected]
Note that posts from new members are moderated - please be patient with your
first post.
To unsubscribe from this group, send email to
[email protected]
For more options, visit this group at
http://groups.google.com/group/clojure?hl=en
