feat(v1.1.0): release

Author: hinell

.github/ISSUE_TEMPLATE/config.yml

@@ -1,5 +1,4 @@
 blank_issues_enabled: false
-contact_links:
-  - name: Contact
-    url: mailto:al.neodim@gmail.com
-    about: For any suggestions or questions send email to
+  - name: Question
+    url: ../../discussions
+    about: Please create a GitHub Discussion for general questions

.github/ISSUE_TEMPLATE/issue-bug.yml

@@ -1,31 +1,32 @@
 name: Bug Report
 description: File a bug report
-title: "New bug report"
-labels: ["untriaged"]
+title: "Bug report"
+labels: ["bug"]
 assignees:
   - hinell
-body: 
+body:
   - type: textarea
     id: issue-summary
     attributes:
       label: Summary
-      placeholder: "Be brief"
-      value: "."
+      placeholder: "Be brief, time is invaluable commodity that only few can afford"
     validations:
       required: true
   - type: textarea
     id: issue-repro
     attributes:
       label: Steps to reproduce
-      placeholder: Snippet of code 
-      value: "."
+      placeholder: Specify how to reproduce issue if there are any ways
     validations:
       required: false
   - type: textarea
     id: issue-env
     attributes:
       label: Versions
-      placeholder: "Specify all relevant VERSIONS"
-      value: "."
+      placeholder: |
+        Specify all relevant VERSIONS and commits, e.g.:
+        NVIM v0.10.0-dev-ac1c23442f
+        Build type: MinSizeRel
+        LuaJIT 2.1.0-beta3
     validations:
       required: false

.github/ISSUE_TEMPLATE/issue-feature.yml

@@ -1,17 +1,15 @@
 # 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"
-title: "New feature request"
-labels: ["untriaged"]
+labels: ["enhancement"]
 assignees:
   - hinell
-body: 
+body:
   - type: markdown
     attributes:
-      value: "Checkout DISCUSSIONS page first and fill this requestion there! See also [CONTRIBUTING.md](./../blob/main/CONTRIBUTING.md)"
+      value: "Please, see [CONTRIBUTING.md](../blob/main/CONTRIBUTING.md) first, then, checkout [DISCUSSIONS](../discussions)"
   - type: textarea
     id: feature-summary
     attributes:
       label: Summary
-      placeholder: "Be brief"
-      value: "."
+      placeholder: "Be brief, time is invaluable commodity that only few can afford"

.github/pull_request_template.md

@@ -0,0 +1,8 @@
+### LEGAL
+- [ ] I've read the [CONTRIBUTING.md](../blob/main/CONTRIBUTING.md) and I'm fully aware of the terms
+- [ ] I've read the [LICENSE](../blob/main/LICENSE) and fully accept the terms and waive my rights over this contribution
+
+### SUMMARY
+
+### CONTEXT
+- [ ] I've [DISCUSSED](../discussions) this proposal or feature earlier

.luarc.json

