nrepl.util.completion — nrepl 1.1.1

Code completion functionality.

This namespace is based on compliment-lite. (https://github.com/alexander-yakushev/compliment/tree/master/lite)

The functionality here is experimental and the API is subject to changes.

*extra-metadata* clj

Signals to downstream sources which additional information about completion candidates they should attach . Should be a set of keywords.

aliased-candidates clj

(aliased-candidates prefix ns)

Returns a list of alias-qualified double-colon keywords (like ::str/foo), where alias has to be registered in the given namespace.

all-sources clj

(all-sources)

(all-sources source-kws)

Returns the list of all completion sources, or the selected once specified by source-kws.

cache-last-result clj macro

(cache-last-result name key value)

If cache for name is absent, or key doesn't match the key in the cache, calculate v and return it. Else return value from cache.

cache-last-result* clj

(cache-last-result* name key value-fn)

camel-case-matches? clj

(camel-case-matches? prefix member-name)

Tests if prefix matches the member name following camel case rules. Thus, prefix getDeF matches member getDeclaredFields.

class-member-symbol? clj

(class-member-symbol? x)

Tests if a symbol name looks like a non-static class member.

classes-candidates clj

(classes-candidates prefix ns _)

Returns a list of classname completions.

classes-on-classpath clj

(classes-on-classpath)

Returns a map of all classes that can be located on the classpath. Key represent the root package of the class, and value is a list of all classes for that package.

completions clj

(completions prefix)

(completions prefix ns)

(completions prefix
             ns
             {:keys [sort-order sources extra-metadata plain-candidates]
              :or {sort-order :by-name}})

Returns a list of completions for the given prefix.

Options map can contain the following options:

• :ns - namespace where completion is initiated;
• :sort-order (either :by-length or :by-name);
• :plain-candidates - if true, returns plain strings instead of maps;
• :extra-metadata - set of extra fields to add to the maps;
• :sources - list of source keywords to use.

dash-matches? clj

(dash-matches? prefix var)

Tests if prefix partially matches a var name with dashes as separators.

defsource clj

(defsource name & {:as kw-args})

Defines a source with the given name and argument map. Map must contain two keys - :candidates and :doc.

Value of :candidatesshould be a function of prefix, namespace and context.

Value of :doc latter should be a function of symbol name and namespace.

ensure-ns clj

(ensure-ns nspc)

Takes either a namespace object or a symbol and returns the corresponding namespace if it exists, otherwise returns user namespace.

fuzzy-matches-no-skip? clj

(fuzzy-matches-no-skip? prefix symbol separator?)

Tests if symbol matches the prefix where separator? checks whether character is a separator. Unlike fuzzy-matches? requires separator characters to be present in prefix.

fuzzy-matches? clj

(fuzzy-matches? prefix symbol separator)

Tests if symbol matches the prefix when symbol is split into parts on separator.

get-all-members clj

(get-all-members ns context-class)

Returns all non-static members for a given namespace.

keyword-candidates clj

(keyword-candidates prefix ns _)

list-jdk9-base-classfiles clj macro

(list-jdk9-base-classfiles)

Because on JDK9+ the classfiles are stored not in rt.jar on classpath, but in modules, we have to do extra work to extract them.

literal-candidates clj

(literal-candidates prefix _ __)

We define true, false, and nil in a separate source because they are not context-dependent (don't have to be first items in the list).

members-cache clj

Stores cache of all non-static members for every namespace.

members-candidates clj

(members-candidates prefix ns _)

Returns a list of Java non-static fields and methods candidates.

namespace-alias-candidates clj

(namespace-alias-candidates prefix ns)

Returns a list of namespace aliases prefixed by double colon required in the given namespace.

namespaces&files-on-classpath clj

(namespaces&files-on-classpath)

Returns a collection of maps (e.g. {:ns-str "some.ns", :file "some/ns.cljs"}) of all clj/cljc/cljs namespaces obtained by classpath scanning.

namespaces-candidates clj

(namespaces-candidates prefix ns _)

Returns a list of namespace and classname completions.

nscl-matches? clj

(nscl-matches? prefix namespace)

Tests if prefix partially matches a namespace or classname with periods as separators.

nscl-symbol? clj

(nscl-symbol? x)

Tests if prefix looks like a namespace or classname.

populate-members-cache clj

(populate-members-cache ns classes imported-classes-cnt)

Populate members cache of class members for ns from the given list of classes. imported-classes-cnt is a number that indicates the current number of imported classes in this namespace.

populate-static-members-cache clj

(populate-static-members-cache class)

Populates static members cache for a given class.

primitive-cache clj

qualified-candidates clj

(qualified-candidates prefix ns)

Returns a list of namespace-qualified double-colon keywords (like ::foo) resolved for the given namespace.

resolve-class clj

(resolve-class ns sym)

Tries to resolve a classname from the given symbol, or returns nil if classname can't be resolved.

resolve-namespace clj

(resolve-namespace sym ns)

Tries to resolve a namespace from the given symbol, either from a fully qualified name or an alias in the given namespace.

root-packages-on-classpath clj

(root-packages-on-classpath)

Return a set of all classname "TLDs" on the classpath.

special-candidates clj

(special-candidates prefix _ _)

Returns list of completions for special forms.

split-by-leading-literals clj

(split-by-leading-literals symbol-str)

Separate quote/var/deref qualifiers from a var name.

static-member-symbol? clj

(static-member-symbol? x)

Tests if prefix looks like a static member symbol, returns parsed parts.

static-members clj

(static-members class)

Returns all static members for a given class.

static-members-cache clj

Stores cache of all static members for every class.

static-members-candidates clj

(static-members-candidates prefix ns _)

Returns a list of static member candidates.

static? clj

(static? member)

Tests if class member is static.

update-cache clj

(update-cache ns)

(update-cache ns context-class)

Updates members cache for a given namespace if necessary.

var-symbol? clj

(var-symbol? x)

Test if prefix resembles a var name.

vars-candidates clj

(vars-candidates prefix ns _)

Returns a list of namespace-bound candidates, with namespace being either the scope (if prefix is scoped), ns arg or the namespace extracted from context if inside ns declaration.