Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/grimen/js-mybad
My friendly error base class - for JavaScript/Node.
https://github.com/grimen/js-mybad
baseclass color colors debug detailed error errors inspector meta pretty stacktrace
Last synced: about 2 months ago
JSON representation
My friendly error base class - for JavaScript/Node.
- Host: GitHub
- URL: https://github.com/grimen/js-mybad
- Owner: grimen
- License: mit
- Created: 2019-02-14T20:18:29.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T04:07:23.000Z (almost 2 years ago)
- Last Synced: 2024-10-12T02:24:05.811Z (3 months ago)
- Topics: baseclass, color, colors, debug, detailed, error, errors, inspector, meta, pretty, stacktrace
- Language: JavaScript
- Homepage: https://npmjs.com/package/@grimen/mybad
- Size: 849 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: MIT-LICENSE
Awesome Lists containing this project
README
# `js-mybad` [](https://badge.fury.io/js/%40grimen%2Fmybad) [](https://travis-ci.com/grimen/js-mybad) [](https://codecov.io/gh/grimen/js-mybad)
*My friendly error base class - for Node/JavaScript.*
## Introduction
One in general always needs a application/library specific error base class, but the native errors are very limited in what meta/debugging information they can hold at time they are raised. For better debugging and error reporting/inspection this error base class allows to attach some additonal error context information that can be used to better understand the issue - without having to create custom error formatters, or run debugger.
## Install
Install using **npm**:
```bash
$ npm install @grimen/mybad
```
Install using **yarn**:
```bash
$ yarn add @grimen/mybad
```
## Use
Very basic **[example](https://github.com/grimen/js-mybad/tree/master/examples/basic.js)**:
```javascript
const mybad = require('@grimen/mybad')
class ToMuchError extends mybad.Error {}
function printMoney(stash) {
try {
if (typeof stash === 'string' && stash.length > 13) {
throw new RangeError(`Too much money to print: ${stash}`)
}
console.log(`PRINT ${stash.join('')}`)
} catch (error) {
throw new ToMuchError(error, {
message: 'Out of money printing ink...',
id: Date.now(), // well, should maybe be unique...
key: 'too_much',
code: 400,
details: {
stash,
},
})
}
}
let amount = ''
const range = (to) => {
return [...Array(to).keys()]
}
for (let dollar of range(42)) {
amount += '$'
try {
printMoney(amount)
} catch (error) {
process.env.ERROR_VERBOSE = false
process.env.ERROR_COLORS = false
console.log()
console.log('========================================================')
console.log(' error.toString({verbose: false})')
console.log('-----------------------------------------------------')
console.log()
console.log(error.toString({verbose: false}))
console.log()
console.log()
console.log('========================================================')
console.log(' error.toString({verbose: true})')
console.log('-----------------------------------------------------')
console.log()
console.log(error.toString({verbose: true}))
console.log()
console.log()
console.log('========================================================')
console.log(' error.toJSON()')
console.log('-----------------------------------------------------')
console.log()
console.log(error.toString({verbose: true}))
console.log()
throw error
}
}
```
Run this with optional environment variables `COLORS` / `ERROR_COLORS` and/or `VERBOSE` / `ERROR_VERBOSE` set too truthy or falsy values, so see various error info formatting in terminal. Also `(NO_COLOR)[https://no-color.org]` is respected.
Something like this (imagine some colorized formatting):
```bash
PRINT $
PRINT $$
PRINT $$$
PRINT $$$$
PRINT $$$$$
PRINT $$$$$$
PRINT $$$$$$$
PRINT $$$$$$$$
PRINT $$$$$$$$$
PRINT $$$$$$$$$$
PRINT $$$$$$$$$$$
PRINT $$$$$$$$$$$$
PRINT $$$$$$$$$$$$$
========================================================
error.toString({verbose: false})
-----------------------------------------------------
Out of money printing ink...
========================================================
error.toString({verbose: true})
-----------------------------------------------------
Out of money printing ink... { stash: '$$$$$$$$$$$$$$' }
========================================================
error.toJSON()
-----------------------------------------------------
{
type: 'ToMuchError',
id: 1618487081556,
code: 400,
key: 'too_much',
message: 'Out of money printing ink...',
details: { stash: '$$$$$$$$$$$$$$' },
stack: [
{
file: '/Users/jonas/Dev/Private/js-mybad/examples/basic.js',
function: 'printMoney',
line: 23,
column: 19,
source: undefined
},
{
file: '/Users/jonas/Dev/Private/js-mybad/examples/basic.js',
function: 'Object.',
line: 57,
column: 9,
source: undefined
},
{
file: 'internal/modules/cjs/loader.js',
function: 'Module._compile',
line: 1063,
column: 30,
source: undefined
},
{
file: 'internal/modules/cjs/loader.js',
function: 'Object.Module._extensions..js',
line: 1092,
column: 10,
source: undefined
},
{
file: 'internal/modules/cjs/loader.js',
function: 'Module.load',
line: 928,
column: 32,
source: undefined
},
{
file: 'internal/modules/cjs/loader.js',
function: 'Function.Module._load',
line: 769,
column: 14,
source: undefined
},
{
file: 'internal/modules/run_main.js',
function: 'Function.executeUserEntryPoint [as runMain]',
line: 72,
column: 12,
source: undefined
},
{
file: '17',
function: 'internal/main/run_main_module.js',
line: 47,
column: undefined,
source: undefined
}
]
}
```
## Test
Clone down source code:
```sh
$ make install
```
Run **colorful tests** using **jest**:
```sh
$ make test
```
## Related
- [**`python-mybad`**](https://github.com/grimen/python-mybad) - *"My friendly error base class - for Python"*
## About
This project was mainly initiated - in lack of solid existing alternatives - to be used at our work at **[Markable.ai](https://markable.ai)** to have common code conventions between various programming environments where **Node.js** (for I/O heavy operations) is heavily used.
## License
Released under the MIT license.