@@ -1,6 +1,6 @@
 {
 	"schema": "https://raw.githubusercontent.com/sumneko/vscode-lua/master/setting/schema.json",
-	"runtime": [ "" ],
+	"runtime": [ "lua/?.lua" ],
 	"workspace.library": [ "/usr/local/share/nvim/runtime/lua" ],
 	"format.enable": false,
 	"workspace.checkThirdParty": false

CONTRIBUTING.md

@@ -1,14 +1,19 @@
 # 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 don't trying to commercialize it, but it is NOT open to contribution. In order to keep this library in the public domain and ensure that the code does not become contaminated with proprietary or 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 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.
+
 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.
- 
-> **NOTE**: [SQLite Disclaimer](https://www.sqlite.org/copyright.html)</br>
-> **NOTE**: [Open Source is Not About You](https://gist.github.com/richhickey/1563cddea1002958f96e7ba9519972d9)
- 
-### [Development](./DEVELOPMENT.md)
+
+If your contribution ever accepted, then:
+* You waive 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)
 
 ----
 September 15, 2023</br>
-Copyright © 2023 - Alexander Davronov, et.al.<br>
+Copyright © 2023 - Alexander Davronov (a.k.a. github@hinell), et.al.<br>

DEVELOPMENT.md

@@ -8,13 +8,22 @@ This project is developed by using various developer tools. For runtime dependen
 
 [Neovim]: https://github.com/neovim/neovim
 
-> _See also: .md files in \`src/\` folder._ 
-## GIT WORKFLOW
-It's highly likely that this project is going to be
-[force-pushed](https://git-scm.com/docs/git-push#Documentation/git-push.txt)
-and aggressively [squash-rebased](https://git-scm.com/docs/git-rebase) into specific semver versions.
-Take into account this fact when making a PR: it is likely render your
-base-commits obsolete.
+## GIT WORKLOW & CONVENTIONS
+* This project's history is going to be aggressively [force-pushed](https://git-scm.com/docs/git-push#Documentation/git-push.txt) and [squash-rebased](https://git-scm.com/docs/git-rebase) into a specific [semver] versions
+* The said versions might be later revised, dropped or removed (unless specific package manager doesn't allow version replacement).
+* This implies that any [upstream] commits pulled may become obsolete
+
+#### Tags naming conventions:
+* `latest` - latest released version
+* `vX.Y.Z`  - version, per [semver]
+* `nighlty` - testing build
+
+#### Branch naming convention
+* `main` - main dev branch
+* `release/X.Y.Z` - next release; tightly coupled to `main`
+
+[semver]: https://github.com/semver/semver 'Semantic version'
+[upstream]: https://docs.github.com/en/get-started/quickstart/github-glossary#upstream 'Gighub glossary: upstream'
 
 ## BUILD
 ### Dev dependencies

Makefile

@@ -8,9 +8,10 @@ doc/tags: doc/$(PROJECT_NAME).txt
 	@$(NVIM) --headless -c "helptags doc/" -c "exit"
 
 # ts-vimdoc generate vimhelp from markdown 
+.SILENT:
 .ONESHELL:
 doc/$(PROJECT_NAME).txt: doc/index.md
-	@$(NVIM) --headless -E -c "
+	$(NVIM) --headless -E -c "
 		lua require('ts-vimdoc').docgen({
 			input_file='doc/index.md',
 			output_file = '$@',
@@ -25,4 +26,5 @@ doc/$(PROJECT_NAME).txt: doc/index.md
 		> /dev/stderr;
 	}
 	test -f $< && unicode-emoji-remove.sh -i $@
-	sed -E -i -e 's/<\/br>\s*/\n/' $@
+	# strip <br> tags
+	sed -i -E -e 's/<\/?br\/?>\s*/\n/g' $@ 

README.md

@@ -3,8 +3,9 @@
 <div align="center">
   <h1 align="center">🔌  lsp-timeout.nvim</h2>
 </div>
-<img width="100%" src="doc/preview.png" />
 
+<!-- <img width="100%" src="doc/preview.png" /> -->
+https://github.com/hinell/lsp-timeout.nvim/assets/8136158/92e30089-192f-4c75-8bec-85ca36a2c06c
 
 <!-- Use badges from https://shields.io/badges/ -->
 [![PayPal](https://img.shields.io/badge/-PayPal-880088?style=flat-square&logo=pay&logoColor=white&label=DONATE)](https://www.paypal.me/biteofpie)

doc/RELEASE

@@ -0,0 +1,11 @@
+* 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

doc/index.md

@@ -1,10 +1,15 @@
 ## OVERVIEW
-Nvim plugin for nvim-lspconfig: stop idle servers & restart upon gaining or loosing focus;
-keep your RAM usage low;
 
+Nvim plugin for nvim-lspconfig: stop idle servers & restart upon gaining focus;
+keeps RAM usage low
+
+**Default behavior**:
+* Tabpages and windows inside - are traversed & checked for LSPs
+* The |'diff'| windows and |'readonly'| buffers are ignored - `lsp-timeout` takes no action
+* On focused writable windows (cursor put on) `lsp-timeout` finds and restarts available LSPs 
 
 ## INSTALL
-Use your favorite package manager (Packer, Plug, Lazy.nvim etc.)
+Use your favorite package manager (Packer, Plug, Lazy.nvim etc.); it's advised to use`latest` tag
 
 ```
 "hinell/lsp-timeout.nvim"
@@ -13,9 +18,27 @@ Use your favorite package manager (Packer, Plug, Lazy.nvim etc.)
 Prerequisites:
 
 * Neovim v0.7.2+
-* `"neovim/nvim-lspconfig"`
+* 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"] = {
+        -- 
+        }
+    end
+}
+```
+
+> **WARNING**
+> Packer.nvim is archived
 
-E.g. for packer:
+Packer:
 ```lua
 -- $HOME/.config/nvim/lua/user/init.lua
 -- Don't forget to run :PackerCompile
