takunomi-build-bot
d629092a1a
This commit was automatically generated by [a script](https://gitfub.space/Jmaa/repo-manager)
64 lines
1.7 KiB
Markdown
64 lines
1.7 KiB
Markdown
<!-- WARNING! -->
|
|
<!-- THIS IS AN AUTOGENERATED FILE! -->
|
|
<!-- MANUAL CHANGES CAN AND WILL BE OVERWRITTEN! -->
|
|
|
|
# Suggest-Require
|
|
|
|
This is a small library to discover which modules are importable using
|
|
[require](https://www.lua.org/manual/5.4/manual.html#pdf-require).
|
|
|
|
It's useful for seeing which modules your Lua environment
|
|
can access. It's intended usage is in an auto-complete system for Lua.
|
|
|
|
Known to work with Lua 5.1 and LuaJIT, on Linux.
|
|
|
|
## Usage
|
|
|
|
Standalone: The library be called as a script `luajit
|
|
suggest-require.lua` to print available packages in the Lua
|
|
environment.
|
|
|
|
Library: Import through require. A single function is be returned.
|
|
Calling this function will return the available packages, as a list
|
|
of strings.
|
|
|
|
## Example
|
|
|
|
Replicating the script functionality of this library is as simple as:
|
|
|
|
local package_names = require 'suggest-require' ()
|
|
for , name in ipairs(packagenames) do
|
|
|
|
```
|
|
print('- '..name)
|
|
```
|
|
|
|
end
|
|
|
|
## Changelog
|
|
- `1.4.0`: Updated repository (17. April 2025)
|
|
- `1.3.0`: Usage and example (6. July 2020)
|
|
- `1.2.0`: Unknown change (9. January 2018)
|
|
- `1.1.0`: Unknown change (Unknown)
|
|
- `1.0.0`: Initial version (September 2017)
|
|
|
|
- Author: Jon Michael Aanes (jonjmaa@gmail.com)
|
|
|
|
## Dependencies
|
|
|
|
This project requires [PUC Lua 5.1](https://www.tecgraf.puc-rio.br/lua/mirror/versions.html#5.1) or [LuaJIT](https://luajit.org/luajit.html). Newer versions of PUC Lua are not supported.
|
|
|
|
This project does not have any library requirements 😎
|
|
|
|
## Contributing
|
|
|
|
Feel free to submit pull requests. Please follow the [Code Conventions](CONVENTIONS.md) when doing so.
|
|
|
|
## License
|
|
|
|
```
|
|
Copyright (c) 2017-2025 Jon Michael Aanes
|
|
|
|
All rights reserved.
|
|
```
|