none-ls.nvim

The fundamental unit of operation in null-ls is a source. A source consists of:

• Method: Defines when the source runs (e.g., formatting, diagnostics).
• Generator: The logic that runs in response to a method request.
• Filetypes: A list determining which buffers activate the source.

You can check which sources are currently active for your buffer by running the command :NullLsInfo in Neovim.

Integrate bibclean to pretty-print, syntax check, and sort BibTeX database files.

local sources = { null_ls.builtins.formatting.bibclean }

Use the sqruff builtin for high-speed SQL linting and fixing.

local sources = { null_ls.builtins.formatting.sqruff }

Use the shfmt builtin to format shell scripts (bash support included).

local sources = { null_ls.builtins.formatting.shfmt }

Use the topiary builtin to format Nickel (ncl) files.

local sources = { null_ls.builtins.formatting.topiary }

Use the rubyfmt builtin to format Ruby code. Ensure you have the latest version installed in your PATH (e.g., via brew install rubyfmt).

local sources = { null_ls.builtins.formatting.rubyfmt }

Use the sqlfmt builtin to format dbt SQL files. Install via pip install shandy-sqlfmt[jinjafmt].

local sources = { null_ls.builtins.formatting.sqlfmt }

Integrate d2_fmt to format D2 diagram source files.

local sources = { null_ls.builtins.formatting.d2_fmt }

You can add sources to null-ls using either setup (for user configuration) or register (for integrations).

Both methods accept:

1. A single source.
2. A list of sources.
3. A table containing multiple sources with shared configuration.

Dynamically registering a diagnostic source will automatically refresh diagnostics for affected buffers.

local null_ls = require("null-ls")

-- 1. Using setup (standard user config)
null_ls.setup({ sources = my_sources })

-- 2. Using register (for integrations)
-- Single source
null_ls.register({ my_source })

-- List of independent sources
null_ls.register({ my_source, my_other_source })

-- Multiple sources with shared configuration
null_ls.register({
    name = "my-sources", 
    filetypes = { "lua" }, 
    sources = { my_source, my_other_source }
})

Use the typstfmt builtin to format Typst files.

local sources = { null_ls.builtins.formatting.typstfmt }

Use the raco_fmt builtin to format Racket files. Requires Racket 8.0 or later. Install the formatter using raco pkg install fmt.

local sources = { null_ls.builtins.formatting.raco_fmt }