Giter VIP home page Giter VIP logo

synlog's Introduction

Synlog

A debug display for Synapse X

Importing with Neon:

synlog = NEON:github('belkworks', 'synlog')

Note: This documentation is UNFINISHED!
Some functions may not be documented.

API

print: synlog:print(...blocks) -> nil
Print all of blocks separated with a space.

synlog:print('hello', 'world', 123) -- prints 'hello world 123'

error, warning, info & success: synlog:[method](...blocks) -> nil
Same as print, but prefixes the blocks with a colored tag.

synlog:error('something happened') -- prints 'ERROR something happened'

setDefaultTime: synlog:setDefaultTime(seconds) -> nil
Sets the default duration that logs are shown.

synlog:setDefaultTime(4) -- logs will appear for 4 seconds

Preview

a picture of synlog

Using with logfile

Call the :logger() method to get a logfile-compatible writer.

file = log.logfile('events.log')
levels = {
    system = "WARN",
    other = "INFO",
    hush = "OFF"
}

combined = log.combine(file, synlog:logger())
log.init(levels, combined)

Using Colors

To create a colored block of text, synlog provides a chalk function.
You can mix and match as many color blocks as you want.

chalk = synlog.chalk
synlog:print('hello', chalk('world').light.red) -- prints 'hello world'
-- 'world' will be light red (light is a modifier)

enter image description here

A list of colors can be found in the source code.

synlog's People

Contributors

safazi avatar ascaxz avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.