Class chorus.Spec

class chorus.Spec

Package spec

[1]: string

URL or Github org/repo

name: string?

Name (derived from [1] otherwise)

build: (string | asyncfun())?

A command or ex command (prefix with :), or a function to run to build the package before it is usable. The function may continually call coroutine.yield with an optional status message to avoid blocking Neovim while waiting for completion

setup: (function)?

A function to set up the package after it’s available. As above, the function may yield to avoid blocking Neovim.

opts: any

Options to pass to package setup function

main: string?

Name of main Lua module, guessed from package name by default

dependencies: (chorus.SpecOrUrl[] | chorus.SpecOrUrl)?

Specs of dependencies

version: string?

Which version (tag or branch) to install. Overrides branch

branch: string?

Which branch to install. Excludes version

add: boolean?

Add package. false allows specifying details without actually causing the package to be installed until later. Default: true