https://github.com/pixeldroid/log-ls
a simple logging utility for Loom, plus a handy config reader
https://github.com/pixeldroid/log-ls
configuration debug error fatal framework info json library logging loomlib loomscript warn
Last synced: 3 months ago
JSON representation
a simple logging utility for Loom, plus a handy config reader
- Host: GitHub
- URL: https://github.com/pixeldroid/log-ls
- Owner: pixeldroid
- License: other
- Created: 2016-08-15T05:01:31.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2018-05-04T02:27:17.000Z (about 7 years ago)
- Last Synced: 2025-01-08T20:32:35.323Z (5 months ago)
- Topics: configuration, debug, error, fatal, framework, info, json, library, logging, loomlib, loomscript, warn
- Language: LoomScript
- Homepage: https://pixeldroid.com/log-ls/
- Size: 188 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
log-ls
======
a simple logging utility for [Loom][loom-sdk], plus a handy config reader
> view the docs at https://pixeldroid.com/log-ls/
- [installation](#installation)
- [usage](#usage)
- [building](#building)
- [contributing](#contributing)
## installation
Download the library into its matching sdk folder:
$ curl -L -o ~/.loom/sdks/sprint34/libs/Log.loomlib \
https://github.com/pixeldroid/log-ls/releases/download/v3.0.0/Log-sprint34.loomlib
To uninstall, simply delete the file:
$ rm ~/.loom/sdks/sprint34/libs/Log.loomlib
## usage
### Log
0. import `Log` (once per class)
0. declare a label (once per class)
0. set the log level (once at app startup, ideally from a config file value)
0. submit a message generator at some verbosity level (`debug`, `info`, `warn`, `error`, `fatal`)
```ls
package
{
import loom.Application;
import pixeldroid.util.log.Log;
import pixeldroid.util.log.LogLevel;
public class LogTest extends Application
{
private const _logName:String = getFullTypeName();
override public function run():void
{
Log.level = LogLevel.INFO;
Log.info(_logName, function():String { return _logName +' is running!'; });
}
}
}
```
### Config
0. create a json file named `app.config` in the `assets/` folder of the project root
0. import `Config`
0. retrieve values
```json
{
"app_version": "1.0.0",
"log_level": "DEBUG",
"my_string": "string value",
"my_number": 123.456,
"my_integer": 789
}
```
> _assets/app.config_
```ls
package
{
import loom.Application;
import pixeldroid.util.config.Config;
import pixeldroid.util.log.Log;
import pixeldroid.util.log.LogLevel;
public class ConfigTest extends Application
{
private const _logName:String = getFullTypeName();
override public function run():void
{
Log.level = LogLevel.INFO;
Log.info(_logName, function():String { return 'app version: ' +Config.appVersion; });
Log.info(_logName, function():String { return 'log level: ' +Config.logLevel; });
Log.info(_logName, function():String { return 'my string: ' +Config.getString('my_string'); });
Log.info(_logName, function():String { return 'my number: ' +Config.getNumber('my_number'); });
Log.info(_logName, function():String { return 'my integer: ' +Config.getInteger('my_integer'); });
}
}
}
```
## building
first, install [loomtasks][loomtasks] and the [spec-ls library][spec-ls]
### compiling from source
$ rake lib:install
this will build the Log library and install it in the currently configured sdk
### running tests
$ rake test
this will build the Log library, install it in the currently configured sdk, build the test app, and run the test app.
## contributing
Pull requests are welcome!
[loom-sdk]: https://github.com/LoomSDK/LoomSDK "a native mobile app and game framework"
[loomtasks]: https://github.com/pixeldroid/loomtasks "Rake tasks for working with loomlibs"
[spec-ls]: https://github.com/pixeldroid/spec-ls "a simple spec framework for Loom"