@@ -32,48 +55,70 @@ packer.setup(function(use)
 end)
 ```
 
-Lazy.nvim:
-
-```lua
-{
-    "hinell/lsp-timeout.nvim",
-    dependencies={ "neovim/nvim-lspconfig" },
-    init = function()
-        vim.g["lsp-timeout-config"] = {
-        -- 
-        }
-    end
-}
-```
-
 ## UPDATE
 
-You may want to reinstall this plugin manually because of specific dev-approach:
-repo of this plugin may be force-pushed & force-rebased,
-rendering all previous commits obsolete; read DEVELOPMENT.md for more info
+Repo of this plugin may be force-pushed & force-rebased,
+rendering all previous commits obsolete so manual updates are advised;
+See DEVELOPMENT.md for more info.
 
 <!-- ## API -->
 ## CONFIGURATION
 ```lua
 vim.g["lsp-timeout-config"] = {
-    stopTimeout  = 1000 * 60 * 5,  -- ms, timeout before stopping all LSP servers
-    startTimeout = 1000 * 10,      -- ms, timeout before restart
-    silent       = false           -- true to suppress notifications
+    stopTimeout  = 1000 * 60 * 5, -- ms, timeout before stopping all LSPs 
+    startTimeout = 1000 * 10,     -- ms, timeout before restart
+    silent       = false          -- true to suppress notifications
 }
 ```
 
+```lua
+-- Optionally, validate config
+local Config = require("lsp-timeout.config").Config
+      Config:new(vim.g["lsp-timeout-config"]):validate()
+```
+
+### Augroups
+
+Plugin setups two augroups:
+* `LSPTimeout` - global augroup for various events 
+* `LSPTimeoutBufferLocal` - buffer-local groups, temporary 
+
 ### TROUBLESHOOTING
 
-> **Note** IF SOME PLUGIN FAILED BECAUSE OF STOPPED LSP, PLEASE, FILL AN ISSUE IN THE RESPECTIVE PLUGIN REPO
+> **Note**
+> IF SOME PLUGIN FAILED BECAUSE OF STOPPED LSP, PLEASE, FILL AN ISSUE IN A RESPECTIVE PLUGIN REPO
+
+* Run `LspInfo` to find (in)active LSPs
+* Use `map <...>` to check what keymaps are setup/lost upon restart 
+* If you hook into |LspAttach| and |LspDetach| events, make sure to store & clean up buffer-local variables or keymaps only once per every cycle
 
-* Some LSP servers which don't keep cache on hdd may fail.
-* Some plugins that require active LSP servers like those used for signs may also fail:
-if they don't hook into |LspAttach| or |LspDetach| events or if they don't use `vim.lsp.get_clients(...)`. 
+#### 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  
+* See also: https://github.com/neovim/nvim-lspconfig#troubleshooting
 
-#### null-ls
+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
 
-Please, 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:
+<br/>see: https://github.com/utilyre/barbecue.nvim 
+```lua
+require("lspconfig")[serverName].setup({
+  on_attach = function(client, bufnr)
+    -- ...
+    if client.server_capabilities["documentSymbolProvider"] then
+      require("nvim-navic").attach(client, bufnr)
+    end
+  end,
+```
 
 <!-- ## EXAMPLES -->
 <!-- ## KEYBINDINGS -->