From f8b5cbe6312b568def1f91d747e2cdb8984fdf2e Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Fri, 18 Apr 2025 17:44:38 +0200
Subject: docs: cleanup

- brief should live at the top of each file
- fix indentation for some docs
---
 lsp/ts_ls.lua | 130 +++++++++++++++++++++++++++++-----------------------------
 1 file changed, 65 insertions(+), 65 deletions(-)

(limited to 'lsp/ts_ls.lua')

diff --git a/lsp/ts_ls.lua b/lsp/ts_ls.lua
index 3fdf71b5..40a1a6bb 100644
--- a/lsp/ts_ls.lua
+++ b/lsp/ts_ls.lua
@@ -1,70 +1,70 @@
 ---@brief
 ---
--- https://github.com/typescript-language-server/typescript-language-server
---
--- `ts_ls`, aka `typescript-language-server`, is a Language Server Protocol implementation for TypeScript wrapping `tsserver`. Note that `ts_ls` is not `tsserver`.
---
--- `typescript-language-server` depends on `typescript`. Both packages can be installed via `npm`:
--- ```sh
--- npm install -g typescript typescript-language-server
--- ```
---
--- To configure typescript language server, add a
--- [`tsconfig.json`](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html) or
--- [`jsconfig.json`](https://code.visualstudio.com/docs/languages/jsconfig) to the root of your
--- project.
---
--- Here's an example that disables type checking in JavaScript files.
---
--- ```json
--- {
---   "compilerOptions": {
---     "module": "commonjs",
---     "target": "es6",
---     "checkJs": false
---   },
---   "exclude": [
---     "node_modules"
---   ]
--- }
--- ```
---
--- ### Vue support
---
--- As of 2.0.0, Volar no longer supports TypeScript itself. Instead, a plugin
--- adds Vue support to this language server.
---
--- *IMPORTANT*: It is crucial to ensure that `@vue/typescript-plugin` and `volar `are of identical versions.
---
--- ```lua
--- vim.lsp.config('ts_ls', {
---   init_options = {
---     plugins = {
---       {
---         name = "@vue/typescript-plugin",
---         location = "/usr/local/lib/node_modules/@vue/typescript-plugin",
---         languages = {"javascript", "typescript", "vue"},
---       },
---     },
---   },
---   filetypes = {
---     "javascript",
---     "typescript",
---     "vue",
---   },
--- })
---
--- -- You must make sure volar is setup
--- -- e.g. require'lspconfig'.volar.setup{}
--- -- See volar's section for more information
--- ```
---
--- `location` MUST be defined. If the plugin is installed in `node_modules`,
--- `location` can have any value.
---
--- `languages` must include `vue` even if it is listed in `filetypes`.
---
--- `filetypes` is extended here to include Vue SFC.
+--- https://github.com/typescript-language-server/typescript-language-server
+---
+--- `ts_ls`, aka `typescript-language-server`, is a Language Server Protocol implementation for TypeScript wrapping `tsserver`. Note that `ts_ls` is not `tsserver`.
+---
+--- `typescript-language-server` depends on `typescript`. Both packages can be installed via `npm`:
+--- ```sh
+--- npm install -g typescript typescript-language-server
+--- ```
+---
+--- To configure typescript language server, add a
+--- [`tsconfig.json`](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html) or
+--- [`jsconfig.json`](https://code.visualstudio.com/docs/languages/jsconfig) to the root of your
+--- project.
+---
+--- Here's an example that disables type checking in JavaScript files.
+---
+--- ```json
+--- {
+---   "compilerOptions": {
+---     "module": "commonjs",
+---     "target": "es6",
+---     "checkJs": false
+---   },
+---   "exclude": [
+---     "node_modules"
+---   ]
+--- }
+--- ```
+---
+--- ### Vue support
+---
+--- As of 2.0.0, Volar no longer supports TypeScript itself. Instead, a plugin
+--- adds Vue support to this language server.
+---
+--- *IMPORTANT*: It is crucial to ensure that `@vue/typescript-plugin` and `volar `are of identical versions.
+---
+--- ```lua
+--- vim.lsp.config('ts_ls', {
+---   init_options = {
+---     plugins = {
+---       {
+---         name = "@vue/typescript-plugin",
+---         location = "/usr/local/lib/node_modules/@vue/typescript-plugin",
+---         languages = {"javascript", "typescript", "vue"},
+---       },
+---     },
+---   },
+---   filetypes = {
+---     "javascript",
+---     "typescript",
+---     "vue",
+---   },
+--- })
+---
+--- -- You must make sure volar is setup
+--- -- e.g. require'lspconfig'.volar.setup{}
+--- -- See volar's section for more information
+--- ```
+---
+--- `location` MUST be defined. If the plugin is installed in `node_modules`,
+--- `location` can have any value.
+---
+--- `languages` must include `vue` even if it is listed in `filetypes`.
+---
+--- `filetypes` is extended here to include Vue SFC.
 
 return {
   init_options = { hostInfo = 'neovim' },
-- 
cgit v1.2.3-70-g09d2