https://github.com/molnarmark/epilog

🏆 Elegant, fancy console logger for Crystal
https://github.com/molnarmark/epilog

console-log console-logger crystal crystal-lang crystal-language

Last synced: about 2 months ago
JSON representation

🏆 Elegant, fancy console logger for Crystal

• Host: GitHub
• URL: https://github.com/molnarmark/epilog
• Owner: molnarmark
• License: mit
• Created: 2018-08-30T19:41:11.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2021-07-29T22:56:32.000Z (over 3 years ago)
• Last Synced: 2024-10-25T01:24:48.148Z (about 2 months ago)
• Topics: console-log, console-logger, crystal, crystal-lang, crystal-language
• Language: Crystal
• Size: 38.1 KB
• Stars: 29
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Epilog

[![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?v=102)](https://github.com/ellerbrock/open-source-badge/)

[![Open Source Love](https://badges.frapsoft.com/os/mit/mit.svg?v=102)](https://github.com/ellerbrock/open-source-badge/)

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)

> Elegant, fancy console logger for Crystal

Epilog is heavily inspired by Nuxt's [consola](https://github.com/nuxt/consola).

The API is basically the same.



  


    

  




## Installation

Add this to your application's `shard.yml`:

```yaml

dependencies:

  epilog:

    github: crystalrealm/epilog

```

## Usage

```crystal

require "epilog"

# The default reporter is the fancy one. However, if you specify anything else, you get the minimal one.

logger = Epilog::Logger.new "minimal"

# or, logger = Epilog::Logger.new

logger.success "success!"

logger.error "error!"

logger.fatal "fatal!"

logger.warn "warn!"

logger.log "log!"

logger.info "info!"

logger.start "start!"

logger.ready "ready!"

logger.debug "debug!"

logger.trace "trace!"

```

## API

`Epilog` exposes 10 methods to use.

- success

- error

- fatal

- warn

- log

- info

- start

- ready

- debug

- trace

## 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.  Create a new Pull Request

## Contributors

- [molnarmark](https://github.com/molnarmark) Mark Molnar - creator, maintainer