Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/egoist/lamu
:ribbon: Impressive terminal logger
https://github.com/egoist/lamu
Last synced: about 2 months ago
JSON representation
:ribbon: Impressive terminal logger
- Host: GitHub
- URL: https://github.com/egoist/lamu
- Owner: egoist
- License: mit
- Created: 2016-11-22T01:57:24.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2021-12-25T14:08:28.000Z (over 2 years ago)
- Last Synced: 2024-07-05T21:43:52.929Z (2 months ago)
- Language: JavaScript
- Homepage:
- Size: 1.08 MB
- Stars: 75
- Watchers: 4
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# lamu
[](https://npmjs.com/package/lamu) [](https://npmjs.com/package/lamu) [](https://circleci.com/gh/egoist/lamu)
## Install
```bash
$ npm install --save lamu
```
## Examples
### Default table layout
```js
const lamu = require('lamu')()
lamu.log({
label: 'success',
text: 'Nothing goes wrong thus far'
})
lamu.log({
label: 'warning',
text: 'But keep eyes open!'
})
lamu.log({
label: 'error',
text: 'Things changed'
})
lamu.log({
label: 'see you',
color: 'magenta',
text: 'everything has an end.'
})
// node examples/default
```
### Old-school log layout
```js
// only the options are changed:
const lamu = require('lamu')({table: false})
// the rest is the same as default example
// node examples/old
```
### Big text friendly
```js
// big text can be correctly indented in table layout
const lamu = require('lamu')()
lamu.log({label: 'info', text: 'hello world'})
lamu.log({label: 'success', text: `Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.`})
lamu.log({label: 'warning', text: 'goodbye world'})
// node examples/big
```
### Extra line-spacing
```js
// more eye-friendly
const lamu = require('lamu')({
lineSpacing: 1
})
lamu.log({label: 'info', text: 'hello world'})
lamu.log({label: 'success', text: `Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.`})
lamu.log({label: 'warning', text: 'goodbye world'})
// node examples/line-spacing
```
### Custom separator
```js
// use ==> instead of :: as separator
const lamu = require('lamu')({
lineSpacing: 1,
separator: '==>'
})
lamu.log({label: 'info', text: 'hello world'})
lamu.log({label: 'success', text: `Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.`})
lamu.log({label: 'warning', text: 'goodbye world'})
// node examples/separator
```
### Update existing log
```js
const lamu = require('lamu')({
lineSpacing: 1
})
lamu.log({label: 'info', text: 'hello world'})
const log = lamu.log({
label: 'download',
text: `please wait...`,
color: 'yellow'}
)
lamu.log({label: 'warning', text: 'goodbye world'})
setTimeout(() => {
lamu.update(log, {text: 'done!', color: 'green'})
}, 1000)
```
## API
### Lamu({lineSpacing, separator, align})
#### lineSpacing
Type: `number`
Default: `0`
Extra line-spacing.
#### separator
Type: `string`
Default: `"::"`
Use a custom separator.
#### align
Type: `string`
Default: `"right"`
Align direction for label.
### lamu.log({label, color, text})
Log the logs to console, returns the id of least recently added log.
#### label
Type: `string`
The label of the log, you can use some built-in label like `success` `error` `warning` `info` with preset colors.
#### color
Type: `string`
Default: `"dim"`
The name of [chalk](https://github.com/chalk/chalk#styles) styles, apply to label text.
#### text
Type: `string`
The text of the log.
### lamu.update(id, data)
Update an exsiting log by id, id is returned by `lamu.log`, the usage of `data` is the same as in `lamu.log(data)`
## Contributing
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D
## License
[MIT](https://egoist.mit-license.org/) © [EGOIST](https://github.com/egoist)