feat(v1.3.0): release

* refactor(github): templates
* (fix) add missing comma to example conf
Donated by Lucas Parry <[email protected]>
* chore(*): formatting; minor typo
* feat(tests): basic testing harness; few config test
* refactor(doc): convert mk to Makfile in doc/
* feat(config): enable/disable via vim.g.lspTimeoutLoade
* ci(*): brief PR template; minor refacto
* refactor(make): better make structutr
* chore(*): update git & tools dotfile
* test(*): minor updat
* docs(*): formattin
* fix: typo and extra word in `README.md`
Closes: #18
* chore(*): update hooks, lua_ls, tests, tools
* feat(checkheatlh): support checkhealth

Author: hinell

.gitattributes

@@ -8,7 +8,8 @@
 *.mp3 binary diff=
 *.mp4 binary diff=
 *.mov binary diff=
+*.ogv binary diff=
+*.mkv binary diff=
 *.xcf binary diff=
 *.zip binary diff=
 *.tar.gz binary diff=
-

.githooks/pre-commit

@@ -0,0 +1,10 @@
+#!/usr/bin/bash
+
+# building docs 
+make -sr -C doc/ all
+git add doc/
+source "$(dirname ${0})/pre-commit.no-logs"
+no_logs '^[[:space:]]*print(?' tests/**/*.lua # lua: disallow print() expressions 
+no_logs '^[[:space:]]*print(?' lua/**/*.lua # lua: disallow print() expressions 
+# disallow logs end
+# hook end

.githooks/pre-commit.no-logs

