Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify Common Errors #23

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Clarify Common Errors #23

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bc10c73
Improve documentation on common errors
PLAZMAMA Jan 8, 2025
0ca53e8
update footnote
PLAZMAMA Jan 8, 2025
13fd65f
Improve common errors section formatting
PLAZMAMA Jan 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 26 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@ Running tests requires either

to be installed[^1].

[^1]: The test suite assumes that `nlua` has been installed
using luarocks into `~/.luarocks/bin/`.
[^1]: The test suite assumes that `nlua` has
been added to the PATH.

You can then run:

Expand All @@ -74,15 +74,34 @@ luarocks test spec/path_to_file.lua --local
busted spec/path_to_file.lua
```

If you see an error like `module 'busted.runner' not found`:
### Common Errors

If you encounter the `module 'busted.runner' not found`
or `pl.path requires LuaFileSystem` errors, fix it by
runing the following command the following command:

```bash
eval $(luarocks path --no-bin)
```

For this to work you need to have Lua 5.1 set as your default version for
luarocks. If that's not the case you can pass `--lua-version 5.1` to all the
luarocks commands above.
If you encounter `sh: nlua: command not found` error the error above occurs do[^1]:

#### Linux/Max

Run the following command:
```bash
export PATH=$PATH:~/.luarocks/bin
```

#### Windows

See the following guide to a variable to the PATH: [add to PATH][add-env-vars-windows].

> [!Note]
> For local testing to work you need to have Lua 5.1 set as your default version for
> luarocks. If that's not the case you can pass `--lua-version 5.1` to all the
> luarocks commands above, or set lua version 5.1 globally by running
> `luarocks config --scope system lua_version 5.1`.

[rockspec-format]: https://github.com/luarocks/luarocks/wiki/Rockspec-format
[luarocks]: https://luarocks.org
Expand All @@ -91,3 +110,4 @@ luarocks commands above.
[busted]: https://lunarmodules.github.io/busted/
[nlua]: https://github.com/mfussenegger/nlua
[use-this-template]: https://github.com/new?template_name=nvim-lua-plugin-template&template_owner=nvim-lua
[add-env-vars-windows]: https://answers.microsoft.com/en-us/windows/forum/all/adding-path-variable/97300613-20cb-4d85-8d0e-cc9d3549ba23
Loading