nvim-lspconfig/scripts/docgen.lua, branch docs

fix(ci): "attempt to index field version" #4361

2026-03-27T11:54:19Z

Problem: ci failure after previous change: scripts/docgen.lua:249: attempt to index field 'version' (a function value) Solution: fix AI slop nooooo 😭 forgive me 🦞

fix(ci): noisy version changes in generated docs #4360

2026-03-27T11:48:28Z

Problem: The docgen script makes unwanted noise changes like this: diff --git a/doc/configs.md b/doc/configs.md index 25e2bc71d1..d8822ef0f4 100644 --- a/doc/configs.md +++ b/doc/configs.md @@ -2481,11 +2481,11 @@ Default config: { editorInfo = { name = "Neovim", - version = "0.12.0-dev+gc9e961994b" + version = "0.12.0-dev+g925e9e8722" }, editorPluginInfo = { name = "Neovim", - version = "0.12.0-dev+gc9e961994b" + version = "0.12.0-dev+g925e9e8722" } } ``` Solution: During doc generation, patch vim.version to be less noisy.

fix(docs): handle config errors, document rename #4192

2025-11-16T18:25:25Z

Problem: If a config throws an error it fails the entire doc generation. Solution: Handle config error in docgen. Unfortunately, this doesn't show the error message, it shows: loop or previous error loading module 'lsp.volar' instead of the actual `error('…')` message. So meanwhile, document the current deprecation/rename pattern and use `vim.notify()` instead.

fix(docs): "commands" item breaks docgen #3944

2025-07-10T12:48:37Z

feat(docgen.lua): convert `@brief` codeblocks for vimdoc #3787

2025-04-26T21:25:08Z

feat(docgen.lua): improve vimdoc generator #3783

2025-04-26T17:24:39Z

fix(docgen.lua): obsolete enable snippet

2025-04-25T18:47:20Z

fix(docgen.lua): omnisharp "--hostPID" arg always changes #3763

2025-04-22T13:19:15Z

ci(lint): use client:exec_cmd() #3755

2025-04-21T20:43:00Z

Use `client:exec_cmd()` instead of calling `request("workspace/executeCommand")` directly.

fix(docs): docgen.lua reads from `lua/*.lua` #3708

2025-04-13T02:40:01Z

Problem: Since configs now live in `lsp/`, the docgen needs to be updated. Solution: Read the configs from `lsp/`. Parse the `@brief` docstring to get the docs.

refactor: replace vim.loop with vim.uv #3703

2025-04-10T22:48:31Z

The former is deprecated in neovim 0.10. Remove the check added in 9b89ba5f158f73779cd58d0bb2783dfb40b28b0e. See: https://github.com/neovim/neovim/blob/v0.10.0/runtime/doc/deprecated.txt#L55

fix(docgen): :help (vimdoc) format #3683

2025-04-02T13:33:41Z

followup to #3675

fix(docgen): generate configs.txt in :help (vimdoc) format #3675

2025-04-02T13:10:55Z

fix(docgen): root_dir doc shows paths from CI env #3630

2025-02-27T12:31:41Z

Problem: When `root_dir` is not defined as a function, the generated docs show the paths resolved in the CI env: root_dir : lua "/home/runner/work/nvim-lspconfig/nvim-lspconfig" Solution: Always show the "gF" message for `root_dir`, even if it is not a function. Fix #3628

refactor(docgen): use vim.text.indent() #3629

2025-02-27T12:17:12Z

build: remove `docgen.sh`

2025-01-21T14:45:44Z

Instead, generate documentation by running the `docgen.lua` executable.

refactor: silence luals warnings

2024-12-22T13:37:19Z

refactor: deprecate util.path.join

2024-12-21T15:10:35Z

Work on https://github.com/neovim/nvim-lspconfig/issues/2079.

refactor: fix luals warnings

2024-12-19T10:33:57Z

Revert "refactor: use simpler file existence check" #3495

2024-12-06T11:19:39Z

This reverts commit 90c1c6cc822b1836209514c096069b9bbeab63d9. Fix #3485

refactor: replace all instances of vim.uv with vim.loop

2024-12-02T10:12:18Z

We still support neovim 0.9 currently, so we can't use vim.uv. Also add a check so we don't accidentally reintroduce it.

refactor: use simpler file existence check

2024-12-01T14:11:38Z

The vimscript function `getftype` is an easier way to check for file existence compared to vim.uv.

refactor: deprecate util.path.is_file #3474

2024-11-28T21:44:19Z

feat(docs): improve formatting of generated docs #3400

2024-10-24T17:28:14Z

feat(docs): improve formatting of generated docs

2024-10-24T15:38:57Z

feat(docs): autogenerate default_config docs

2024-10-24T15:24:48Z

Problem: debug.info() is useless for some functions because they point to util.lua Solution: Provide a path to the source code instead of trying to inline the source code.

feat(docs): autogenerate default_config docs

2024-10-24T15:24:45Z

Problem: Docs are manually maintained everywhere for no good reason. Solution: - revert commit 9dc02492c4a457479f8a0ec7a65aac1852ff59c0 - provide a "gF" friendly link to the source

docs: fix old URL

2024-10-09T18:52:54Z

refactor: minor cleanup

2024-10-06T19:41:54Z

ci: rename README_template.md #3357

2024-10-06T10:47:24Z

The name `README_template.md` is confusing, because it is not related to the README (that changed long ago).

refactor(docgen): cleanup #3336

2024-10-02T10:22:02Z

refactor: replace deprecated vim.loop with vim.uv

2024-10-02T10:09:17Z

feat: expose config definition as `config_def` #3335

2024-10-02T09:50:41Z

Problem: Users/plugins may want to use the config definition without actually activating the config via setup(). Solution: - Expose `config_def` field and document it. - Also undeprecate some stuff that doesn't yet have a documented alternative. TODO: configs.lua sets `M.filetypes = config.filetypes` and other fields in ad-hoc fashion "for :LspInfo" but it's not clear when those fields are actually populated, and they don't source from `config_def`...

refactor: rename "server_configurations" => "configs" #3330

2024-10-01T12:39:12Z

Problem: The name `server_configurations` is extremely verbose and irritatingly formal and dogmatic. This overlong name is a constant nuisance when reading, writing, and coding. It's also not even correct: these configurations are just as much "client" configurations as they are "server" configurations. Solution: - Rename to a shorter name. - Leave placeholder files for any old URLs that link to the old location.

fix(scripts): use compatible tbl_flatten in docgen (#3171)

2024-05-23T07:18:03Z

refactor: add compatible tbl_flatten and lsp_get_clients for new version 0.10 (#3154)

2024-05-17T06:06:45Z

chore: remove redundant config for Lua (#2523)

2023-03-23T08:35:08Z

docs: make sure username doesn't leak into generated document (#2441)

2023-02-15T14:47:52Z

* docs: make sure username doesn't leak into generated document The documents previously contained `runner`, the username of GitHub Actions runners, which would be overwritten by the user's name when run locally and generate unwanted diff. * docs: rename username to user Co-authored-by: Justin M. Keyes --------- Co-authored-by: Justin M. Keyes

chore(rust-analyzer): use `vim.json.decode` instead of `fn.json_decode` (#2096)

2022-08-27T09:03:41Z

docs: remove use of debug module for automatically extracting root pattern (#1799)

2022-03-20T19:15:43Z

docs: restore commands (#1798)

2022-03-20T18:55:16Z

docs: clean up styling in documentation (#1797)

2022-03-20T18:48:23Z

Make it more obvious not to copy/paste default_config

fix(help): workaround plugin/users overwritting tags (#1512)

2021-11-30T14:27:12Z

Most plugin managers run :helptags in the plugin, which silently overwrites the existing doc/tags. this is an issue for us since lspconfig is manipulating the tags file to point to servers_configurations.md Instead create a markdown comment with the name of the wanted tag and make a copy in the repository of servers_configurations.md to server_configurations.txt. Now when :helptags runs it finds the txt file and generates the appropriate tag. The advantage is this solution should work in all platforms, it also removes lines from docgen CI.

docs: make |lspconfig-server-configurations| jump to the markdown file (#1497)

2021-11-27T14:01:30Z

* generating the tags at docgen and modifying the |lspconfig-server-configurations| tag allows `:help lspconfig-server-configurations` take you to ./doc/server_configurations.md * adding a modeline to the markdown file ensures it sets the correct filetype Co-authored-by: Javier López

docs: fix docgen (#1486)

2021-11-26T14:04:47Z

chore: clean up imports

2021-11-26T04:46:21Z

feat: expose configs

2021-11-26T04:46:21Z

docs: documentation overhaul (#1384)

2021-11-09T17:53:21Z

* remove automated generation of vimdoc + ci * unify ADVANCED_README.md and vimdoc * rename CONFIGS.md to server_configurations.md, move into doc folder * move CONTRIBUTING.md to .github folder

chore: remove modeline (#1177)

2021-08-24T14:12:38Z

chore: change stylua to single quotes (#1068)

2021-07-13T17:41:39Z

ci: lint and format with stylua

2021-07-03T22:49:27Z

docs(config.md): separate out lua require block

2021-06-20T17:09:16Z

docgen: when no description provided fallback to reading function from source

2021-03-20T04:50:32Z

docgen: fix if malformed json entries present

2021-01-26T21:37:09Z

Remove all installers and install logic

2021-01-03T14:53:43Z

Separate autogenerated readme from readme.md

2020-12-20T20:48:16Z

docgen: add '-v' option to curl for debugging

2020-11-15T06:42:17Z

docgen script sometimes fails at downloading language server phase. But we can't know which language server's docgen phase was failed.

Rename nvim_lsp to lspconfig

2020-09-06T08:49:21Z

docgen: escape GitHub Flavored Markdown punctuation characters

2020-06-13T05:33:47Z

https://github.github.com/gfm/#backslash-escapes

docgen: use package.json url instead of VSCode extension name

2020-05-18T14:51:24Z

VSCode extensions are so large size and we offten get a network error with downloading them. So we had better to directory download package.json.

docgen.lua: call require_all_configs() earlier

2020-02-03T03:32:33Z

It is also needed by make_implemented_servers_list().

docgen.lua: require() all configs

2020-02-03T03:13:42Z

Since 6d380677502d, configs are lazy-loaded. So docgen.lua needs to require() them explicitly.

rename "skeleton" to "configs"

2020-01-31T08:38:42Z

ref b487481e19ab ref #100

rename "skeleton" to "configs" #100

2020-01-31T08:00:50Z

`nvim_lsp/skeleton.lua` is not really a skeleton, it's a `configs` class that provides 1. actual functionality 2. a bunch of configs Each config is added to the `configs` object (FKA "skeleton") as a property. Those configs are not "templates", they are "configs". So we should clean up the wording in various places to say "config" instead of "skeleton"/"template". Closes #64

CI: luacheck #86

2019-12-31T22:15:50Z

remove Vimscript wrapper nvim_lsp#setup()

2019-12-08T11:04:13Z

Lua is easy to use from Vimscript, there is no reason to have multiple ways to work with nvim-lsp. - massively clarifies the "story" that users need to comprehend - reduces surface area, maintenance, tests - avoids constant "Vim or Lua" dance in the documentation - simplifies discussions, tutorials, etc. - avoids confusing situation for users that start with Vimscript but later need Lua-only features

Add retry logic to docgen. (#54)

2019-11-26T14:28:55Z

Add sumneko_lua installation and util.sh helper. (#49)

2019-11-26T14:01:11Z

* Add sumneko_lua installation and util.sh helper. * Add vspackage extraction for package.json information via vscode name. * Allow specifying a tempdir at DOCGEN_TEMPDIR * Fix on_new_config and add docs for root_dir * User settings titles are not always useful

Add package_json for pyls and update docgen (#32)

2019-11-17T21:52:21Z

Refactor docgen and add package.json support (#29)

2019-11-17T20:27:06Z

Use a template for README.md (#28)

2019-11-17T17:58:52Z

Improve docgen (#27)

2019-11-17T17:32:11Z

- Automatically generate the `Implemented servers` section. - Remove dependency on `cat` - Provide scripts/docgen.sh which actually reports errors.

Redo installation. (#17)

2019-11-16T01:26:22Z

* Redo installation. Servers which want to be auto installed should specify skeleton[name].install() and it will be automatically added to the list of installable servers. - Add :LspInstall and :LspInstallInfo - Auto generate docs for servers with .install() available. - Add util.npm_installer - Refactor utf8 capabilities common config into a single function - Add contribution notes. - Also expose util.base_install_dir for other installers potentially - Fix tsserver's arguments and add javascript filetypes

Texlab settings (#14)

2019-11-15T22:03:28Z

* mark settings markdown as lua * add complete set of (default) options for texlab

Add ElmLS (#9)

2019-11-15T01:14:53Z

- Initial add of elmLS support - Removes unnecessary vim.schedule_wrap fn calls in elmls & clangd impls - Add automatic installation for elmls and update docs. - Sort server output in the README. - Add commands for elmls for buffer and globally. - [bugfix] Skeleton could've tried to attach even if root_dir was nil TODO: check for updates and warn the user if there are updates when an elm server is started. Co-authored-by: Seth Messer

Improve documentation and docgen command.

2019-11-14T19:01:16Z

Also improve the recommended command for running docgen.

Add initial support for python-language-server (#3)

2019-11-14T18:46:50Z

* initial support for python-language-server * put settings in documentation also: update docgen script update setup call examples in README_preamble

Clean up docs.

2019-11-14T09:13:56Z

Rename to nvim_lsp and nvim-lsp.

2019-11-14T09:07:09Z

Use new skeleton. Add docs generator.

2019-11-14T08:04:56Z