compliment.core — compliment 0.3.13

Core namespace. Most interactions with Compliment should happen through functions defined here.

all-files clj

List of all Compliment files in an order they should be loaded. This is required by REPLy.

completions clj

(completions prefix)

(completions prefix options-map)

Returns a list of completions for the given prefix.

Options map can contain the following options:

• :ns - namespace where completion is initiated;
• :context - code form around the prefix;
• :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.

documentation clj

(documentation symbol-str)

(documentation symbol-str ns)

(documentation symbol-str ns options-map)

Returns a documentation string that describes the given symbol.

Options map can contain the following options:

• :sources - list of source keywords to use.

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.

sort-by-length clj

(sort-by-length candidates)

Sorts list of strings by their length first, and then alphabetically if length is equal. Works for tagged and non-tagged results.