Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ehmicky/modern-errors-winston
`modern-errors` plugin for Winston.
https://github.com/ehmicky/modern-errors-winston
browser console error error-handler error-handling error-monitoring http javascript library logger logger-middleware logging modern-errors modern-errors-plugin nodejs plugins typescript winston winston-logger winstonjs
Last synced: 19 days ago
JSON representation
`modern-errors` plugin for Winston.
- Host: GitHub
- URL: https://github.com/ehmicky/modern-errors-winston
- Owner: ehmicky
- License: mit
- Created: 2022-11-04T20:17:45.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T20:15:19.000Z (22 days ago)
- Last Synced: 2024-10-26T07:04:48.322Z (21 days ago)
- Topics: browser, console, error, error-handler, error-handling, error-monitoring, http, javascript, library, logger, logger-middleware, logging, modern-errors, modern-errors-plugin, nodejs, plugins, typescript, winston, winston-logger, winstonjs
- Language: JavaScript
- Homepage:
- Size: 6.98 MB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/modern-errors-winston)
[](/src/main.d.ts)
[](https://codecov.io/gh/ehmicky/modern-errors-winston)
[](https://fosstodon.org/@ehmicky)
[](https://medium.com/@ehmicky)
[`modern-errors`](https://github.com/ehmicky/modern-errors)
[plugin](https://github.com/ehmicky/modern-errors#-plugins) for
[Winston](https://github.com/winstonjs/winston).
This adds [`BaseError.fullFormat()`](#baseerrorfullformat) and
[`BaseError.shortFormat()`](#baseerrorshortformat) which return a
[Winston format](https://github.com/winstonjs/winston/blob/master/README.md#formats).
# Hire me
Please
[reach out](https://www.linkedin.com/feed/update/urn:li:activity:7117265228068716545/)
if you're looking for a Node.js API or CLI engineer (11 years of experience).
Most recently I have been [Netlify Build](https://github.com/netlify/build)'s
and [Netlify Plugins](https://www.netlify.com/products/build/plugins/)'
technical lead for 2.5 years. I am available for full-time remote positions.
# Features
Improved error logging with Winston:
- Error [class/instance-specific](#configuration) log [level](#level) or
[verbosity](#stack)
- The [full format](#baseerrorfullformat) includes all properties
- The [short format](#baseerrorshortformat) includes only the error's `name`,
`message` and `stack`
- Works with
[uncaught exceptions](https://github.com/winstonjs/winston#exceptions)
Unlike Winston's default
[error format](https://github.com/winstonjs/logform#errors):
- The error `name` is logged
- The full format logs nested errors, including
[`cause`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/cause)
and aggregate
[`errors`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/AggregateError)
- The full format is [JSON-safe](https://github.com/ehmicky/safe-json-value)
- The short format optionally logs the stack trace
- The error instance is not modified
# Example
[Adding the plugin](https://github.com/ehmicky/modern-errors#adding-plugins) to
[`modern-errors`](https://github.com/ehmicky/modern-errors).
```js
import ModernError from 'modern-errors'
import modernErrorsWinston from 'modern-errors-winston'
export const BaseError = ModernError.subclass('BaseError', {
plugins: [modernErrorsWinston],
})
export const InputError = BaseError.subclass('InputError')
// ...
```
Using the [full format](#baseerrorfullformat) with Winston.
```js
import { createLogger, transports, format } from 'winston'
const logger = createLogger({
format: format.combine(BaseError.fullFormat(), format.json()),
transports: [new transports.Http(httpOptions)],
})
const error = new InputError('Could not read file.', { props: { filePath } })
logger.error(error)
// Sent via HTTP:
// {
// level: 'error',
// name: 'InputError',
// message: 'Could not read file.',
// stack: `InputError: Could not read file.
// at ...`,
// filePath: '/...',
// }
```
Using the [short format](#baseerrorshortformat) with Winston.
```js
import { createLogger, transports, format } from 'winston'
const logger = createLogger({
format: format.combine(BaseError.shortFormat(), format.cli()),
transports: [new transports.Console()],
})
const error = new InputError('Could not read file.', { props: { filePath } })
logger.error(error)
// Printed on the console:
// error: InputError: Could not read file.
// at ...
```
# Install
```bash
npm install modern-errors-winston
```
This package requires installing [Winston](https://github.com/winstonjs/winston)
separately.
```bash
npm install winston
```
This package works in Node.js >=18.18.0.
This is an ES module. It must be loaded using
[an `import` or `import()` statement](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c),
not `require()`. If TypeScript is used, it must be configured to
[output ES modules](https://www.typescriptlang.org/docs/handbook/esm-node.html),
not CommonJS.
# API
## modernErrorsWinston
_Type_: `Plugin`
Plugin object to pass to the
[`plugins` option](https://github.com/ehmicky/modern-errors#adding-plugins) of
`ErrorClass.subclass()`.
## BaseError.fullFormat()
_Return value_: `Format`
Returns a logger
[`format`](https://github.com/winstonjs/winston/blob/master/README.md#formats)
to [combine](https://github.com/winstonjs/winston#combining-formats) with
[`format.json()`](https://github.com/winstonjs/logform#json) or
[`format.prettyPrint()`](https://github.com/winstonjs/logform#prettyprint). This
logs all error properties, making it useful with
[transports](https://github.com/winstonjs/winston#transports) like
[HTTP](https://github.com/winstonjs/winston/blob/master/docs/transports.md#http-transport).
Errors should be logged using
[`logger.*(error)`](https://github.com/winstonjs/winston/blob/master/README.md#creating-your-own-logger).
## BaseError.shortFormat()
_Return value_: `Format`
Returns a logger
[`format`](https://github.com/winstonjs/winston/blob/master/README.md#formats)
to [combine](https://github.com/winstonjs/winston#combining-formats) with
[`format.simple()`](https://github.com/winstonjs/logform#simple) or
[`format.cli()`](https://github.com/winstonjs/logform#cli). This logs only the
error `name`, `message` and `stack`, making it useful with
[transports](https://github.com/winstonjs/winston#transports) like the
[console](https://github.com/winstonjs/winston/blob/master/docs/transports.md#console-transport).
Errors should be logged using
[`logger.*(error)`](https://github.com/winstonjs/winston/blob/master/README.md#creating-your-own-logger).
## Options
_Type_: `object`
### stack
_Type_: `boolean`\
_Default_: `true`
Whether to log the stack trace.
### level
_Type_: `string`
Override the log [level](https://github.com/winstonjs/winston#logging-levels).
## Configuration
[Options](#options) can apply to (in priority order):
- Any error: second argument to
[`ModernError.subclass()`](https://github.com/ehmicky/modern-errors#options-1)
```js
export const BaseError = ModernError.subclass('BaseError', {
plugins: [modernErrorsWinston],
winston: options,
})
```
- Any error of a specific class (and its subclasses): second argument to
[`ErrorClass.subclass()`](https://github.com/ehmicky/modern-errors#options-1)
```js
export const InputError = BaseError.subclass('InputError', { winston: options })
```
- A specific error: second argument to
[`new ErrorClass()`](https://github.com/ehmicky/modern-errors#options-3)
```js
throw new InputError('...', { winston: options })
```
- A specific [`BaseError.fullFormat()`](#baseerrorfullformat) or
[`BaseError.shortFormat()`](#baseerrorshortformat) call
```js
BaseError.fullFormat(options)
```
# Related projects
- [`winston`](https://github.com/winstonjs/winston): A logger for just about
everything
- [`modern-errors`](https://github.com/ehmicky/modern-errors): Handle errors in
a simple, stable, consistent way
- [`winston-error-format`](https://github.com/ehmicky/winston-error-format): Log
errors with Winston
- [`error-serializer`](https://github.com/ehmicky/error-serializer): Convert
errors to/from plain objects
- [`modern-errors-cli`](https://github.com/ehmicky/modern-errors-cli): Handle
errors in CLI modules
- [`modern-errors-process`](https://github.com/ehmicky/modern-errors-process):
Handle process errors
- [`modern-errors-bugs`](https://github.com/ehmicky/modern-errors-bugs): Print
where to report bugs
- [`modern-errors-serialize`](https://github.com/ehmicky/modern-errors-serialize):
Serialize/parse errors
- [`modern-errors-clean`](https://github.com/ehmicky/modern-errors-clean): Clean
stack traces
- [`modern-errors-http`](https://github.com/ehmicky/modern-errors-http): Create
HTTP error responses
- [`modern-errors-switch`](https://github.com/ehmicky/modern-errors-switch):
Execute class-specific logic
# Support
For any question, _don't hesitate_ to [submit an issue on GitHub](../../issues).
Everyone is welcome regardless of personal background. We enforce a
[Code of conduct](CODE_OF_CONDUCT.md) in order to promote a positive and
inclusive environment.
# Contributing
This project was made with ❤️. The simplest way to give back is by starring and
sharing it online.
If the documentation is unclear or has a typo, please click on the page's `Edit`
button (pencil icon) and suggest a correction.
If you would like to help us fix a bug or add a new feature, please check our
[guidelines](CONTRIBUTING.md). Pull requests are welcome!