# bracket_print

> Comprehensive logging, printing and serialization for ECMA script.

Latest version **0.12.0** (published 2020-02-21) · LGPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install bracket_print
pnpm add bracket_print
yarn add bracket_print
bun add bracket_print
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.12.0 |
| Published | 2020-02-21 |
| First published | 2017-10-01 |
| Weekly downloads | 0 |
| License | LGPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.6.0 |
| Dependencies | 6 |
| Unpacked size | 2.2 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Robert Steckroth |
| Maintainers | nickali |
| Keywords | printing, console, logging, eval, serialize |

## Links

- npm: https://www.npmjs.com/package/bracket_print
- Repository: https://github.com/restarian/bracket_print
- Homepage: https://github.com/restarian/bracket_print#readme
- Issues: https://github.com/restarian/bracket_print/issues
- npm.io page: https://npm.io/package/bracket_print

## Dependencies (6)

- [brace_option](https://npm.io/package/brace_option.md) ^0.5.4
- [brace_document](https://npm.io/package/brace_document.md) ^1.1.8
- [brace_document_link](https://npm.io/package/brace_document_link.md) ^1.1.9
- [brace_document_mocha](https://npm.io/package/brace_document_mocha.md) ^1.1.0
- [brace_document_navlink](https://npm.io/package/brace_document_navlink.md) ^1.1.12
- [brace_document_specification](https://npm.io/package/brace_document_specification.md) ^1.2.2

## Alternatives

- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads

## Recent versions

- 0.12.0 (latest) — 2020-02-21
- 0.11.8 — 2020-02-11
- 0.11.7 — 2020-02-10
- 0.11.6 — 2020-02-10
- 0.11.5 — 2020-02-10
- 0.11.4 — 2020-02-08
- 0.11.3 — 2020-02-08
- 0.11.2 — 2020-02-04
- 0.10.4 — 2020-01-28
- 0.10.3 — 2020-01-28
- 0.10.2 — 2020-01-28
- 0.10.0 — 2020-01-27
- 0.9.29 — 2020-01-26
- 0.9.28 — 2020-01-26
- 0.9.27 — 2020-01-26
- … 18 more at https://npm.io/package/bracket_print/versions

## README

[![Build status](https://ci.appveyor.com/api/projects/status/fgkk45xrm8yv7av0/branch/master?svg=true)](https://ci.appveyor.com/project/restarian/bracket-print/branch/master) [![Downloads](https://img.shields.io/npm/dm/bracket_print.svg?svg=true)](https://npmjs.org/package/bracket_print)

| **The [Bracket Suite]** | **[Ubuntu on Windows]**   |
|:-----------------------:|:-------------------------:|
| ![Bracket logo]         | ![Ubuntu on Windows logo] |         |

[Bracket Suite]: https://github.com/restarian/restarian/tree/master/bracket/
[Ubuntu on Windows]: https://www.microsoft.com/en-us/store/p/ubuntu/9nblggh4msv6?activetab=pivot%3aoverviewtab

[Ubuntu on Windows logo]: https://raw.githubusercontent.com/restarian/restarian/master/doc/image/ubuntu_windows_logo.png
[Bracket logo]: https://raw.githubusercontent.com/restarian/restarian/master/bracket/doc/image/bracket_logo_small.png

## Synopsis

---
### Bracket Print help pages
* [Contributor code of conduct](https://github.com/restarian/bracket_print/blob/master/docs/contributor_code_of_conduct.md)
* [Guidelines for contributing](https://github.com/restarian/bracket_print/blob/master/docs/guidelines_for_contributing.md)
* **Synopsis**
* Media and statistics
  * [Benchmarking](https://github.com/restarian/bracket_print/blob/master/docs/media_and_statistics/benchmarking.md)
  * [Screeenshots of output](https://github.com/restarian/bracket_print/blob/master/docs/media_and_statistics/screeenshots_of_output.md)
* Specification
  * [License information](https://github.com/restarian/bracket_print/blob/master/docs/specification/license_information.md)
  * [Package information](https://github.com/restarian/bracket_print/blob/master/docs/specification/package_information.md)
  * [Unit test output](https://github.com/restarian/bracket_print/blob/master/docs/specification/unit_test_output.md)
* Usage and examples
  * [As a callback](https://github.com/restarian/bracket_print/blob/master/docs/usage_and_examples/as_a_callback.md)
  * [As a logger](https://github.com/restarian/bracket_print/blob/master/docs/usage_and_examples/as_a_logger.md)
  * [As a string](https://github.com/restarian/bracket_print/blob/master/docs/usage_and_examples/as_a_string.md)
  * [Controlling the behaviour via option data](https://github.com/restarian/bracket_print/blob/master/docs/usage_and_examples/controlling_the_behaviour_via_option_data.md)
  * [How the level correlates to styling](https://github.com/restarian/bracket_print/blob/master/docs/usage_and_examples/how_the_level_correlates_to_styling.md)
  * Advanced usage
    * [Accessing the style map](https://github.com/restarian/bracket_print/blob/master/docs/usage_and_examples/advanced_usage/accessing_the_style_map.md)

---

### Bracket Print is an ECMA serialization and logging tool with colorful and plain text output for terminal, browser, html or custom platforms.

**Bonuses:**

* Works in the browser, console or terminal with the default styles which can be extended to other special uses.
* Can output ECMA Objects in html syntax or any other custom created platforms.
* Supports the ES6 arrow functions.
* Uses AMD (asynchronous module definition), syntax.
* Has full [Brace Umd](https://npmjs.org/packages/brace_umd) integration for ideal, deterministic, and cross-platform deployment builds.
* Can stringify ECMA script (unlike the *JSON* builtin and other serializers)
* Bracket Print can safely serialize massive Objects (like the browser *window* property), without hiccups.
	* Is able to do semantically deep equality tests on ECMA script (not just JSON objects).
	* Output can be configured to be passed into JSON.parse or eval() methods.
* Uses a instance return chain to allow for usage as functional programming callbacks.
* Contains a comprehensive level mechanism to control what (and how) things get logged at run-time with a nearly total overhead discharge.
* Provides configurable syntax mapping with custom individualized styles.
* Well commented, thoroughly unit tested and professionally engineered code.

**Caveats:**

* Does not have browser unit tests.

---
_Source: https://npm.io/package/bracket_print · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._