Jmaa/suggest-require
1
0
Fork 0
Code Actions

Update docs and version

Browse Source
This commit is contained in:
Jon Michael Aanes 2025-04-17 16:45:42 +02:00
parent ed512cce18
commit b2046ea561
2 changed files with 24 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
init.lua
View File

@ -1,4 +1 @@
local _VERSION = '0.1.2'
local lib = require ((... and (...) .. '.' or '.') .. 'suggest-require')
return lib
return require ((... and (...) .. '.' or '.') .. 'suggest-require')

54
suggest-require.lua
View File

@ -1,48 +1,40 @@
-- ||| Suggest-Require ||| -----------------------------------------------------
--- # Suggest-Require
--
-- This is a small library to discover which modules are importable using
-- `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.
-- Author: Jmaa
-- Email: jonjmaa@gmail.com
-- Website: aanes.xyz
-- "THE BEER-WARE LICENSE" (Revision 42):
-- <jonjmaa@gmail.com> wrote this file. As long as you retain this notice you
-- can do whatever you want with this stuff. If we meet some day, and you think
-- this stuff is worth it, you can buy me a beer in return.
-- TODO: Ensure it works under both Windows and MacOS.
--[[ Usage ]]--
-- Standalone: The library be called as a script `luajit
--
-- ## 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.
--
-- **Library**: Import through require. A single function is be returned.
-- Calling this function will return the available packages, as a list
-- of strings.
--[[ Example ]]--
--
-- ## Example
--
-- Replicating the script functionality of this library is as simple as:
--
-- local package_names = require 'suggest-require' ()
-- for _, name in ipairs(package_names) 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)
--[[ Changelog ]]--
-- 1.3: Usage and example (6. July 2020)
-- 1.2: Unknown change (9. January 2018)
-- 1.1: Unknown change (Unknown)
-- 1.0: Initial version (September 2017)
local _VERSION = '1.4.0'
--------------------------------------------------------------------------------
-- Platform dependant