<commit_before># Sulfur
[![npm status](http://img.shields.io/npm/v/sulfur.svg)](https://www.npmjs.org/package/sulfur)
[![build status](https://secure.travis-ci.org/clux/sulfur.svg)](http://travis-ci.org/clux/sulfur)
[![dependency status](https://david-dm.org/clux/sulfur.svg)](https://david-dm.org/clux/sulfur)
[![coverage status](http://img.shields.io/coveralls/clux/sulfur.svg)](https://coveralls.io/r/clux/sulfur)

A rudimentary and opinionated application logger that can only capture logs from the event emitter module [smell](https://npmjs.org/package/smell).

## Format
Output format is styled after clang's compile output. The events map onto the basic `console` functions:

```js
var fn = {
  info: console.log,
  warn: console.warn,
  error: console.error
}[eventName];
```

Consequently, `warn` and `error` events go through `stderr`.

## Usage
Require sulfur in your application, then absorb the smelly compounds (yes, really committing to the analogy here) exposed from libraries:

```js
var sulfur = require('sulfur');
var smell = require('smell')(); // suppose this was exposed through some-module
sulfur.absorb(smell, 'some-module');

smell.warn('warning message'); // will log through sulfur
```

## License
MIT-Licensed. See LICENSE file for details.
<commit_msg>tweak readme<commit_after># Sulfur
[![npm status](http://img.shields.io/npm/v/sulfur.svg)](https://www.npmjs.org/package/sulfur)
[![build status](https://secure.travis-ci.org/clux/sulfur.svg)](http://travis-ci.org/clux/sulfur)
[![dependency status](https://david-dm.org/clux/sulfur.svg)](https://david-dm.org/clux/sulfur)
[![coverage status](http://img.shields.io/coveralls/clux/sulfur.svg)](https://coveralls.io/r/clux/sulfur)

A rudimentary and unconfigurable application logger that can only absorb logs from the event emitter module [smell](https://npmjs.org/package/smell).

## Format
Output format is styled after clang's compile output. The smell events map onto the basic `console` functions:

```js
var fn = {
  info: console.log,
  warn: console.warn,
  error: console.error
}[eventName];
```

Consequently, `warn` and `error` events go through `stderr`.

## Usage
Require sulfur in your application, then absorb the smells exposed from libraries:

```js
var sulfur = require('sulfur');
var smell = require('smell')(); // suppose this was exposed through some-module
sulfur.absorb(smell, 'some-module');

smell.warn('warning message'); // will log through sulfur
```

## License
MIT-Licensed. See LICENSE file for details.

{'fraction_non_alphanumeric': 0.1579156722354813, 'fraction_numerical': 0.0, 'mean_word_length': 4.973871733966746, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 12, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7601060', 'n_tokens_mistral': 870, 'n_tokens_neox': 799, 'n_words': 216}