From d629092a1a982d3107c77c9b921b92403bfde194 Mon Sep 17 00:00:00 2001 From: takunomi-build-bot Date: Thu, 17 Apr 2025 16:45:49 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=A4=96=20Repository=20layout=20updated=20?= =?UTF-8?q?to=20latest=20version?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This commit was automatically generated by [a script](https://gitfub.space/Jmaa/repo-manager) --- .gitea/workflows/lua-library.yml | 29 +++++++++++++-- .gitignore | 19 ++++++++++ .luacheckrc | 4 ++ LICENSE | 3 ++ README.md | 63 ++++++++++++++++++++++++++++++++ init.lua | 7 +++- 6 files changed, 120 insertions(+), 5 deletions(-) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md diff --git a/.gitea/workflows/lua-library.yml b/.gitea/workflows/lua-library.yml index ae19cc0..363ae97 100644 --- a/.gitea/workflows/lua-library.yml +++ b/.gitea/workflows/lua-library.yml @@ -1,8 +1,29 @@ +# WARNING! +# THIS IS AN AUTOGENERATED FILE! +# MANUAL CHANGES CAN AND WILL BE OVERWRITTEN! + name: LÖVE/Lua Library -on: [push] + +on: + push: + paths-ignore: ['README.md', '.gitignore', 'LICENSE', 'CONVENTIONS.md'] jobs: - Test: - uses: jmaa/workflows/.gitea/workflows/lua-testing.yaml@v6.21 + Lua-Testing: + runs-on: ubuntu-latest + steps: + - name: Install Lua + run: | + apt-get update + apt-get install -y luajit + - name: Check out repository code + uses: actions/checkout@v3 + - name: Run testing library + run: luajit test/init.lua Static-Analysis: - uses: jmaa/workflows/.gitea/workflows/lua-static-analysis.yaml@v6.21 + runs-on: ubuntu-latest + steps: + - name: Check out repository code + uses: actions/checkout@v3 + - name: Luacheck linter + uses: https://github.com/lunarmodules/luacheck@v1.1.1 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..451354e --- /dev/null +++ b/.gitignore @@ -0,0 +1,19 @@ +# WARNING! +# THIS IS AN AUTOGENERATED FILE! +# MANUAL CHANGES CAN AND WILL BE OVERWRITTEN! + +# Löve: Exclude build items +/bin/ +/lib/ +.love-cache/ + +# Compiled Lua sources +luac.out + +# Misc (Image, MacOS, Backups) files +*.psd +*~ +.DS_Store + +# Tools +*.tiled-session diff --git a/.luacheckrc b/.luacheckrc index 277f930..6149112 100644 --- a/.luacheckrc +++ b/.luacheckrc @@ -1,3 +1,7 @@ +-- WARNING! +-- THIS IS AN AUTOGENERATED FILE! +-- MANUAL CHANGES CAN AND WILL BE OVERWRITTEN! + std = "love+max" cache = true include_files = {"**.lua", "*.luacheckrc"} diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..2126074 --- /dev/null +++ b/LICENSE @@ -0,0 +1,3 @@ +Copyright (c) 2017-2025 Jon Michael Aanes + +All rights reserved. diff --git a/README.md b/README.md new file mode 100644 index 0000000..3f1efab --- /dev/null +++ b/README.md @@ -0,0 +1,63 @@ + + + + +# 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. +``` diff --git a/init.lua b/init.lua index 3ccd40b..071926e 100644 --- a/init.lua +++ b/init.lua @@ -1 +1,6 @@ -return require ((... and (...) .. '.' or '.') .. 'suggest-require') +-- WARNING! +-- THIS IS AN AUTOGENERATED FILE! +-- MANUAL CHANGES CAN AND WILL BE OVERWRITTEN! + +-- This file automatically redirects to "suggest-require.lua" +return require (((...) ~= 'init' and (...) .. '.' or '') .. 'suggest-require')