generated from a verbose 'describe' response (cider-nrepl v0.0.0)
analyze-last-stacktrace
Return messages describing each cause and stack frame of the most recent exception.
:nrepl.middleware.print/buffer-size
The size of the buffer to use when streaming results. Defaults to 1024.
:nrepl.middleware.print/keys
A seq of the keys in the response whose values should be printed.
:nrepl.middleware.print/options
A map of options to pass to the printing function. Defaults to nil
.
:nrepl.middleware.print/print
A fully-qualified symbol naming a var whose function to use for printing. Must point to a function with signature [value writer options].
:nrepl.middleware.print/quota
A hard limit on the number of bytes printed for each value.
:nrepl.middleware.print/stream?
If logical true, the result of printing each value will be streamed to the client over one or more messages.
:status
"done", or "no-error" if *e
is nil
analyze-stacktrace
Parse and analyze the :stacktrace
parameter and return messages describing each cause and stack frame. The
stacktrace must be a string formatted in one of the following formats:
:aviso
Stacktraces printed with the
write-exception
function of the Aviso library.
:clojure.tagged-literal
Stacktraces printed as a tagged literal, like a
java.lang.Throwable
printed with the
pr
function.
:clojure.stacktrace
Stacktraces printed with the
print-cause-trace
function of the
clojure.stacktrace
namespace.
:clojure.repl
Stacktraces printed with the
pst
function of the
clojure.repl
namespace.
:java
Stacktraces printed with the
printStackTrace
method of
java.lang.Throwable.
:stacktrace
The stacktrace to be parsed and analyzed as a string.
:nrepl.middleware.print/buffer-size
The size of the buffer to use when streaming results. Defaults to 1024.
:nrepl.middleware.print/keys
A seq of the keys in the response whose values should be printed.
:nrepl.middleware.print/options
A map of options to pass to the printing function. Defaults to nil
.
:nrepl.middleware.print/print
A fully-qualified symbol naming a var whose function to use for printing. Must point to a function with signature [value writer options].
:nrepl.middleware.print/quota
A hard limit on the number of bytes printed for each value.
:nrepl.middleware.print/stream?
If logical true, the result of printing each value will be streamed to the client over one or more messages.
:status
"done", or "no-error" if stracktrace
is not recognized
apropos
Return a sequence of vars whose name matches the query pattern, or if specified, having the pattern in their docstring.
:query
The search query.
:filter-regexps
All vars from namespaces matching any regexp from this list would be dropped from the result.
:apropos-matches
A list of matching symbols.
cider-version
Returns the version of the CIDER-nREPL middleware.
:cider-version
CIDER-nREPL’s version map.
:status
done
classpath
Obtain a list of entries in the Java classpath.
:classpath
A list of the Java classpath entries.
clear-profile
Clears profile of samples.
:status
Done
clojuredocs-lookup
Return a map of information in ClojureDocs.
:ns
The namespace where sym
will be resolved.
:sym
The symbol to lookup.
:clojuredocs
A map of information in ClojureDocs.
:status
"no-doc" if there is no document matching to ns
and symbol
.
clojuredocs-refresh-cache
Reload exported documents file from ClojureDocs, and store it as a cache.
:export-edn-url
EDN file URL exported from ClojureDocs. Defaults to "https://github.com/clojure-emacs/clojuredocs-export-edn/raw/master/exports/export.compact.edn".
:status
"ok" if reloading was successful
complete
Return a list of symbols matching the specified (partial) symbol.
:ns
The namespace is which to look for completions (falls back to *ns* if not specified)
:prefix
The prefix for completion candidates
:session
The current session
:context
Completion context for compliment.
:extra-metadata
List of extra-metadata fields. Possible values: arglists, doc.
:completions
A list of possible completions
complete-doc
Retrieve documentation suitable for display in completion popup
:ns
The symbol’s namespace
:sym
The symbol to lookup
:completion-doc
Symbol’s documentation
complete-flush-caches
Forces the completion backend to repopulate all its caches
content-type
Enhances the eval
op by adding content-type
and body
to certain eval
responses. Not an op in itself.
Depending on the type of the return value of the evaluation this middleware may kick in and include a representation of the result in the response, together with a MIME/Media type to indicate how it should be handled by the client. Comes with implementations for URI
, URL
, File
, and java.awt.Image
. More type handlers can be provided by the user by extending the cider.nrepl.middleware.content-type/content-type-response
multimethod. This dispatches using clojure.core/type
, so :type
metadata on plain Clojure values can be used to provide custom handling.
:content-type
If present and non-nil, try to detect and handle content-types.
:body
The rich response document, if applicable.
:content-transfer-encoding
The encoding of the response body (Optional, currently only one possible value: "base64"
).
:content-type
The Media type (MIME type) of the reponse, structured as a pair, [type {:as attrs}]
.
debug-input
Read client input on debug action.
:input
The user’s reply to the input request.
:key
The corresponding input request key.
:status
done
debug-instrumented-defs
Return an alist of definitions currently thought to be instrumented on each namespace. Due to Clojure’s versatility, this could include false positives, but there will not be false negatives. Instrumentations inside protocols are not listed.
:list
The alist of (NAMESPACE . VARS) that are thought to be instrumented.
:status
done
debug-middleware
Debug a code form or fall back on regular eval.
:code
Code to debug, there must be a #dbg or a #break reader macro in it, or nothing will happen.
:file
File where the code is located.
:id
A message id that will be responded to when a breakpoint is reached.
:ns
Passed to "eval".
:point
Position in the file where the provided code begins.
:status
"done" if the message will no longer be used, or "need-debug-input" during debugging sessions
eldoc
Return a map of information about the specified symbol.
:class
A Java class. If :ns
is passed, it will be used for fully-qualifying the class, if necessary.
:context
A Compliment completion context, just like the ones already passed for the "complete" op,
with the difference that the symbol at point should be entirely replaced by "_prefix_".
For Java interop queries, it helps inferring the precise type of the object the :sym
or :member
refers to,
making the results more accurate (and less numerous).
:member
A Java class member.
:ns
The current namespace
:sym
The symbol to lookup
:var-meta-allowlist
The metadata keys from vars to be returned. Currently only affects :clj
.
Defaults to the value of orchard.meta/var-meta-allowlist
.
If specified, the value will be concatenated to that of orchard.meta/var-meta-allowlist
.
:doc-block-tags-fragments
May be absent. Represent the 'param', 'returns' and 'throws' sections a Java doc comment. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:doc-first-sentence-fragments
May be absent. Represents the first sentence of a Java doc comment. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:doc-fragments
May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:status
done
eldoc-datomic-query
Return a map containing the inputs of the datomic query.
:ns
The current namespace
:sym
The symbol to lookup
:status
done
fn-deps
Look up the function dependencies of particular function.
:ns
The current namespace
:sym
The symbol to lookup
:fn-deps
A list of function deps, with a :name :doc :file :file-url :line :column
structure.
:status
done
fn-refs
Look up functions that reference a particular function.
:ns
The current namespace
:sym
The symbol to lookup
:fn-refs
A list of function references, with a :name :doc :file :file-url :line :column
structure.
:status
done
format-code
Reformats the given Clojure code, returning the result as a string.
:code
The code to format.
:options
Configuration map for cljfmt.
:formatted-code
The formatted code.
format-edn
Reformats the given EDN data, returning the result as a string.
:edn
The data to format.
:nrepl.middleware.print/buffer-size
The size of the buffer to use when streaming results. Defaults to 1024.
:nrepl.middleware.print/keys
A seq of the keys in the response whose values should be printed.
:nrepl.middleware.print/options
A map of options to pass to the printing function. Defaults to nil
.
:nrepl.middleware.print/print
A fully-qualified symbol naming a var whose function to use for printing. Must point to a function with signature [value writer options].
:nrepl.middleware.print/quota
A hard limit on the number of bytes printed for each value.
:nrepl.middleware.print/stream?
If logical true, the result of printing each value will be streamed to the client over one or more messages.
:formatted-edn
The formatted data.
get-max-samples
Returns maximum number of samples to be collected for any var.
:status
Done
:value
String representing number of max-sample-count
info
Return a map of information about the specified symbol.
:class
A Java class. If :ns
is passed, it will be used for fully-qualifying the class, if necessary.
:context
A Compliment completion context, just like the ones already passed for the "complete" op,
with the difference that the symbol at point should be entirely replaced by "_prefix_".
For Java interop queries, it helps inferring the precise type of the object the :sym
or :member
refers to,
making the results more accurate (and less numerous).
:member
A Java class member.
:ns
The current namespace
:sym
The symbol to lookup
:var-meta-allowlist
The metadata keys from vars to be returned. Currently only affects :clj
.
Defaults to the value of orchard.meta/var-meta-allowlist
.
If specified, the value will be concatenated to that of orchard.meta/var-meta-allowlist
.
:doc-block-tags-fragments
May be absent. Represent the 'param', 'returns' and 'throws' sections a Java doc comment. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:doc-first-sentence-fragments
May be absent. Represents the first sentence of a Java doc comment. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:doc-fragments
May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:status
done
init-debugger
Initialize the debugger so that breakpoint
works correctly. This usually does not respond immediately. It sends a response when a breakpoint is reached or when the message is discarded.
:id
A message id that will be responded to when a breakpoint is reached.
inspect-clear
Clears the state state of the inspector.
:session
The current session
:doc-block-tags-fragments
May be absent. Represent the 'param', 'returns' and 'throws' sections a Java doc comment. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:doc-first-sentence-fragments
May be absent. Represents the first sentence of a Java doc comment. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:doc-fragments
May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:path
Printed representation of current inspector path.
:status
"done"
:value
The inspector result. Contains a specially-formatted string that can be read
and then rendered client-side.
inspect-def-current-value
Define the currently inspected value as a var with the given var-name in the provided namespace.
:ns
Namespace to define var on
:session
The current session
:var-name
The var name
:doc-block-tags-fragments
May be absent. Represent the 'param', 'returns' and 'throws' sections a Java doc comment. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:doc-first-sentence-fragments
May be absent. Represents the first sentence of a Java doc comment. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:doc-fragments
May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:path
Printed representation of current inspector path.
:status
"done"
:value
The inspector result. Contains a specially-formatted string that can be read
and then rendered client-side.
inspect-last-exception
Returns an Inspector response for the last exception that has been processed through analyze-last-stacktrace
for the current nrepl session.
Assumes that analyze-last-stacktrace
has been called first, returning "no-error" otherwise.
:index
0 for inspecting the top-level exception, 1 for its ex-cause, 2 for its ex-cause’s ex-cause, and so on.
:status
"done", or "no-error" if analyze-last-stacktrace
wasn’t called beforehand (or the index
was out of bounds).
:value
A value, as produced by the Inspector middleware.
inspect-next-page
Jumps to the next page in paginated collection view.
:session
The current session
:doc-block-tags-fragments
May be absent. Represent the 'param', 'returns' and 'throws' sections a Java doc comment. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:doc-first-sentence-fragments
May be absent. Represents the first sentence of a Java doc comment. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:doc-fragments
May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:path
Printed representation of current inspector path.
:status
"done"
:value
The inspector result. Contains a specially-formatted string that can be read
and then rendered client-side.
inspect-next-sibling
Increment the index of the last 'nth in the path by 1, if applicable, and re-render the updated value.
:session
The current session
:doc-block-tags-fragments
May be absent. Represent the 'param', 'returns' and 'throws' sections a Java doc comment. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:doc-first-sentence-fragments
May be absent. Represents the first sentence of a Java doc comment. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:doc-fragments
May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:path
Printed representation of current inspector path.
:status
"done"
:value
The inspector result. Contains a specially-formatted string that can be read
and then rendered client-side.
inspect-pop
Moves one level up in the inspector stack.
:session
The current session
:doc-block-tags-fragments
May be absent. Represent the 'param', 'returns' and 'throws' sections a Java doc comment. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:doc-first-sentence-fragments
May be absent. Represents the first sentence of a Java doc comment. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:doc-fragments
May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:path
Printed representation of current inspector path.
:status
"done"
:value
The inspector result. Contains a specially-formatted string that can be read
and then rendered client-side.
inspect-prev-page
Jumps to the previous page in paginated collection view.
:session
The current session
:doc-block-tags-fragments
May be absent. Represent the 'param', 'returns' and 'throws' sections a Java doc comment. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:doc-first-sentence-fragments
May be absent. Represents the first sentence of a Java doc comment. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:doc-fragments
May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:path
Printed representation of current inspector path.
:status
"done"
:value
The inspector result. Contains a specially-formatted string that can be read
and then rendered client-side.
inspect-previous-sibling
Decrement the index of the last 'nth in the path by 1, if applicable, and re-render the updated value.
:session
The current session
:doc-block-tags-fragments
May be absent. Represent the 'param', 'returns' and 'throws' sections a Java doc comment. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:doc-first-sentence-fragments
May be absent. Represents the first sentence of a Java doc comment. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:doc-fragments
May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:path
Printed representation of current inspector path.
:status
"done"
:value
The inspector result. Contains a specially-formatted string that can be read
and then rendered client-side.
inspect-push
Inspects the inside value specified by index.
:idx
Index of the internal value currently rendered.
:session
The current session
:doc-block-tags-fragments
May be absent. Represent the 'param', 'returns' and 'throws' sections a Java doc comment. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:doc-first-sentence-fragments
May be absent. Represents the first sentence of a Java doc comment. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:doc-fragments
May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:path
Printed representation of current inspector path.
:status
"done"
:value
The inspector result. Contains a specially-formatted string that can be read
and then rendered client-side.
inspect-refresh
Re-renders the currently inspected value.
:session
The current session
:doc-block-tags-fragments
May be absent. Represent the 'param', 'returns' and 'throws' sections a Java doc comment. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:doc-first-sentence-fragments
May be absent. Represents the first sentence of a Java doc comment. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:doc-fragments
May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:path
Printed representation of current inspector path.
:status
"done"
:value
The inspector result. Contains a specially-formatted string that can be read
and then rendered client-side.
inspect-set-max-atom-length
Set the max length of nested atoms to specified value.
:max-atom-length
New max length.
:session
The current session
:doc-block-tags-fragments
May be absent. Represent the 'param', 'returns' and 'throws' sections a Java doc comment. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:doc-first-sentence-fragments
May be absent. Represents the first sentence of a Java doc comment. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:doc-fragments
May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:path
Printed representation of current inspector path.
:status
"done"
:value
The inspector result. Contains a specially-formatted string that can be read
and then rendered client-side.
inspect-set-max-coll-size
Set the number of nested collection members to display before truncating.
:max-coll-size
New collection size.
:session
The current session
:doc-block-tags-fragments
May be absent. Represent the 'param', 'returns' and 'throws' sections a Java doc comment. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:doc-first-sentence-fragments
May be absent. Represents the first sentence of a Java doc comment. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:doc-fragments
May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:path
Printed representation of current inspector path.
:status
"done"
:value
The inspector result. Contains a specially-formatted string that can be read
and then rendered client-side.
inspect-set-max-nested-depth
Set the maximum nested levels to display before truncating.
:max-nested-depth
New nested depth.
:session
The current session
:doc-block-tags-fragments
May be absent. Represent the 'param', 'returns' and 'throws' sections a Java doc comment. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:doc-first-sentence-fragments
May be absent. Represents the first sentence of a Java doc comment. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:doc-fragments
May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:path
Printed representation of current inspector path.
:status
"done"
:value
The inspector result. Contains a specially-formatted string that can be read
and then rendered client-side.
inspect-set-page-size
Sets the page size in paginated view to specified value.
:page-size
New page size.
:session
The current session
:doc-block-tags-fragments
May be absent. Represent the 'param', 'returns' and 'throws' sections a Java doc comment. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:doc-first-sentence-fragments
May be absent. Represents the first sentence of a Java doc comment. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:doc-fragments
May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:path
Printed representation of current inspector path.
:status
"done"
:value
The inspector result. Contains a specially-formatted string that can be read
and then rendered client-side.
inspect-tap-current-value
Send the currently inspected value to the Clojure tap>.
:session
The current session
:doc-block-tags-fragments
May be absent. Represent the 'param', 'returns' and 'throws' sections a Java doc comment. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:doc-first-sentence-fragments
May be absent. Represents the first sentence of a Java doc comment. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:doc-fragments
May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:path
Printed representation of current inspector path.
:status
"done"
:value
The inspector result. Contains a specially-formatted string that can be read
and then rendered client-side.
inspect-tap-indexed
Send the currently inspected sub-value at idx
to the Clojure tap>.
:idx
Index of the internal value to be tapped
:session
The current session
:doc-block-tags-fragments
May be absent. Represent the 'param', 'returns' and 'throws' sections a Java doc comment. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:doc-first-sentence-fragments
May be absent. Represents the first sentence of a Java doc comment. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:doc-fragments
May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It’s a vector of fragments, where fragment is a map with :type
('text' or 'html') and :content
plain text or html markup, respectively
:path
Printed representation of current inspector path.
:status
"done"
:value
The inspector result. Contains a specially-formatted string that can be read
and then rendered client-side.
is-var-profiled
Reports whether symbol is currently profiled.
:ns
The current namespace
:sym
The symbol to check
:status
Done
:value
'profiled' if profiling enabled, 'unprofiled' if disabled
macroexpand
Produces macroexpansion of some form using the given expander.
:code
The form to macroexpand.
:display-namespaces
How to print namespace-qualified symbols in the result. Possible values are "qualified" to leave all namespaces qualified, "none" to elide all namespaces, or "tidy" to replace namespaces with their aliases in the given namespace. Defaults to "qualified".
:expander
The macroexpansion function to use. Possible values are "macroexpand-1", "macroexpand", or "macroexpand-all". Defaults to "macroexpand".
:ns
The namespace in which to perform the macroexpansion. Defaults to 'user for Clojure and 'cljs.user for ClojureScript.
:print-meta
If truthy, also print metadata of forms.
:expansion
The macroexpanded form.
ns-aliases
Returns a map of [ns-alias] to [ns-name] in a namespace.
:ns
The namespace to use.
:ns-aliases
The map of [ns-alias] to [ns-name] in a namespace.
:status
done
ns-list
Return a sorted list of all namespaces.
:filter-regexps
All namespaces matching any regexp from this list would be dropped from the result.
:ns-list
The sorted list of all namespaces.
:status
done
ns-list-vars-by-name
Return a list of vars named name
amongst all namespaces.
:name
The name to use.
:status
done
:var-list
The list obtained.
ns-load-all
Loads all project namespaces.
:loaded-ns
The list of ns that were loaded.
:status
done
ns-path
Returns the path to the file containing ns.
:ns
The namespace to find.
:path
The path to the file containing ns. Please favor :url
in ClojureScript, but fall back to :path
.
:status
done
:url
The Java URL indicating the file containing ns. Please favor this attribute over :path
when possible. If this value is nil, you can fall back to :path
.
ns-vars
Returns a sorted list of public vars in a namespace.
:ns
The namespace to browse.
:var-query
The search query for vars. Only "private?" is supported for ClojureScript.
:ns-vars
The sorted list of public vars in a namespace.
:status
done
ns-vars-with-meta
Returns a map of [var-name] to [var-metadata] for public vars in a namespace.
:ns
The namespace to use.
:var-query
The search query for vars. Only "private?" is supported for ClojureScript.
:ns-vars-with-meta
The map of [var-name] to [var-metadata] for public vars in a namespace.
:status
done
out-subscribe
Change #'*out* so that it also prints to active sessions, even outside an eval scope.
out-unsubscribe
Change #'*out* so that it no longer prints to active sessions outside an eval scope.
profile-summary
Return profiling data summary.
:err
Content of profile summary report
:status
Done
profile-var-summary
Return profiling data summary for a single var.
:ns
The current namespace
:sym
The symbol to profile
:err
Content of profile summary report
:status
Done
refresh
Reloads all changed files in dependency order.
:after
The namespace-qualified name of a zero-arity function to call after reloading.
:before
The namespace-qualified name of a zero-arity function to call before reloading.
:dirs
List of directories to scan. If no directories given, defaults to all directories on the classpath.
:nrepl.middleware.print/buffer-size
The size of the buffer to use when streaming results. Defaults to 1024.
:nrepl.middleware.print/keys
A seq of the keys in the response whose values should be printed.
:nrepl.middleware.print/options
A map of options to pass to the printing function. Defaults to nil
.
:nrepl.middleware.print/print
A fully-qualified symbol naming a var whose function to use for printing. Must point to a function with signature [value writer options].
:nrepl.middleware.print/quota
A hard limit on the number of bytes printed for each value.
:nrepl.middleware.print/stream?
If logical true, the result of printing each value will be streamed to the client over one or more messages.
:error
A sequence of all causes of the thrown exception when status
is :error
.
:error-ns
The namespace that caused reloading to fail when status
is :error
.
:reloading
List of namespaces that will be reloaded.
:status
:ok
if reloading was successful; otherwise :error
.
refresh-all
Reloads all files in dependency order.
:after
The namespace-qualified name of a zero-arity function to call after reloading.
:before
The namespace-qualified name of a zero-arity function to call before reloading.
:dirs
List of directories to scan. If no directories given, defaults to all directories on the classpath.
:nrepl.middleware.print/buffer-size
The size of the buffer to use when streaming results. Defaults to 1024.
:nrepl.middleware.print/keys
A seq of the keys in the response whose values should be printed.
:nrepl.middleware.print/options
A map of options to pass to the printing function. Defaults to nil
.
:nrepl.middleware.print/print
A fully-qualified symbol naming a var whose function to use for printing. Must point to a function with signature [value writer options].
:nrepl.middleware.print/quota
A hard limit on the number of bytes printed for each value.
:nrepl.middleware.print/stream?
If logical true, the result of printing each value will be streamed to the client over one or more messages.
:error
A sequence of all causes of the thrown exception when status
is :error
.
:error-ns
The namespace that caused reloading to fail when status
is :error
.
:reloading
List of namespaces that will be reloaded.
:status
:ok
if reloading was successful; otherwise :error
.
refresh-clear
Clears the state of the refresh middleware. This can help recover from a failed load or a circular dependency error.
resource
Obtain the path to a resource.
:name
The name of the resource in question.
:resource-path
The file path to a resource.
resources-list
Obtain a list of all resources on the classpath.
:resources-list
The list of resources.
retest
[DEPRECATED - use test-var-query
instead] Run all tests in the project. If load?
is truthy, all project namespaces are loaded; otherwise, only tests in presently loaded namespaces are run. Results are cached for exception retrieval and to enable re-running of failed/erring tests.
:nrepl.middleware.print/buffer-size
The size of the buffer to use when streaming results. Defaults to 1024.
:nrepl.middleware.print/keys
A seq of the keys in the response whose values should be printed.
:nrepl.middleware.print/options
A map of options to pass to the printing function. Defaults to nil
.
:nrepl.middleware.print/print
A fully-qualified symbol naming a var whose function to use for printing. Must point to a function with signature [value writer options].
:nrepl.middleware.print/quota
A hard limit on the number of bytes printed for each value.
:nrepl.middleware.print/stream?
If logical true, the result of printing each value will be streamed to the client over one or more messages.
:elapsed-time
a report of the elapsed time spent running all the given namespaces. The structure is :elapsed-time {:ms <integer> :humanized <string>}
.
:fail-fast
If equals to the string "true", the tests will be considered complete after the first test has failed or errored.
:ns-elapsed-time
a report of the elapsed time spent running each namespace. The structure is :ns-elapsed-time {<ns as keyword> {:ms <integer> :humanized <string>}}
.
:results
Misc information about the test result. The structure is :results {<ns as keyword> {<test var as keyword> [{,,, :elapsed-time {:ms <integer> :humanized <string>}}]}}
:status
Either done or indication of an error
:var-elapsed-time
a report of the elapsed time spent running each var. The structure is :var-elapsed-time {<ns as keyword> {<var as keyword> {:ms <integer> :humanized <string>}}}
.
set-max-samples
Sets maximum sample count. Returns new max-sample-count.
:max-samples
Maximum samples to collect for any single var.
:status
Done
:value
String representing number of max-sample-count
slurp
Slurps a URL from the nREPL server, returning MIME data.
:body
The slurped content body.
:content-transfer-encoding
The encoding (if any) for the content.
:content-type
A MIME type for the response, if one can be detected.
spec-example
Return a string with a pretty printed example for a spec
:spec-name
The spec namespaced keyword we want the example for
:example
The pretty printed spec example string
:status
done
spec-form
Return the form of a given spec
:spec-name
The spec namespaced keyword we are looking for
:spec-form
The spec form
:status
done
spec-list
Return a sorted list of all specs in the registry
:filter-regex
Only the specs that matches filter prefix regex will be returned
:spec-list
The sorted list of all specs in the registry with their descriptions
:status
done
stacktrace
Return messages describing each cause and
stack frame of the most recent exception. This op is deprecated, please use the
analyze-last-stacktrace
op instead.
:nrepl.middleware.print/buffer-size
The size of the buffer to use when streaming results. Defaults to 1024.
:nrepl.middleware.print/keys
A seq of the keys in the response whose values should be printed.
:nrepl.middleware.print/options
A map of options to pass to the printing function. Defaults to nil
.
:nrepl.middleware.print/print
A fully-qualified symbol naming a var whose function to use for printing. Must point to a function with signature [value writer options].
:nrepl.middleware.print/quota
A hard limit on the number of bytes printed for each value.
:nrepl.middleware.print/stream?
If logical true, the result of printing each value will be streamed to the client over one or more messages.
:status
"done", or "no-error" if *e
is nil
test
[DEPRECATED - use test-var-query
instead] Run tests in the specified namespace and return results. This accepts a set of tests
to be run; if nil, runs all tests. Results are cached for exception retrieval and to enable re-running of failed/erring tests.
:nrepl.middleware.print/buffer-size
The size of the buffer to use when streaming results. Defaults to 1024.
:nrepl.middleware.print/keys
A seq of the keys in the response whose values should be printed.
:nrepl.middleware.print/options
A map of options to pass to the printing function. Defaults to nil
.
:nrepl.middleware.print/print
A fully-qualified symbol naming a var whose function to use for printing. Must point to a function with signature [value writer options].
:nrepl.middleware.print/quota
A hard limit on the number of bytes printed for each value.
:nrepl.middleware.print/stream?
If logical true, the result of printing each value will be streamed to the client over one or more messages.
:elapsed-time
a report of the elapsed time spent running all the given namespaces. The structure is :elapsed-time {:ms <integer> :humanized <string>}
.
:fail-fast
If equals to the string "true", the tests will be considered complete after the first test has failed or errored.
:ns-elapsed-time
a report of the elapsed time spent running each namespace. The structure is :ns-elapsed-time {<ns as keyword> {:ms <integer> :humanized <string>}}
.
:results
Misc information about the test result. The structure is :results {<ns as keyword> {<test var as keyword> [{,,, :elapsed-time {:ms <integer> :humanized <string>}}]}}
:status
Either done or indication of an error
:var-elapsed-time
a report of the elapsed time spent running each var. The structure is :var-elapsed-time {<ns as keyword> {<var as keyword> {:ms <integer> :humanized <string>}}}
.
test-all
Return exception cause and stack frame info for an erring test via the stacktrace
middleware. The error to be retrieved is referenced by namespace, var name, and assertion index within the var.
:nrepl.middleware.print/buffer-size
The size of the buffer to use when streaming results. Defaults to 1024.
:nrepl.middleware.print/keys
A seq of the keys in the response whose values should be printed.
:nrepl.middleware.print/options
A map of options to pass to the printing function. Defaults to nil
.
:nrepl.middleware.print/print
A fully-qualified symbol naming a var whose function to use for printing. Must point to a function with signature [value writer options].
:nrepl.middleware.print/quota
A hard limit on the number of bytes printed for each value.
:nrepl.middleware.print/stream?
If logical true, the result of printing each value will be streamed to the client over one or more messages.
:elapsed-time
a report of the elapsed time spent running all the given namespaces. The structure is :elapsed-time {:ms <integer> :humanized <string>}
.
:fail-fast
If equals to the string "true", the tests will be considered complete after the first test has failed or errored.
:ns-elapsed-time
a report of the elapsed time spent running each namespace. The structure is :ns-elapsed-time {<ns as keyword> {:ms <integer> :humanized <string>}}
.
:results
Misc information about the test result. The structure is :results {<ns as keyword> {<test var as keyword> [{,,, :elapsed-time {:ms <integer> :humanized <string>}}]}}
:status
Either done or indication of an error
:var-elapsed-time
a report of the elapsed time spent running each var. The structure is :var-elapsed-time {<ns as keyword> {<var as keyword> {:ms <integer> :humanized <string>}}}
.
test-stacktrace
Rerun all tests that did not pass when last run. Results are cached for exception retrieval and to enable re-running of failed/erring tests.
:nrepl.middleware.print/buffer-size
The size of the buffer to use when streaming results. Defaults to 1024.
:nrepl.middleware.print/keys
A seq of the keys in the response whose values should be printed.
:nrepl.middleware.print/options
A map of options to pass to the printing function. Defaults to nil
.
:nrepl.middleware.print/print
A fully-qualified symbol naming a var whose function to use for printing. Must point to a function with signature [value writer options].
:nrepl.middleware.print/quota
A hard limit on the number of bytes printed for each value.
:nrepl.middleware.print/stream?
If logical true, the result of printing each value will be streamed to the client over one or more messages.
test-var-query
Run tests specified by the var-query
and return results. Results are cached for exception retrieval and to enable re-running of failed/erring tests.
:var-query
A search query specifying the test vars to execute. See Orchard’s var query documentation for more details.
:nrepl.middleware.print/buffer-size
The size of the buffer to use when streaming results. Defaults to 1024.
:nrepl.middleware.print/keys
A seq of the keys in the response whose values should be printed.
:nrepl.middleware.print/options
A map of options to pass to the printing function. Defaults to nil
.
:nrepl.middleware.print/print
A fully-qualified symbol naming a var whose function to use for printing. Must point to a function with signature [value writer options].
:nrepl.middleware.print/quota
A hard limit on the number of bytes printed for each value.
:nrepl.middleware.print/stream?
If logical true, the result of printing each value will be streamed to the client over one or more messages.
:elapsed-time
a report of the elapsed time spent running all the given namespaces. The structure is :elapsed-time {:ms <integer> :humanized <string>}
.
:fail-fast
If equals to the string "true", the tests will be considered complete after the first test has failed or errored.
:ns-elapsed-time
a report of the elapsed time spent running each namespace. The structure is :ns-elapsed-time {<ns as keyword> {:ms <integer> :humanized <string>}}
.
:results
Misc information about the test result. The structure is :results {<ns as keyword> {<test var as keyword> [{,,, :elapsed-time {:ms <integer> :humanized <string>}}]}}
:status
Either done or indication of an error
:var-elapsed-time
a report of the elapsed time spent running each var. The structure is :var-elapsed-time {<ns as keyword> {<var as keyword> {:ms <integer> :humanized <string>}}}
.
toggle-profile
Toggle profiling of a given var.
:ns
The current namespace
:sym
The symbol to profile
:status
Done
:value
'profiled' if profiling enabled, 'unprofiled' if disabled, 'unbound' if ns/sym not bound
toggle-profile-ns
Toggle profiling of given namespace.
:ns
The current namespace
:status
Done
:value
'profiled' if profiling enabled, 'unprofiled' if disabled
toggle-trace-ns
Toggle tracing of a given ns.
:ns
The namespace to trace
:ns-status
The result of tracing operation
toggle-trace-var
Toggle tracing of a given var.
:ns
The current namespace
:sym
The symbol to trace
:var-name
The fully-qualified name of the traced/untraced var
:var-status
The result of tracing operation
undef
Undefine a symbol
:ns
The namespace is which to resolve sym (falls back to *ns* if not specified)
:sym
The symbol to undefine
:status
done
undef-all
Undefine all aliases and symbols in a namespace
:ns
The namespace to operate on
:status
done
cider/get-state
cider/log-add-appender
Add an appender to a log framework.
:appender
The name of the appender.
:filters
A map from filter name to filter condition.
:framework
The id of the log framework.
:size
The number of events the appender keeps in memory.
:threshold
The threshold in percent used to cleanup events.
:logger
The name of the logger to attach to.
:status
done
:cider/log-add-appender
The appender that was added.
cider/log-add-consumer
Add a consumer to an appender of a log framework.
:appender
The name of the appender.
:filters
A map from filter name to filter condition.
:framework
The id of the log framework.
:status
done
:cider/log-add-consumer
The consumer that was added.
cider/log-analyze-stacktrace
Analyze the stacktrace of a log event.
:appender
The name of the appender.
:event
The id of the event to inspect.
:framework
The id of the log framework.
:status
done
cider/log-clear-appender
Clear all events of a log appender.
:appender
The name of the appender.
:framework
The id of the log framework.
:status
done
:cider/log-clear-appender
The appender that was cleared.
cider/log-exceptions
Return the exceptions and their frequencies for the given framework and appender.
:appender
The name of the appender.
:framework
The id of the log framework.
:status
done
:cider/log-exceptions
A map from exception name to event frequency.
cider/log-format-event
Format a log event.
:appender
The name of the log appender.
:event
The id of the log event.
:framework
The id of the log framework.
:nrepl.middleware.print/buffer-size
The size of the buffer to use when streaming results. Defaults to 1024.
:nrepl.middleware.print/keys
A seq of the keys in the response whose values should be printed.
:nrepl.middleware.print/options
A map of options to pass to the printing function. Defaults to nil
.
:nrepl.middleware.print/print
A fully-qualified symbol naming a var whose function to use for printing. Must point to a function with signature [value writer options].
:nrepl.middleware.print/quota
A hard limit on the number of bytes printed for each value.
:nrepl.middleware.print/stream?
If logical true, the result of printing each value will be streamed to the client over one or more messages.
:status
done
:cider/log-format-event
The formatted log event.
cider/log-frameworks
Return the available log frameworks.
:status
done
:cider/log-frameworks
A list of log frameworks.
cider/log-inspect-event
Inspect a log event.
:appender
The name of the appender.
:event
The id of the event to inspect.
:framework
The id of the log framework.
:status
done
:value
The inspection result.
cider/log-levels
Return the log levels and their frequencies for the given framework and appender.
:appender
The name of the appender.
:framework
The id of the log framework.
:status
done
:cider/log-levels
A map from log level to event frequency.
cider/log-loggers
Return the loggers and their frequencies for the given framework and appender.
:appender
The name of the appender.
:framework
The id of the log framework.
:status
done
:cider/log-loggers
A map from logger name to event frequency.
cider/log-remove-appender
Remove an appender from a log framework.
:appender
The name of the appender.
:framework
The id of the log framework.
:status
done
:cider/log-remove-appender
The removed appender.
cider/log-remove-consumer
Remove a consumer from the appender of a log framework.
:appender
The name of the appender.
:consumer
The name of the consumer.
:framework
The id of the log framework.
:status
done
:cider/log-add-consumer
The removed consumer.
cider/log-search
Search the log events of an appender.
:appender
The name of the appender.
:framework
The id of the log framework.
:filters
A map from filter name to filter condition.
:limit
Number of log events to return.
:status
done
:cider/log-search
The list of log events matching the search.
cider/log-threads
Return the threads and their frequencies for the given framework and appender.
:appender
The name of the appender.
:framework
The id of the log framework.
:status
done
:cider/log-threads
A map from thread name to event frequency.
cider/log-update-appender
Update the appender of a log framework.
:appender
The name of the appender.
:filters
A map from filter name to filter condition.
:framework
The id of the log framework.
:size
The number of events the appender keeps in memory.
:threshold
The threshold in percent used to cleanup events.
:status
done
:cider/log-update-appender
The updated appender.
cider/log-update-consumer
Update the consumer of a log appender.
:appender
The name of the appender.
:consumer
The name of the consumer.
:filters
A map from filter name to filter condition.
:framework
The id of the log framework.
:status
done
:cider/log-update-consumer
The consumer that was updated.
cider.clj-reload/reload
Reloads all changed files in dependency order, using the io.github.tonsky/clj-reload library. It is bundled with cider-nrepl. If that dependency is already in present your project and clj-reload.core/init has been invoked beforehand, those configured directories will be honored.
:after
The namespace-qualified name of a zero-arity function to call after reloading.
:before
The namespace-qualified name of a zero-arity function to call before reloading.
:error
A sequence of all causes of the thrown exception when status
is :error
.
:progress
Description of current namespace being unloaded/loaded.
:status
:ok
if reloading was successful; otherwise :error
.
cider.clj-reload/reload-all
Reloads all files in dependency order.
:after
The namespace-qualified name of a zero-arity function to call after reloading.
:before
The namespace-qualified name of a zero-arity function to call before reloading.
:error
A sequence of all causes of the thrown exception when status
is :error
.
:reloading
Description of current namespace being unloaded/loaded.
:status
:ok
if reloading was successful; otherwise :error
.
cider.clj-reload/reload-clear
Clears the state of clj-reload. This can help recover from a failed load or a circular dependency error.
Can you improve this documentation? These fine people already did:
vemv, Bozhidar Batsov, Roman Scherer, Arne Brasseur, Oleksandr Yakushev, yuhan0, p4v4n, Iizuka Masashi, Filipe Silva & behricaEdit on GitHub
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close