diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2021-09-20 19:00:50 -0700 |
|---|---|---|
| committer | Justin M. Keyes <justinkz@gmail.com> | 2023-01-05 17:10:02 +0100 |
| commit | 7c94bcd2d77e2e54b8836ab8325460a367b79eae (patch) | |
| tree | 454e637f46ed74202e97bcc8f5eb6d8118cddcf9 /CONTRIBUTING.md | |
| parent | 39d70fcafd6efa9d01b88bb90cab81c393040453 (diff) | |
| download | rneovim-7c94bcd2d77e2e54b8836ab8325460a367b79eae.tar.gz rneovim-7c94bcd2d77e2e54b8836ab8325460a367b79eae.tar.bz2 rneovim-7c94bcd2d77e2e54b8836ab8325460a367b79eae.zip | |
feat(lua)!: execute Lua with "nvim -l"
Problem:
Nvim has Lua but the "nvim" CLI can't easily be used to execute Lua
scripts, especially scripts that take arguments or produce output.
Solution:
- support "nvim -l [args...]" for running scripts. closes #15749
- exit without +q
- remove lua2dox_filter
- remove Doxyfile. This wasn't used anyway, because the doxygen config
is inlined in gen_vimdoc.py (`Doxyfile` variable).
- use "nvim -l" in docs-gen CI job
Examples:
$ nvim -l scripts/lua2dox.lua --help
Lua2DoX (0.2 20130128)
...
$ echo "print(vim.inspect(_G.arg))" | nvim -l - --arg1 --arg2
$ echo 'print(vim.inspect(vim.api.nvim_buf_get_text(1,0,0,-1,-1,{})))' | nvim +"put ='text'" -l -
TODO?
-e executes Lua code
-l loads a module
-i enters REPL _after running the other arguments_.
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1942ff51f7..d0af90d679 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -116,10 +116,7 @@ Each pull request must pass the automated builds on [Cirrus CI] and [GitHub Acti - CI builds are compiled with [`-Werror`][gcc-warnings], so compiler warnings will fail the build. -- If any tests fail, the build will fail. - See [test/README.md#running-tests][run-tests] to run tests locally. - Passing locally doesn't guarantee passing the CI build, because of the - different compilers and platforms tested against. +- If any tests fail, the build will fail. See [test/README.md#running-tests][run-tests] to run tests locally. - CI runs [ASan] and other analyzers. - To run valgrind locally: `VALGRIND=1 make test` - To run Clang ASan/UBSan locally: `CC=clang make CMAKE_FLAGS="-DCLANG_ASAN_UBSAN=ON"` @@ -127,6 +124,8 @@ Each pull request must pass the automated builds on [Cirrus CI] and [GitHub Acti neighbors_, to encourage incrementally updating the legacy style to meet our [style](#style). (See [#3174][3174] for background.) - CI for FreeBSD runs on [Cirrus CI]. +- To see CI results faster in your PR, you can temporarily set `TEST_FILE` in + [ci.yml](https://github.com/neovim/neovim/blob/e35b9020b16985eee26e942f9a3f6b045bc3809b/.github/workflows/ci.yml#L205). ### Clang scan-build |