Skip to content

Document the static completion features in the README #65

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.

Sign up for GitHub

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

Merged
bbatsov merged 1 commit into from
Jul 18, 2026
Merged

Document the static completion features in the README #65

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,14 @@ Why here? Because it's very convenient from the user perspective to have a singl

This type of completion provides a [compliment custom source](https://github.com/alexander-yakushev/compliment/wiki/Custom-sources) for ClojureScript, so it's easy to plug with the most popular completion framework out there.

It brings the static completion close to what compliment does for Clojure:

- fuzzy matching (`pr-fn` completes `print-function`, `cs` completes `clojure.string`)
- compliment-style ranking (current-namespace vars first, then `cljs.core`, then namespaces and classes)
- local bindings from the surrounding form, including destructuring (`let`, `loop`, `fn`, `for`, `doseq`, ...)
- vars referred in a `(:require [some.ns :refer [...]])` clause
- special forms offered only at the head of a list

``` clojure
(ns suitable.demo
(:require
Expand Down
Loading