feat(#96): improve DX (#97)

* feat(#96): added linting, formatting and diagnostics rules

* fix(#96): applied formatting and linting rules

Author: AlejandroSuero

.editorconfig

@@ -0,0 +1,23 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+charset = utf-8
+end_of_line = lf
+trim_trailing_whitespace = true
+insert_final_newline = true
+max_line_length = 120
+
+[*.yml]
+indent_style = space
+indent_size = 2
+
+# This makes it a lot less painful to write YAMLs in docs
+[*.md]
+indent_style = space
+indent_size = 2
+
+[Makefile]
+indent_style = tab
+indent_size = 4

.luarc.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://raw.githubusercontent.com/LuaLS/vscode-lua/master/setting/schema.json",
+  "diagnostics": {
+    "unusedLocalExclude": ["_*"]
+  }
+}

Makefile

@@ -0,0 +1,23 @@
+GREEN="\033[00;32m"
+RESTORE="\033[0m"
+
+# makes the output of the message appear green
+define style_calls
+	$(eval $@_msg = $(1))
+	echo ${GREEN}${$@_msg}
+	echo ${RESTORE}
+endef
+
+lint:
+	@$(call style_calls,"Linting lua files")
+	@selene --display-style quiet --config ./selene.toml lua/llm
+	@$(call style_calls,"Running stylua check")
+	@stylua --color always -f ./.stylua.toml --check .
+	@$(call style_calls,"Done!")
+
+format:
+	@$(call style_calls,"Running stylua format")
+	@stylua --color always -f ./.stylua.toml .
+	@$(call style_calls,"Done!")
+
+.PHONY: lint format

lua/llm/completion.lua

@@ -68,7 +68,7 @@ function M.schedule()
 end
 
 function M.lsp_suggest()
-  M.request_id = llm_ls.get_completions(function(err, result, context, config)
+  M.request_id = llm_ls.get_completions(function(err, result, context, _conf)
     if err ~= nil then
       vim.notify("[LLM] " .. err.message, vim.log.levels.ERROR)
       return

lua/llm/language_server.lua

@@ -36,7 +36,7 @@ local function build_binary_name()
     elseif linux_distribution == "raspbian" then
       arch_map.armv7l = "arm"
       os_map.Linux = "unknown-linux-gnueabihf"
-    else
+      -- else
       -- Add mappings for other distributions as needed
     end
   end

neovim.yml

@@ -0,0 +1,27 @@
+---
+base: lua51
+
+globals:
+  jit:
+    any: true
+  vim:
+    any: true
+  assert:
+    args:
+      - type: bool
+      - type: string
+        required: false
+  after_each:
+    args:
+      - type: function
+  before_each:
+    args:
+      - type: function
+  describe:
+    args:
+      - type: string
+      - type: function
+  it:
+    args:
+      - type: string
+      - type: function

selene.toml

@@ -0,0 +1,10 @@
+std="neovim"
+
+[rules]
+global_usage = "warn"
+deprecated = "warn" # If changed to `allow` it will rely on `lua_ls` diagnostics.
+multiple_statements = "allow"
+incorrect_standard_library_use = "allow" # This is for cases like `string.format`, `package.config`, etc.
+mixed_table = "allow"
+unused_variable = "warn"
+undefined_variable = "warn"