https://github.com/typicode/logan
Mini template system for the console and colors
https://github.com/typicode/logan
Last synced: 5 months ago
JSON representation
Mini template system for the console and colors
- Host: GitHub
- URL: https://github.com/typicode/logan
- Owner: typicode
- License: mit
- Created: 2013-11-12T10:13:00.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2013-12-20T13:01:55.000Z (about 12 years ago)
- Last Synced: 2025-07-05T11:44:21.022Z (6 months ago)
- Language: JavaScript
- Homepage: https://github.com/typicode
- Size: 105 KB
- Stars: 82
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Logan
Logan is a mini template system for the console and [colors](https://github.com/Marak/colors.js).
It allows to cleanly separate content from style and create beautiful logging functions.
## Example
Let's say you want to write a logging function that says hello.
```javascript
// Without Logan
function hello(arg) {
console.log('Hello'.bold.green + ' : ' + arg.cyan);
}
// With Logan
var hello = logan.create('Hello : %', 'bold.green . cyan')
hello('world');
```
## Usage
```javascript
var logan = require('logan');
```
### set
This is the most useful method of logan. It lets you define all your templates in one place.
```javascript
logan.set({
info: ['info : %', 'yellow'],
warn: ['warn : %', 'orange'],
omg : ['omg : %', 'rainbow']
});
logan.info('some info');
```
Notice how easy it is to see what all your logging functions will output.
Also, with ```set``` your module users can easily theme logs:
```javascript
// Overriding omg to be... more OMG!!!
logan.set({
omg: ['OMG : % !!!', 'red . . red']
});
```
### create
Returns a logging function.
```javascript
var info = logan.create('info : %', 'yellow');
info('some text');
```
### compile
Returns a function which returns a string when called.
```javascript
var info = logan.compile('info : %', 'yellow');
console.log(info('some text'));
```
## Syntax
* **%** is used for string replacement.
* **{}** lets you define blocks.
* **.** means default style.
* styles can be chained (example: bold.underline.red).
**{}** usage:
```javascript
// for example, instead of writing this:
var green = logan.create('some long green string', 'green green green green');
// using {} you can write
var green = logan.create('{some long green string}', 'green');
```
## Configuration
If you want to suppress all output, during tests for example, just set ```silent``` to ```true```.
```javascript
logan.set({'foo': ['foo', 'red']});
logan.silent = true;
logan.foo(); // No output
logan.silent = false;
logan.foo(): // will output 'foo'
```
## About the name
Since there's a templating engine called [hogan](http://twitter.github.io/hogan.js/) and this one is about logging, it was called logan.
## More
If you want to see how Logan can be used in another project, you can have a look at [ShoutJS](https://github.com/typicode/shoutjs).