feat(v1.2.0): release

Author: hinell

.github/ISSUE_TEMPLATE/issue-bug.yml

@@ -1,10 +1,17 @@
-name: Bug Report
+name: Bug
 description: File a bug report
 title: "Bug report"
 labels: ["bug"]
 assignees:
   - hinell
 body:
+  - type: checkboxes
+    id: issue-trouble-is-read
+    attributes:
+      label: I've read TROUBLESHOOTING instructions
+      options:
+        - label: "Yes"
+          required: true
   - type: textarea
     id: issue-summary
     attributes:
@@ -30,3 +37,20 @@ body:
         LuaJIT 2.1.0-beta3
     validations:
       required: false
+  - type: dropdown
+    id: OS
+    attributes:
+      label: Specify operating system/environment
+      options:
+        - Linux/Debian/Ubuntu
+        - Linux/Debian/Kubuntu
+        - Linux / Other
+        - Archlinux
+        - NixOS
+        - MacOS
+        - Windows
+        - Windows WSL
+        - Docker
+        - Other
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/issue-feature.yml

@@ -1,6 +1,6 @@
 # https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
-name: Feature request
-description: "Feature requests aren't expected, but you can try"
+name: Feature
+description: "File a feature request; they are aren't expected, but you can try"
 labels: ["enhancement"]
 assignees:
   - hinell

CONTRIBUTING.md

@@ -1,19 +1,20 @@
 # CONTRIBUTING
 
-This project is open-source, meaning you can make as many copies of it as you want and do whatever you want with those copies as long as you are not trying to commercialize it, but it does NOT encouraging contributions. In order to keep this library in the public domain and ensure that the code does not become contaminated with proprietary or strictly-licensed content, the project does not accept patches from people who have not submitted an affidavit dedicating their contribution into the public domain.
+This project is open-source, meaning you can make as many copies of it as you want and do whatever you want with the code as long as you are not trying to commercialize it, but it does NOT encourage contributions. In order to keep this library in the public domain and ensure that the code does not become contaminated with proprietary or strictly-licensed content or code that is hard to maintain, the project does not accept patches from people who have not submitted an affidavit dedicating their contribution to the author of this project or public domain.
 
-All of the code in it is original, having been written specifically for use by it. No code has been copied from unknown sources on the internet.
+All of the code have been written specifically for use by it; NO code has been copied from unknown sources on the internet unless explicitly specified.
 
-If your contribution ever accepted, then:
-* You waive your legal rights to any textual or visual contribution you make to this project
+If your contribution is ever accepted, then:
+* You waive all your legal rights to any textual or visual contribution you make to this project
 * You wholly transfer the said rights to the author of this project
 * You admit that the said contribution is subject to change and may be changed beyound recognition
 
