Unlike most Clojure editors, Cursive works by analysing source code rather than introspecting a REPL for editor functionality. This has many advantages, but it has one major disadvantage - Cursive is generally unaware of which local bindings and vars are defined by macro forms. Cursive ships with built-in support for all core macro forms and for many popular libraries, but for in-house macros or open source libraries that Cursive doesn’t yet support this can be annoying. It mostly manifests as false positive warnings about unresolved symbols and things like completions not working correctly, but it can also show up as incorrect arity warnings and so on.
Many custom macro forms are very similar to built-in forms.
def-type macros are very common, as are forms that mostly work like
let. Since 1.3.0, Cursive now allows you to customise the symbol resolution for custom macros to mimic these common forms. When the caret is the head symbol of a macro form which is not handling the symbol resolution correctly, you’ll see the intention lightbulb near the left margin and you can use Alt Enter to customise how that form is interpreted:
Selecting that option allows you to choose which existing form the form you’re customising should be interpreted as:
Note that this will only change how Cursive interprets the form, it has no effect on how your program actually runs. Currently you can choose to interpret the form as
def means that Cursive will look for a name symbol as the second element in the form, and will create var metadata using that name. It will also treat a string following that symbol as a docstring, if present. Choosing
for will assume that your form looks like the built-in equivalents, and will set up the local bindings in the corresponding way. Choosing
->> will prevent spurious arity warnings when creating custom threading forms. Your custom form will also be formatted in the same way as the built-in form, but if you customise the formatting as described here that will be overridden as normal.
This support will work in a lot of cases, but we’ll be adding more sophisticated support soon to allow users to help Cursive understand more complicated forms.