eslintls: add some documentation

1 files changed, 23 insertions, 6 deletions

diff --git a/lua/nvim-lsp-installer/servers/eslintls.lua b/lua/nvim-lsp-installer/servers/eslintls.lua
index b8f0f448..dc595d79 100644
--- a/lua/nvim-lsp-installer/servers/eslintls.lua
+++ b/lua/nvim-lsp-installer/servers/eslintls.lua
@@ -8,15 +8,12 @@ if not lspconfig.eslintls then
         default_config = {
             filetypes = {'javascript', 'javascriptreact', 'typescript', 'typescriptreact'},
             root_dir = lspconfig.util.root_pattern(".eslintrc*", "package.json", ".git"),
+
+            -- Refer to https://github.com/Microsoft/vscode-eslint#settings-options for documentation.
             settings = {
-                nodePath = '', -- If this is a non-null/undefined value the eslint LSP runs into runtime exceptions.
                 validate = 'on',
                 run = 'onType',
-                workingDirectory = {mode = "auto"},
-                workspaceFolder = {
-                    uri = "/",
-                    name = "root",
-                },
+
                 codeAction = {
                     disableRuleComment = {
                         enable = true,
@@ -26,6 +23,26 @@ if not lspconfig.eslintls then
                         enable = true
                     }
                 },
+
+                -- Automatically determine working directory by locating .eslintrc config files.
+                --
+                -- It's recommended not to change this.
+                workingDirectory = {mode = "auto"},
+
+                -- If nodePath is a non-null/undefined value the eslint LSP runs into runtime exceptions.
+                --
+                -- It's recommended not to change this.
+                nodePath = '',
+
+                -- The "workspaceFolder" is a VSCode concept. We set it to the root
+                -- directory to not restrict the LPS server when it traverses the
+                -- file tree when locating a .eslintrc config file.
+                --
+                -- It's recommended not to change this.
+                workspaceFolder = {
+                    uri = "/",
+                    name = "root",
+                },
             },
         },
     }