Skip to content

the-holocron/klaxon

Repository files navigation

Klaxon

npm Build Status semantic-release Dependabot Status

Klaxon is the loudest way to debug within the Galaxy.

Klaxon Star Wars sound

Installation

npm install --save @theholocron/klaxon

Table of Contents

Usage

This is meant to be a wrapper around console API with some helper methods for formatting.

import echo from '@theholocron/klaxon';

echo.log('This is a message');
echo.info('This is a message with info level status');
echo.warn('This is a message with warning level status');
echo.error('This is a message with error level status');
echo.log(echo.asAlert('This is a message that will look like an alert'));
echo.log(echo.asInfo('This is a message that will look like an alert'));
echo.log(echo.asProcess('This is a message that will look like its processing'));
echo.log(echo.asSuccess('This is a message that will look sucessful'));
echo.log(echo.asWarning('This is a message that will look like a warning'));

Which Browsers & Devices We Support

We support the latest, stable releases of all major browsers and platforms based on the most common usage from stats accumulated in Google Analytics. We use caniuse.com programmatically to determine support and browserl.ist to determine usage based on strings we provide. This technically translates to the > ~0.03% in my stats, excluding IE11 and Opera Mini using not ie 11, not op_mini all.

IE / Edge
IE / Edge
Firefox
Firefox
Chrome
Chrome
Safari
Safari
iOS Safari
iOS Safari
Opera
Opera
Edge last 10 versions last 8 versions last 2 versions last 2 versions last 2 versions

Alternative browsers which use the latest version of WebKit, Blink, or Gecko, whether directly or via the platform's web view API, are not explicitly supported. However, it should (in most cases) display and function correctly in these browsers as well. More specific support information is provided below.

Where to Find Documentation Badge

The best way to find out what's available is to check out the source code or test but you can also take a look at the-holocron.github.io/klaxon or the README which have been generated by SassDoc and sassdoc-to-markdown.

How We Track Changes Keep a Changelog

This project uses a CHANGELOG and GitHub releases which contains a curated, chronologically ordered list of notable changes for each version of a project. Read more about changelogs.

How We Version semantic-release

We use SemVer for its versioning providing us an opt-in approach to releases. This means we add a version number according to the spec, as you see below. So rather than force developers to consume the latest and greatest, they can choose which version to consume and test any newer ones before upgrading. Please the read the spec as it goes into further detail.

Given a version number MAJOR.MINOR.PATCH, increment the:

  • MAJOR version when you make incompatible API changes.
  • MINOR version when you add functionality in a backward-compatible manner.
  • PATCH version when you make backward-compatible bug fixes.

Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.

How to Contribute Conventional Commits

Have a bug or a feature request? Looking to contribute to advance the project? Read our contribution guide or maintenance guide first in order to understand how we do things around here. Or you could look at some of our other guides below:

How do I… (click to expand)

💥 Interested in how we decide things? Check out our Mistakes We've Made document for an insight into the things we've considered.

Where to Find Support Contributor Covenant

Looking to talk to someone or need some help? Please read our support guidelines.

Tools We Use

References

License License: GPL v3

©2020 GNU General Public License v3. See LICENSE for specifics.

About

Klaxon is the loudest way to debug within the Galaxy.

Resources

License

Code of conduct

Stars

Watchers

Forks

Sponsor this project

Packages

No packages published