feat(#579): add selene support

.github/workflows/default.yml

@@ -66,3 +66,16 @@ jobs:
 
       - name: Lint
         run: sudo make lint
+
+  selene:
+    name: Selene
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v2
+
+      - name: Run selene
+        uses: NTBBloodbath/[email protected]
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          args: --display-style quiet lua/plenary --allow-warnings

Makefile

@@ -1,4 +1,4 @@
-.PHONY: test generate_filetypes lint luarocks_upload test_luarocks_install
+.PHONY: test generate_filetypes lint lint-selene luarocks_upload test_luarocks_install
 test:
 	nvim --headless --noplugin -u scripts/minimal.vim -c "PlenaryBustedDirectory tests/plenary/ {minimal_init = 'tests/minimal_init.vim', sequential = true}"
 
@@ -10,3 +10,6 @@ generate_luassert_types:
 
 lint:
 	luacheck lua/plenary
+
+lint-selene:
+	selene --display-style quiet lua/plenary --allow-warnings

neovim.yml

@@ -0,0 +1,33 @@
+---
+base: lua51
+
+globals:
+  _:
+    any: true
+  a:
+    any: true
+  jit:
+    any: true
+  bit:
+    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,17 @@
+std="neovim"
+
+exclude = [
+  "lua/plenary/profile/lua_profiler.lua",
+  "lua/plenary/profile/memory_profiler.lua",
+  "lua/plenary/profile/p.lua", # token `goto` detected as `parse_error`
+  "lua/plenary/async_lib/*.lua",
+]
+
+[rules]
+global_usage = "warn"
+deprecated = "warn" # If change for `allow` it will rely in `lua_ls` diagnostics alone
+multiple_statements = "warn"
+incorrect_standard_library_use = "allow" # This is for cases like `string.format`, `package.config`, etc.
+mixed_table = "allow"
+unused_variable = "warn"
+undefined_variable = "warn"