-> **REF**: [SQLite Disclaimer](https://www.sqlite.org/copyright.html)</br>
-> **REF**: [Open Source is Not About You](https://gist.github.com/richhickey/1563cddea1002958f96e7ba9519972d9)
-
-### [DEVELOPMENT](./DEVELOPMENT.md)
+## SEE ALSO
+> [LICENSE](LICENSE)<br/>
+> [SQLite Disclaimer](https://www.sqlite.org/copyright.html)<br/>
+> [Open Source is Not About You](https://gist.github.com/richhickey/1563cddea1002958f96e7ba9519972d9)
+# [DEVELOPMENT](./DEVELOPMENT.md)
 
 ----
-September 15, 2023</br>
+October 26, 2023</br>
 Copyright © 2023 - Alexander Davronov (a.k.a. github@hinell), et.al.<br>

README.md

@@ -1,7 +1,7 @@
 <!---->
 
 <div align="center">
-  <h1 align="center">🔌  lsp-timeout.nvim</h2>
+  <h1 align="center">lsp-timeout.nvim<img width="32" src="https://neovim.io/logos/neovim-mark-flat.png" align="right" /></h1>
 </div>
 
 <!-- <img width="100%" src="doc/preview.png" /> -->
@@ -33,22 +33,6 @@ automatically upon gaining or loosing window focus, keeping neovim fast.
 
 ## 📦 Installation
 
-#### [packer.nvim](https://github.com/wbthomason/packer.nvim)
-```lua
--- $HOME/.config/nvim/lua/user/init.lua
-packer.setup(function(use)
-    use({
-         "hinell/lsp-timeout.nvim",
-        requires={ "neovim/nvim-lspconfig" },
-        setup = function()
-            vim.g["lsp-timeout-config"] = {
-                -- ...
-            }
-        end
-    })
-end)
-```
-
 #### [lazy.vim](https://github.com/folke/lazy.nvim)
 ```lua
 require("lazy").setup(
@@ -59,6 +43,17 @@ require("lazy").setup(
 )
 ```
 
+#### [packer.nvim](https://github.com/wbthomason/packer.nvim)
+```lua
+-- $HOME/.config/nvim/lua/user/init.lua
+packer.setup(function(use)
+    use({
+        "hinell/lsp-timeout.nvim",
+        requires={ "neovim/nvim-lspconfig" }
+    })
+end)
+```
+
 #### [vim-plug](https://github.com/junegunn/vim-plug)
 ``` vim
 Plug "hinell/lsp-timeout.nvim"

doc/RELEASE

@@ -1,11 +1,14 @@
-* chore(lua-lsp): fix config
-* docs(*): major update
-* feat(lsp-timeout): support for multi-tab mode
-* refactor(config): reformat; allow nil values for config
-* feat(napi): add cross-runtime functions
-* docs(*): update CONTRIBUTING.md DEVELOPMENT.md
-* refactor(github): update github templates
-* docs(*): note on LspInfo
-* refactor(Makefile): Use .SILENT
-* refactor(autocmds): refactor autocmds description
-* fix(#10): no config added
+* refactor(plugin): better error message
+* feat(plugin): disable lsp-timeout for ignored filetypes
+* feat(config): support filetypes.ignore list; Fixes #10
+* feat(plugin): deprecate ["lsp-timeout-config"] for lspTimeoutConfig
+* feat(plugin): keep track of stopped clients; restart by native lsp
+  funnctions; honor non-lspconfig servers (e.g. null-ls or none-ls)
+  previously stopped; force clients to stop & detach; Fixes #13
+* docs(readme): nvim icons
+* docs(*): remove preview.png
+* docs(CONTRIBUTING): fix typo, reword
+* docs(*): note on typescript-tools
+* docs(*): fix typos; reword
+* chore(github): add more fields to issue-bug.yml
+* docs(*): typo fixes

doc/index.md

@@ -1,4 +1,4 @@
-## OVERVIEW
+# OVERVIEW
 
 Nvim plugin for nvim-lspconfig: stop idle servers & restart upon gaining focus;
 keeps RAM usage low
@@ -15,21 +15,18 @@ Use your favorite package manager (Packer, Plug, Lazy.nvim etc.); it's advised t
 "hinell/lsp-timeout.nvim"
 ```
 
-Prerequisites:
+Requirements:
 
 * Neovim v0.7.2+
 * nvim-lspconfig: https://github.com/neovim/nvim-lspconfig
 
-
-Lazy.nvim:
-
 ```lua
 {
     "hinell/lsp-timeout.nvim",
     dependencies={ "neovim/nvim-lspconfig" },
     init = function()
-        vim.g["lsp-timeout-config"] = {
-        -- 
+        vim.g.lspTimeoutConfig = {
+        -- see config below
         }
     end
 }
@@ -47,8 +44,8 @@ packer.setup(function(use)
       "hinell/lsp-timeout.nvim",
       requires={ "neovim/nvim-lspconfig" },
       setup = function()
-        vim.g["lsp-timeout-config"] = {
-            -- 
+        vim.g.lspTimeoutConfig = {
+        -- see config belos 
         }
       end
     })
@@ -64,17 +61,28 @@ See DEVELOPMENT.md for more info.
 <!-- ## API -->
 ## CONFIGURATION
 ```lua
-vim.g["lsp-timeout-config"] = {
+vim.g.lspTimeoutConfig = {
     stopTimeout  = 1000 * 60 * 5, -- ms, timeout before stopping all LSPs 
     startTimeout = 1000 * 10,     -- ms, timeout before restart
     silent       = false          -- true to suppress notifications
+    filetypes    = {
+        ignore = {                -- filetypes to ignore; empty by default
+                                  -- lsp-timeout is disabled completely
+        }                         -- for these filetypes
+    }
+}
+
+-- Buffer local configuration; overrides global
+bufnr = vim.api.nvim_get_current_buf() 
+vim.b[bufnr].lspTimeoutConfig = {
+    -- ..
 }
 ```
 
 ```lua
--- Optionally, validate config
+-- Optionally, validate the config
 local Config = require("lsp-timeout.config").Config
-      Config:new(vim.g["lsp-timeout-config"]):validate()
+      Config:new(vim.g.lspTimeoutConfig):validate()
 ```
 
 ### Augroups
@@ -95,20 +103,20 @@ Plugin setups two augroups:
 #### TROUBLESHOOTING PLUGINS
 * Some plugins that require active LSP servers like ones used for signs may fail if they don't hook into |LspAttach| or |LspDetach| events or `vim.lsp.get_clients(...)` properly 
 * Some LSP servers may misbehave upon restart if they don't keep cache
-* Some LSP plugins may hook into serveral LSPs and fail upon restart  
+* Some LSP plugins may hook into serveral LSPs at the same time and fail upon restart
 * See also: https://github.com/neovim/nvim-lspconfig#troubleshooting
 
 Plugins that are known to misbehave:
-* **null-ls**: fails to startup, replace by `efm-languageserver` or use workaround,
-<br/>see https://github.com/hinell/lsp-timeout.nvim/issues/7#issuecomment-1764402683
+* **null-ls** and **none-ls**:
+<br/>as of v1.2.0 should work properly; if didn't, replace by `efm-languageserver` or run `:e` upon focusing or use workaround,
+<br/>see: https://github.com/hinell/lsp-timeout.nvim/issues/7#issuecomment-1764402683
 
 * **efm-languageserver**: 
 <br/>make sure that `filetypes` are specified in the setup config
 <br/>see: https://github.com/neovim/nvim-lspconfig/blob/master/doc/server_configurations.md#efm
 
-* **barbecue.nvim**: 
-<br/>**nvim-navic**:
-<br/>you have to attach `navic.nvim` to one specific LSP; avoid attaching it to generic (e.g. efmls) LSPs:
+* **barbecue.nvim** and **nvim-navic**:
+<br/>you have to attach `navic.nvim` to one specific LSP; avoid attaching it to generic ones (e.g. efmls):
 <br/>see: https://github.com/utilyre/barbecue.nvim 
 ```lua
 require("lspconfig")[serverName].setup({
@@ -120,6 +128,11 @@ require("lspconfig")[serverName].setup({
   end,
 ```
 
+* **pmizio/typescript-tools.nvim**:
+<br/>run `lspconfig["typescript-tools"].setup({ filetypes = })` 
+<br/>make sure that `filetypes` are specified in the setup config
+<br/>see: https://github.com/hinell/lsp-timeout.nvim/issues/12#issuecomment-1779750062
+
 <!-- ## EXAMPLES -->
 <!-- ## KEYBINDINGS -->
 <!-- ## LEGENDARY -->

doc/lsp-timeout.txt

@@ -1,17 +1,16 @@
-*lsp-timeout.txt*                                 Last change: 2023 October 19
+*lsp-timeout.txt*                                 Last change: 2023 October 29
 
 ==============================================================================
 Table of Contents                              *lsp-timeout-table-of-contents*
 
-OVERVIEW .............................................. |lsp-timeout-overview|
 INSTALL ................................................ |lsp-timeout-install|
 UPDATE .................................................. |lsp-timeout-update|
 CONFIGURATION .................................... |lsp-timeout-configuration|
 Augroups .............................................. |lsp-timeout-augroups|
 TROUBLESHOOTING ................................ |lsp-timeout-troubleshooting|
 TROUBLESHOOTING PLUGINS ................ |lsp-timeout-troubleshooting-plugins|
 
-------------------------------------------------------------------------------
+==============================================================================
 OVERVIEW                                                *lsp-timeout-overview*
 
 
@@ -36,19 +35,17 @@ to use`latest` tag
 >
     "hinell/lsp-timeout.nvim"
 <
-Prerequisites:
+Requirements:
 
 * Neovim v0.7.2+
 * nvim-lspconfig: https://github.com/neovim/nvim-lspconfig
-Lazy.nvim:
-
 >lua
     {
         "hinell/lsp-timeout.nvim",
         dependencies={ "neovim/nvim-lspconfig" },
         init = function()
-            vim.g["lsp-timeout-config"] = {
-            -- 
+            vim.g.lspTimeoutConfig = {
+            -- see config below
             }
         end
     }
@@ -65,8 +62,8 @@ Packer:
           "hinell/lsp-timeout.nvim",
           requires={ "neovim/nvim-lspconfig" },
           setup = function()
-            vim.g["lsp-timeout-config"] = {
-                -- 
+            vim.g.lspTimeoutConfig = {
+            -- see config belos 
             }
           end
         })
@@ -87,16 +84,27 @@ CONFIGURATION                                      *lsp-timeout-configuration*
 
 
 >lua
-    vim.g["lsp-timeout-config"] = {
+    vim.g.lspTimeoutConfig = {
         stopTimeout  = 1000 * 60 * 5, -- ms, timeout before stopping all LSPs 
         startTimeout = 1000 * 10,     -- ms, timeout before restart
         silent       = false          -- true to suppress notifications
+        filetypes    = {
+            ignore = {                -- filetypes to ignore; empty by default
+                                      -- lsp-timeout is disabled completely
+            }                         -- for these filetypes
+        }
+    }
+    
+    -- Buffer local configuration; overrides global
+    bufnr = vim.api.nvim_get_current_buf() 
+    vim.b[bufnr].lspTimeoutConfig = {
+        -- ..
     }
 <
 >lua
-    -- Optionally, validate config
+    -- Optionally, validate the config
     local Config = require("lsp-timeout.config").Config
-          Config:new(vim.g["lsp-timeout-config"]):validate()
+          Config:new(vim.g.lspTimeoutConfig):validate()
 <
 
 
@@ -125,23 +133,25 @@ TROUBLESHOOTING PLUGINS                  *lsp-timeout-troubleshooting-plugins*
   fail if they don't hook into |LspAttach| or |LspDetach| events or
   `vim.lsp.get_clients(...)` properly
 * Some LSP servers may misbehave upon restart if they don't keep cache
-* Some LSP plugins may hook into serveral LSPs and fail upon restart
+* Some LSP plugins may hook into serveral LSPs at the same time and fail upon
+  restart
 * See also: https://github.com/neovim/nvim-lspconfig#troubleshooting
 Plugins that are known to misbehave:
 
-* **null-ls**: fails to startup, replace by `efm-languageserver` or use
+* **null-ls** and **none-ls**: 
+as of v1.2.0 should work properly; if
+  didn't, replace by `efm-languageserver` or run `:e` upon focusing or use
   workaround, 
-see
+see:
   https://github.com/hinell/lsp-timeout.nvim/issues/7#issuecomment-1764402683
 * **efm-languageserver**: 
 make sure that `filetypes` are specified in the
   setup config 
 see:
   https://github.com/neovim/nvim-lspconfig/blob/master/doc/server_configurations.md#efm
-* **barbecue.nvim**: 
-**nvim-navic**: 
+* **barbecue.nvim** and **nvim-navic**: 
 you have to attach `navic.nvim`
-  to one specific LSP; avoid attaching it to generic (e.g. efmls) LSPs:
+  to one specific LSP; avoid attaching it to generic ones (e.g. efmls):
 
 see: https://github.com/utilyre/barbecue.nvim
 >lua
@@ -153,6 +163,13 @@ see: https://github.com/utilyre/barbecue.nvim
         end
       end,
 <
+* **pmizio/typescript-tools.nvim**: 
+run
+  `lspconfig["typescript-tools"].setup({ filetypes = })` 
+make sure that
+  `filetypes` are specified in the setup config 
+see:
+  https://github.com/hinell/lsp-timeout.nvim/issues/12#issuecomment-1779750062
 September 26, 2023
 Copyright  - Alexander Davronov, et.al.