https://github.com/norman/tlua
A simple task runner for Lua - now abandoned because I think it's just easier to use plain old Makefiles.
https://github.com/norman/tlua
Last synced: 8 months ago
JSON representation
A simple task runner for Lua - now abandoned because I think it's just easier to use plain old Makefiles.
- Host: GitHub
- URL: https://github.com/norman/tlua
- Owner: norman
- License: mit
- Created: 2010-09-15T17:11:45.000Z (over 15 years ago)
- Default Branch: master
- Last Pushed: 2010-11-24T13:48:32.000Z (about 15 years ago)
- Last Synced: 2025-03-31T04:11:10.655Z (10 months ago)
- Language: Lua
- Homepage: http://github.com/norman/tlua
- Size: 105 KB
- Stars: 14
- Watchers: 5
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: MIT-LICENSE
Awesome Lists containing this project
README
# Tlua
Tlua is a task runner for Lua that simplifies running and reusing small bits of
useful code. It lets you very easily build a command-line interface for
running scripts in a project.
It is in some ways conceptually similar to [Rake](http://rake.rubyforge.org/),
but is oriented exclusively towards task running rather replacing Makefiles,
and doesn't require a special file format or DSL - it's just plain Lua.
## Intended Use
Use TLua to run project tasks such as:
* Invoking tests
* Archiving files for a rock
* Generating Luadocs
* Populating a database with sample data
* etc.
## Usage
### What it Does
Tlua looks for functions in a file named `LuaTasks.lua` in your current
directory, and also in a directory named `.tlua` in your home directory. The
files in `~/.tlua` can be in any heirachy and have any name, as long as they
have the extension `.lua`.
### Sample Tasks File
Here's an example `LuaTasks.lua` file:
--- A "hello world" function for tlua.
-- Looks for a greeting in params[1], or defaults to "hello".
-- Looks for a person in params.to, or defaults to "world".
-- Example: tlua say olá to:João
local function sample_func()
local params = tlua.get_params()
local greeting = params[1] or "hello"
local who = params.to or "world"
print(string.format("%s %s!", greeting, who))
end
tlua.task("say", "Say a greeting", sample_func)
You can then invoke this task on the command line:
$ tlua say hello to:John
hello John!
### Creating Tasks
Any function can be used as a task, as long as it does not require arguments. If
you want to make a function that requires arguments into task, you can simply
wrap it in a Tlua task that parses the parameters in the apropriate way:
local function test_match()
local params = tlua.get_params()
print(string.match(params[1], params[2]))
end
tlua.task("string.match", "Print the result of string.match", test_match)
Then, invoke the example:
$ tlua string.match 'joe@example.com' '.*@(.*)'
example.com
### Default Tasks
You can also set a default task:
tlua.default_task = "my.new.default.task"
Now when you invoke `tlua` with no arguments, your default task will be run
rather than the help task.
## Commands
To see what tasks you have available, use `tlua list`:
$ tlua list
System tasks:
-------------
help Show this message
list List all tasks
User tasks:
-----------
clean Clean up project directory
docs Run Luadoc for the Tlua project
test Run tests
## Potential Uses
By adding tasks to files in your ~/.tlua directory, you can save useful code
snippets from the Lua Users Wiki. This makes tlua sort of like Luarocks, but
for functions rather than applications:
require 'tlua'
local split = tlua.get_task("ricci.lakes.split")
## Installation
Install via Luarocks, or download and copy to the location you desire. At the
moment, the best way to install via Luarocks is:
sudo luarocks build http://github.com/norman/tlua/raw/master/tlua-scm-1.rockspec
## Author
Norman Clarke - norman@njclarke.com
## License
Copyright (c) 2010 Norman Clarke
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.