[Fix #495] Add some ClojureScript usage documentation. #911
Conversation
|
Seems like a good start, but I do think that some run instructions (at least for weasel) might be useful. Some users will likely be intimidated by the complete documentation of austin/weasel and would simply like to know how to get start a cljs repl with cider. I do wonder if it doesn't make sense to automate the boilerplate commands by wrapping them in interactive Emacs commands. |
|
Seems that @symfrog has created something similar already https://github.com/symfrog/clojure-quick-repls |
cichli
force-pushed
the
clojurescript-documentation
branch
from
f5e62d9
to
ca21a44
Compare
|
Agreed, especially with respect to the Austin documentation. I've added basic examples for starting both Austin and Weasel REPLs. Btw, seems like the Caveats section isn't the best place for this stuff - maybe a new section for ClojureScript between the Middleware and Configuration sections would be useful? |
|
One difficulty with providing a command for starting a cljs repl is that there are several different REPLs (each requiring a dependency in the user's project) and several different evaluation environments (browser via HTTP, browser via websockets, Rhino, node.js, etc. etc.) and I don't know if it's useful to prescribe any particular one. A lot of projects already define a |
cichli
force-pushed
the
clojurescript-documentation
branch
from
ca21a44
to
a0c1108
Compare
Agreed. Guess you can leave in the caveats just the portion about the unsupported functionality.
Sounds reasonable. Given my lack of cljs xp I'll defer to your judgement regarding this. |
cichli
force-pushed
the
clojurescript-documentation
branch
3 times, most recently
from
9ebe13d
to
150db32
Compare
|
Okay, updated now. Moved all but the actual caveats to a new section and fixed up some indentation and formatting. |
|
Btw do you auto-generate the table of contents? Happy to submit a PR to fix it up since it's a bit out of date but I'm not sure if it's maintained manually or not. |
|
Initially I generated it with some node.js tool which I don't even On Tuesday, December 9, 2014, Michael Griffiths notifications@github.com
Best Regards, |
|
@cichli Just a note that clojure-quick-repls does provide a customizable variable that can be defined by the user to customize the cljs repl that is launched. Another major benefit of clojure-quick-repls is that it will automatically route forms over the correct repl connection depending on if you are in a clj or cljs buffer. |
| @@ -44,6 +44,7 @@ CIDER packs plenty of features. Here are some of them (in no particular order): | |||
| - [Installation](#installation) | |||
| - [Prerequisites](#prerequisites) | |||
| - [Installation via package.el](#installation-via-packageel) | |||
| - [ClojureScript](#clojurescript) | |||
There was a problem hiding this comment.
Btw, it seems to me this would fit best under Basic Usage.
|
@cichli Should I merge this as is or are you going to do the TOC changes you mentioned first? |
cichli
force-pushed
the
clojurescript-documentation
branch
from
150db32
to
eb330d7
Compare
|
Sorry for falling behind on this! I've moved it to Basic Usage and added a note about clojure-quick-repls (probably discussion for another issue but is it worth merging any of those features into CIDER proper?). I've also cleaned up the TOC. |
[Fix #495] Add some ClojureScript usage documentation.
|
👍
Yes, we should probably have something similar in CIDER itself. |
This doesn't go into too much detail of how to set up a CLJS environment, since this is covered well by the documentation for Austin/Weasel themselves. I think one other useful addition would be minimal known-to-work versions of CLJS/Piggieback/Austin/Weasel, but this is complicated slightly by the fact that different versions of Austin and Weasel have different minimum CLJS versions (CLJS releases do not use SemVer and move pretty fast). Thoughts?