Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Describe usage in the README #7

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,47 @@ Plug 'clojure-vim/vim-jack-in'
" Only in Neovim:
Plug 'radenling/vim-dispatch-neovim'
----

Provides a couple of helper commands for "jacking" in to a Clojure REPL by
auto-starting it. Highly inspired by CIDER.el's feature by the same name.

== Commands

These run inside the directory vim is currently in. In the future it would be
nice to run relative to the current file.
To run boot & lein, `dispatch-:Start` is used with the bang option.

=== Boot
[source]
----
:Boot [args]
----
Start boot with CIDER-nrepl and Refactor-nrepl automatically injected.
[args] is a list of tasks to run in boot. If not provided,
`g:default_boot_task` is used instead.

=== Clj
[source]
----
:Clj [args]
----
Start clj with CIDER-nrepl and Refactor-nrepl automatically injected.
[args] is a list of options to run in clj. If not provided,
no aditional options will be used.

=== Lein
[source]
----
:Lein [args]
----
Start lein with CIDER-nrepl and Refactor-nrepl automatically injected.
[args] is a list of tasks to run in lein. If not provided,
`:default_lein_task` is used instead.

== Variables

`g:default_boot_task`
Control the default task to start boot with. Defaults to "repl"

`g:default_lein_task`
Control the default task to start lein with. Defaults to "repl"