@@ -0,0 +1,49 @@
+#!/usr/bin/env -S bash
+# File........: pre-commit.check-logs
+# Summary.....: Abort committing if logging expressions are found in source files
+# Created.....: December 07, 2023
+# Authors.....: Alex A. Davronov <[email protected]> (2023-)
+# Usage.......: Import by using `source` (or `.`) in a shellscript:
+# source "\$(dirname \${0})/pre-commit.no-logs"
+# # JavaScript
+# no_logs '^[[:space:]]*console.log\(.*'
+# no_logs '^[[:space:]]*debug' src/**/*.{js,ts}
+# # C/C++
+# no_logs '^[[:space:]]*printf\(?.*' src/**/*.cc
+# no_logs '^[[:space:]]*(std)?::cout[[:space:]]*<<.*' src/**/*.cc
+# # Lua
+# no_logs '^[[:space:]]*print\(?.*vim.inspect\(?.*' lua/**/*.lua
+# # Shell
+# no_logs '^[[:space:]]*declare\s*-p\s*.*' **/*.{sh,zsh,bash}
+
+## Returns non-zero if specified files contain given string
+## @param check_string
+## @param  ... files
+no_logs(){
+	local _CTX="pre-commit.no-logs"
+	local _REG=${1:? string (.e.g "console.log") is required}
+	shift
+
+	local _FILES=()
+	local  _GIT_FILES=($(git di --staged --name-only --diff-filter=CRAM))
+	# only pickup what was staged so for
+	for file in ${@}; do
+		for file_staged in ${_GIT_FILES[@]};
+		do
+			[[ "${file}" =~ "${file_staged}" ]] && _FILES+=("$file")
+		done
+	done
+	(( ${#_FILES[@]} == 0 )) && { return 0; };
+	local _GRP=$(grep --color=always -n -s -E "${_REG}" ${_FILES[@]} )
+	# printf "${_CTX} checking for ${_REG}... "
+	if [[ -n ${_GRP} ]] ;
+	then
+		printf "\n${_GRP}\n"
+		printf "${_CTX}:$(tput setaf 1)error$(tput sgr0): ${_REG} - logs are likely not needed. Aborting.\n" >&2 ;
+		exit 1
+	# else
+	# 	printf "\n${0}:$(tput setaf 2) ok ✔$(tput sgr0)\n"
+	fi
+}
+
+# ex: ft=bash

.githooks/setup.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/bash
+echo -en "$0: configuring git... "
+git config core.hooksPath ".githooks"
+echo -e "$(tput setaf 2)done!$(tput op)"

.github/ISSUE_TEMPLATE/issue-bug.yml

@@ -8,7 +8,7 @@ body:
   - type: checkboxes
     id: issue-trouble-is-read
     attributes:
-      label: I've read TROUBLESHOOTING instructions
+      label: I've read TROUBLESHOOTING](../blob/main/doc/index.md#TROUBLESHOOTING) instructions
       options:
         - label: "Yes"
           required: true
@@ -26,6 +26,13 @@ body:
       placeholder: Specify how to reproduce issue if there are any ways
     validations:
       required: false
+  - type: textarea
+    id: issue-checkhealth 
+    attributes:
+      label: checkhealth output
+      placeholder: Run `checkhealth lsp-timeout` and paste
+    validations:
+      required: true 
   - type: textarea
     id: issue-env
     attributes:
@@ -44,9 +51,9 @@ body:
       options:
         - Linux/Debian/Ubuntu
         - Linux/Debian/Kubuntu
-        - Linux / Other
-        - Archlinux
-        - NixOS
+        - Linxu/Archlinux
+        - Linux/NixOS
+        - Linux/Other
         - MacOS
         - Windows
         - Windows WSL

.github/pull_request_template.md

@@ -1,8 +1,7 @@
-! MERGE AGAINST `DEV` BRANCH, NOT `MAIN`
-
 ### LEGAL & CONTEXT
+- [ ] I'M MERGING AGAINST `DEV` BRANCH
 - [ ] 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
-- [ ] I've [DISCUSSED](../discussions) this proposal or feature earlier (optional)
+- [ ] I've [DISCUSSED](../discussions) this earlier or have opened an issue (optional)
 
 ### SUMMARY

.github/workflows/tests.yml .github/workflows/test-lua.yml.github/workflows/tests.yml renamed to .github/workflows/test-lua.yml

@@ -1,9 +1,12 @@
 name: dev
 on: 
-  # Trigger worfklow when branch or tags are pushed
   push:
     branches:
       - dev
+    paths:
+      - "lua/**"
+      - "plugin/**"
+      - "tests/**"
   pull_request:
     branches: [ "dev", "main" ]
     paths:
@@ -14,11 +17,18 @@ jobs:
   tests:
     name: Run ALL lua tests 
     runs-on: ubuntu-latest
+    defaults:
+      run:
+        shell: bash
     steps:
       - name: Checkout git repository
         uses: actions/checkout@v4
       - name: Run tests
         shell: bash
-        # CONTINUE: [November 01, 2023] Provide basic testing workflow 
         run: |
-            make -sR -C tests/
+          git branch --show-current
+          # Only four versions are tested:
+          # v0.7.2 v0.8.3 v0.9.2 nightly
+          # They are setup by NEOVIM_VERSIONS
+          # Testing is done incrementally
+          make -sR tests/

.gitignore

@@ -10,7 +10,8 @@ out/
 dist/
 .dist/
 .git/
+# nvim
+.vim/
+.nvim/
 # node.js
 node_modules/
-# scaffold tooling
-.scaffoldrc

.gitmodules

@@ -1,7 +1,44 @@
 {
-	"schema": "https://raw.githubusercontent.com/sumneko/vscode-lua/master/setting/schema.json",
-	"runtime": [ "lua/?.lua" ],
-	"workspace.library": [ "/usr/local/share/nvim/runtime/lua" ],
-	"format.enable": false,
-	"workspace.checkThirdParty": false
+  "$schema": "https://raw.githubusercontent.com/sumneko/vscode-lua/master/setting/schema.json",
+  "runtime": {
+    "version": "LuaJIT",
+    "path": [
+      "lua/?.lua",
+      "lua/?/init.lua",
+      "/usr/local/share/nvim/runtime/lua/?.lua"
+
+    ]
+  },
+  "workspace": {
+    "library": [
+      "/usr/local/share/nvim/runtime/lua/vim/_meta/vimfn.lua",
+      "/usr/local/share/nvim/runtime/lua/vim/_options.lua",
+      "/usr/local/share/nvim/runtime/lua/vim/_meta/api.lua",
+      "/usr/local/share/nvim/runtime/lua/vim/_meta/vvars.lua",
+      "/usr/local/share/nvim/runtime/lua/vim/_meta/vvars_extra.lua",
+      "/usr/local/share/nvim/runtime/lua/vim/_meta/lpeg.lua",
+      "/usr/local/share/nvim/runtime/lua/vim/_meta/builtin.lua",
+      "/usr/local/share/nvim/runtime/lua/vim/_meta/builtin_types.lua",
+      "/usr/local/share/nvim/runtime/lua/vim/_meta/api_keysets.lua",
+      "/usr/local/share/nvim/runtime/lua/vim/_meta/api_keysets_extra.lua",
+      "/usr/local/share/nvim/runtime/lua/vim/_meta/base64.lua",
+      "/usr/local/share/nvim/runtime/lua/vim/_meta/diff.lua",
+      "/usr/local/share/nvim/runtime/lua/vim/_meta/regex.lua",
+      "/usr/local/share/nvim/runtime/lua/vim/_meta.lua",
+      "$HOME/.local/share/nvim/lazy/plenary.nvim/"
+    ],
+    "checkThirdParty": false,
+    "userThirdParty": [
+    ]
+  },
+  "diagnostics": {
+    "globals": [
+      "vim"
+    ],
+    "disable": [
+      "unused-local",
+      "unused-vararg"
+    ]
+  },
+  "format.enable": false
 }