A general Lua library.
Some units here are verbatim copies from other repos - will make them submodules or something in the future (they might be licensed differently from this repo. See the files themselves for details).
This library is intended to be used as drop in Lua module, so when using it in your projects you would copy the lute.lua file into your project and then use it as such:
which will then allow you to
local lute = require('lute')
and then
local MOD = lute.MOD -- where MOD is one of the separate modules in this project
In general, the modules follow the basic structure that they:
- Always return a
table - Allows for easy monkey-patching
- Allows for extending, from the class/prototype inheritance perspective.
Modules filenames are snake_case because some OS use case-insensitive file
system. The purpose being that the names should be readable. However symbol
names in source code use PascalCase and camelCase such that prototype
constructors use PascalCase and methods and variables use camelCase. It is
not yet determined whether the package should alias all methods so that the
consumer can choose between using camelCase, luacase and snake_case naming
conventions.
- Use
localwhenever possible. Avoid globals. Use modules - function definitions should have a space between the function name and the start of the parameter list, e.g.
local function addOne (n) ...
---------------------^-here
-
put all
requires at the top of the file. -
avoid aliasing table values as local values (if not strictly necessary), e.g.
local unpack = table.unpack or unpack -- OK
-- avoid:
local mod = require(...)
local a = mod.a
local b = mod.b
-
large modules are not a problem (i.e. SLoC per module is not an important metric)
-
parameter names (especially in public functions) should have descriptive names. The code is not faster because symbols are short and hard to decipher.
-
source code should be formatted and easier to read than to write.
TBD