Trimming

API.md

@@ -1,313 +0,0 @@
-format: using built-in markdown
-format: using built-in markdown
-format: discount not found, using markdown
-# acid.connections
-low-level connection handler
-
-## `acid.connections.add(addr)`
-Stores connection for reuse later
-
-addr **({string,string})**: Address tuple with ip and port.
-
-
-## `acid.connections.select(pwd, ix)`
-Elects selected connection as primary (thus default) for a certain address
-
-pwd **(string)**: path (usually project root).
- Assumed to be neovim's `pwd`.
-
-ix **(int)**: index of the stored connection
-
-
-## `acid.connections.unselect(pwd)`
-Dissociates the connection for the given path
-
-pwd **(string)**: path (usually project root).
-
-
-## `acid.connections.peek([pwd])`
-Return active connection for the given path
-
-*pwd* **(string)**: path (usually project root).
-
-
-**(string)** Id of the current connection for the path or nil.
-
-
-## `acid.connections.get(pwd)`
-Return active connection for the given path
-
-pwd **(string)**: path (usually project root).
-
-
-**({string,string})** Connection tuple with ip and port or nil.
-
-
-## `acid.connections.set(pwd, addr)`
-Add and select the given connection for given path.
-
-pwd **(string)**: path (usually project root).
-
-addr **({string,string})**: tuple with ip and port or nil.
-
-
----
-
-# acid.core
-low-level connection handler.
-
-## `acid.core.send([conn], obj, handler)`
-Forward messages to the nrepl and registers the handler.
-
-*conn* **({string,string})**: Ip and Port tuple. Will try to get one if nil.
-
-obj **(table)**: Payload to be sent to the nrepl.
-
-handler **(function)**: Handler function to deal with the response.
-
-
----
-
-# extra.ulid
-generates the time-based part of a `ulid`.
-
----
-
-# acid.features
-User-facing features and runnable commands
-
-## `acid.features.eval_cmdline(code[, ns])`
-Evaluate the given code and insert the result at the cursor position
-
-code **(string)**: Clojure s-expression to be evaluated on the nrepl
-
-*ns* **(string)**: Namespace to be used when evaluating the code.
- Defaults to current file's ns.
-
-
-## `acid.features.eval_print(code[, ns])`
-Evaluate the given code and print the result.
-
-code **(string)**: Clojure s-expression to be evaluated on the nrepl
-
-*ns* **(string)**: Namespace to be used when evaluating the code.
- Defaults to current file's ns.
-
-
-
-## `acid.features.eval_expr([mode[, replace[, ns]]])`
-Evaluate the current form or the given motion.
-
-*mode* **(string)**: motion mode
-
-*replace* **(boolean)**: whether it should replace the form with its result
-
-*ns* **(string)**: Namespace to be used when evaluating the code.
- Defaults to current file's ns.
-
-
-## `acid.features.do_require([ns[, ...]])`
-Sends a `(require '[...])` function to the nrepl.
-
-*ns* **(string)**: Namespace to be used when evaluating the code.
- Defaults to current file's ns.
-
-*...*: extra arguments to the require function
-
-
-## `acid.features.do_import(java_ns, symbols)`
-Sends a `(import '[...])` function to the nrepl.
-
-java_ns **(string)**: Namespace of the java symbols that are being imported.
-
-symbols **({string,...})**: List of java symbols to be imported
-
-
-## `acid.features.go_to([symbol[, ns]])`
-Navigates the definition of the given symbol.
-
-*symbol* **(string)**: Symbol to navigate to. Defaults to symbol under
- cursor.
-
-*ns* **(string)**: Namespace to be used when evaluating the code.
- Defaults to current file's ns.
-
-
-## `acid.features.docs([symbol[, ns]])`
-Shows the docstring of the given symbol.
-
-*symbol* **(string)**: Symbol which docs will be shown. Defaults to symbol under cursor.
-
-*ns* **(string)**: Namespace to be used when evaluating the code.
- Defaults to current file's ns.
-
-
-## `acid.features.preload()`
-Inject some clojure files into the nrepl session.
-
-
-## `acid.features.load_all_nss()`
-Load all namespaces in the current session.
-
-
-## `acid.features.add_require(req)`
-Refactor the current file to include the given argument in the
-`(:requires ...)` section.
-
-req **(string)**: require vector, such as `[clojure.string :as str]`.
-
-
-## `acid.features.remove_require(req)`
-Refactor the current file to remove the given argument from the
-`(:requires ...)` section.
-
-req **(string)**: require namespace, such as `clojure.string`.
-
-
-## `acid.features.sort_requires()`
-Refactor the current file so the `(:require ...)` form is sorted.
-
-
-## `acid.features.clean_ns()`
-Refactor the current file so the `(:require ...)` form is sorted.
-
-
----
-
-# acid.forms
-Forms extraction
-
-## `acid.forms.get_form_boundaries([top])`
-Returns the coordinates for the boundaries of the current form
-
-*top* **(boolean)**: if true, recursively searches for top level.
-
-
-**(table)** coordinates {from = {row,col}, to = {row,col}}
-
-
-## `acid.forms.form_from_motion(mode[, bufnr])`
-Extracts the form according to given motion (or visual mode)
-
-mode **(string)**: Motion mode or 'visual'
-
-*bufnr* **(int)**: Buffer number in neovim. Will take current if none given
-
-
-**(string)** symbol under cursor
-
-**(table)** coordinates {from = {row,col}, to = {row,col}, bufnr = 1}
-
-
-## `acid.forms.form_under_cursor([top])`
-Extracts the innermost form under the cursor
-
-*top* **(boolean)**: if true, recursively searches for top level.
-
-
-**(string)** symbol under cursor
-
-**(table)** coordinates {from = {row,col}, to = {row,col}, bufnr = 1}
-
-
-## `acid.forms.symbol_under_cursor()`
-Extracts the symbol under the cursor
-
-
-**(string)** symbol under cursor
-
-**(table)** coordinates {from = {row,col}, to = {row,col}, bofnr = 1}
-
-
----
-
-# acid
-Frontend module with most relevant functions
-
-## `acid.connected([pwd])`
-Checks whether a connection exists for supplied path or not.
-
-*pwd* **(string)**: Path bound to connection.
- Will call `getcwd` on neovim if not supplied
-
-
-**(boolean)** Whether a connection exists or not.
-
-
-## `acid.run(cmd, conn)`
-Façade to core.send
-
-cmd: A command (op + payload + handler) to be executed.
-
-conn: A connection where this command will be run.
-
-
-## `acid.callback(ret)`
-Callback proxy for handling command responses
-
-ret: The response from nrepl
-
-
-## `acid.admin_session_start()`
-Setup admin nrepl session
- This nrepl session should be used by plugins to deal with clojure code
- without injecting things in the user nrepl session
- or for things that clojure could deal with better while not having a 
- nrepl session to use.
-
-
----
-
-# acid.nrepl
-nRepl connectivity
-
-## `middlewares`
-List of supported middlewares and the wrappers to invoke when spawning a nrepl process.
-
-Values:
-
-* `[nrepl/nrepl]`
-
-## `default_middlewares`
-Default middlewares that will be used by the nrepl server
-
-Values:
-
-* `nrepl/nrepl`
-* `cider/cider-nrepl`
-* `refactor-nrepl`
-
-## `acid.nrepl.start(obj)`
-Starts a tools.deps nrepl server
-
-obj **(table)**: Configuration for the nrepl process to be spawn
-
-Parameters for table `obj` are:
-
-* *obj.pwd* **(string)**: Path where the nrepl process will be started
-* *obj.middlewares* **(table)**: List of middlewares.
-* *obj.alias* **(string)**: aliases on the local deps.edn
-* *obj.connect* **(string)**: -c parameter for the nrepl process
-* *obj.bind* **(string)**: -b parameter for the nrepl process
-* *obj.skip_autocmd* **(boolean)**: don't fire an autocmd after starting this repl
-
-**(boolean)** Whether it was possible to spawn a nrepl process
-
-
-## `acid.nrepl.stop(obj)`
-Stops a nrepl process managed by acid
-
-obj **(table)**: Configuration for the nrepl process to be stopped
-
-Parameters for table `obj` are:
-
-* obj.pwd **(string)**: Path where the nrepl process was started
-
-## `acid.nrepl.show([ch])`
-Debugs nrepl connection by returning the captured output
-
-*ch* **(int)**: Neovim's job id of given nrepl process. When not supplied return all.
-
-
-**(table)** table with the captured outputs for given (or all) nrepl process(es).
-

bin/pctl

@@ -0,0 +1,48 @@
+#!/bin/bash
+set -eou pipefail
+
+BIN_DIR="$(dirname "$(realpath "$0")")"
+ROOT_DIR="$(dirname "$BIN_DIR")"
+
+LUAROCKS="luarocks-5.1"
+
+exists() {
+  command -v "$1" > /dev/null
+}
+
+setup(){
+  exists luarocks-5.1 || {
+    exists luarocks && {
+      LUAROCKS="luarocks --lua-version 5.1"
+    } || {
+      echo 'Please install luarocks'
+      exit 1
+    }
+  }
+
+  $LUAROCKS install "$1"
+}
+
+tests(){
+  exists busted || setup busted
+  busted
+}
+
+linter(){
+  exists luacheck || setup luacheck
+  luacheck lua/
+}
+
+run() {
+  tests
+  linter
+}
+
+
+run-dev(){
+inotifywait -r -q -m -e close_write --format %e lua spec | while read -r ; do
+busted
+done
+}
+
+cd $ROOT_DIR && "$@"