aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--.gitignore1
-rw-r--r--CONTRIBUTING.md5
-rw-r--r--contrib/luarc.json23
3 files changed, 29 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
index e07ce4906e..0988a51cd9 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,6 +1,7 @@
# Tools
/venv/
compile_commands.json
+/.luarc.json
# IDEs
/.vs/
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index e9c1173007..a3bfa06cfb 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -244,6 +244,10 @@ You can lint a single file (but this will _not_ exclude legacy errors):
("Exuberant ctags", the typical `ctags` binary provided by your distro, is
unmaintained and won't recognize many function signatures in Neovim source.)
- Explore the source code [on the web](https://sourcegraph.com/github.com/neovim/neovim).
+- If using [lua-language-server][], symlink `contrib/luarc.json` into the
+ project root:
+
+ $ ln -s contrib/luarc.json .luarc.json
Reviewing
@@ -288,3 +292,4 @@ as context, use the `-W` argument as well.
[pr-draft]: https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request
[pr-ready]: https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request
[uncrustify]: https://formulae.brew.sh/formula/uncrustify
+[lua-language-server]: https://github.com/sumneko/lua-language-server/
diff --git a/contrib/luarc.json b/contrib/luarc.json
new file mode 100644
index 0000000000..770b023ac6
--- /dev/null
+++ b/contrib/luarc.json
@@ -0,0 +1,23 @@
+{
+ "runtime.version": "LuaJIT",
+ "diagnostics": {
+ "enable": true,
+ "globals": [
+ "vim",
+ "describe",
+ "it",
+ "before_each",
+ "after_each",
+ "setup",
+ "teardown"
+ ]
+ },
+ "workspace": {
+ "library": {
+ "runtime/lua": true
+ },
+ "maxPreload": 2000,
+ "preloadFileSize": 1000
+ },
+ "telemetry.enable": false
+}