feat: use nvim -l to run lua build scripts

.github/workflows/CI.yml

@@ -17,16 +17,11 @@ jobs:
  with:
  ref: ${{ github.head_ref }}
 
- - name: Install lua
- uses: leafo/gh-actions-lua@v10
+ - name: Install neovim
+ uses: rhysd/action-setup-vim@v1
  with:
- luaVersion: "luajit-2.1.0-beta3"
-
- - name: Install luarocks
- uses: leafo/gh-actions-luarocks@v4
+ neovim: true
 
- - name: Install inspect
- run: luarocks install inspect
 
  - name: Generate types
  run: make types
@@ -37,6 +32,7 @@ jobs:
  file_pattern: lua/crates/config/types.lua
  commit_message: "chore: generate types"
 
+
  - name: Generate docs
  run: make doc
 
@@ -52,15 +48,6 @@ jobs:
  with:
  path: docgen/wiki
 
- test:
- runs-on: ubuntu-latest
- steps:
- - uses: actions/checkout@v4
-
- - name: Install neovim
- uses: rhysd/action-setup-vim@v1
- with:
- neovim: true
 
  - name: Install plenary.nvim
  uses: actions/checkout@v4
@@ -71,4 +58,3 @@ jobs:
  - name: Run tests
  run: make test
  timeout-minutes: 1
-

CONTRIBUTING.md

@@ -43,15 +43,6 @@ make test
 
 ## Writing Documentation
 
-### Requirements
-- [Luarocks](https://luarocks.org/)
- - macos: `brew install luarocks`
- - fedora: `dnf install luarocks`
- - ubuntu: `apt install luarocks`
- - arch: `pacman -S install luarocks`
-- [Inspect](https://github.com/kikito/inspect.lua)
- - `luarocks install inspect`
-
 > [!IMPORTANT]
 > Do not edit the `README.md`, `doc/crates.txt` or wiki files.\
 > They are automatically generated.

Makefile

@@ -1,12 +1,12 @@
 .PHONY: types
 types:
- ./scripts/gen_types.lua
+ nvim -l scripts/gen_types.lua
 
 .PHONY: test
 test:
  nvim --headless --noplugin -u test/minimal.vim -c "lua require(\"plenary.test_harness\").test_directory_command('test {minimal_init = \"test/minimal.vim\"}')"
 
 .PHONY: doc
 doc:
- ./docgen/gen_doc.lua
+ nvim -l docgen/gen_doc.lua
 

docgen/gen_doc.lua

@@ -3,7 +3,6 @@ _=[[
 exec lua "$0" "$@"
 ]]
 
-local inspect = require("inspect")
 local config = require("lua.crates.config.init")
 local highlight = require("lua.crates.highlight")
 local version = "unstable"
@@ -313,7 +312,7 @@ local function gen_vimdoc_config(lines, path, schema)
  table.insert(lines, "")
  else
  local t = s.type.emmylua_annotation
- local d = s.default_text or inspect(s.default)
+ local d = s.default_text or vim.inspect(s.default)
  table.insert(lines, string.format(" Type: `%s`, Default: `%s`", t, d))
  table.insert(lines, "")
  end
@@ -352,7 +351,7 @@ local function gen_def_config(lines, indent, path, schema)
  gen_def_config(lines, indent, p, s.fields)
  insert_indent("},")
  else
- local d = s.default_text or inspect(s.default)
+ local d = s.default_text or vim.inspect(s.default)
  insert_indent(string.format("%s = %s,", name, d))
  end
  end