chore: Auto generate docs

nvimtools · Sep 22, 2023 · 68645e5 · 68645e5
1 parent 2782d44
commit 68645e5
Show file tree

Hide file tree

Showing 4 changed files with 1 addition and 87 deletions.
diff --git a/doc/BUILTINS.md b/doc/BUILTINS.md
@@ -14,65 +14,6 @@ See [BUILTIN_CONFIG](BUILTIN_CONFIG.md) to learn how to set up and configure the
 
 ## Code Actions
 
-### [cspell](https://github.com/streetsidesoftware/cspell)
-
-Injects actions to fix typos found by `cspell`.
-
-**This source is not actively developed in this repository.**
-
-An up-to-date version exists as a companion plugin in [cspell.nvim](https://github.com/davidmh/cspell.nvim)
-
-#### Usage
-
-```lua
-local sources = { null_ls.builtins.diagnostics.cspell, null_ls.builtins.code_actions.cspell }
-```
-
-#### Defaults
-
-- Filetypes: `{}`
-- Method: `code_action`
-
-#### Config
-
-##### `find_json` (function)
-
-Customizing the location of cspell config
-
-```lua
-local cspell = null_ls.builtins.code_actions.cspell.with({
-    config = {
-        find_json = function(cwd)
-            return vim.fn.expand(cwd .. "/cspell.json")
-        end
-    },
-})
-```
-##### `on_success` (function)
-
-Callback after successful execution of code action.
-
-```lua
-local cspell = null_ls.builtins.code_actions.cspell.with({
-    config = {
-        on_success = function(cspell_config_file, params)
-            -- format the cspell config file
-            os.execute(
-                string.format(
-                    "cat %s | jq -S '.words |= sort' | tee %s > /dev/null",
-                    cspell_config_file,
-                    cspell_config_file
-                )
-            )
-        end
-    },
-})
-```
-
-#### Notes
-
-- This source depends on the `cspell` built-in diagnostics source, so make sure to register it, too.
-
 ### [eslint](https://github.com/eslint/eslint)
 
 Injects actions to fix ESLint issues or ignore broken rules.
@@ -784,27 +725,6 @@ local sources = { null_ls.builtins.diagnostics.credo }
 
 - Searches upwards from the buffer to the project root and tries to find the first `.credo.exs` file in case the project has nested `credo` configs.
 
-### [cspell](https://github.com/streetsidesoftware/cspell)
-
-cspell is a spell checker for code.
-
-**This source is not actively developed in this repository.**
-
-An up-to-date version exists as a companion plugin in [cspell.nvim](https://github.com/davidmh/cspell.nvim)
-
-#### Usage
-
-```lua
-local sources = { null_ls.builtins.diagnostics.cspell }
-```
-
-#### Defaults
-
-- Filetypes: `{}`
-- Method: `diagnostics`
-- Command: `cspell`
-- Args: dynamically resolved (see [source](https://github.com/nvimtools/none-ls.nvim/blob/main/lua/null-ls/builtins/diagnostics/cspell.lua))
-
 ### [cue_fmt](https://github.com/cue-lang/cue)
 
 Reports on formatting errors in .cue language files.

diff --git a/doc/null-ls.txt b/doc/null-ls.txt
@@ -1,4 +1,4 @@
-*null-ls.txt*                                   Last change: 2023 September 19
+*null-ls.txt*                                   Last change: 2023 September 22
 
 ==============================================================================
 Table of Contents                                  *null-ls-table-of-contents*

diff --git a/lua/null-ls/builtins/_meta/code_actions.lua b/lua/null-ls/builtins/_meta/code_actions.lua
@@ -1,9 +1,6 @@
 -- THIS FILE IS GENERATED. DO NOT EDIT MANUALLY.
 -- stylua: ignore
 return {
-  cspell = {
-    filetypes = {}
-  },
   eslint = {
     filetypes = { "javascript", "javascriptreact", "typescript", "typescriptreact", "vue" }
   },

diff --git a/lua/null-ls/builtins/_meta/diagnostics.lua b/lua/null-ls/builtins/_meta/diagnostics.lua
@@ -61,9 +61,6 @@ return {
   credo = {
     filetypes = { "elixir" }
   },
-  cspell = {
-    filetypes = {}
-  },
   cue_fmt = {
     filetypes = { "cue" }
   },