https://github.com/ehmicky/modern-errors-bugs
`modern-errors` plugin to print where to report bugs.
https://github.com/ehmicky/modern-errors-bugs
browser bug-reporting bugs error error-handler error-handling error-monitoring error-reporting issue-management issue-tracker issues javascript library modern-errors modern-errors-plugin nodejs plugins reporting tracker typescript
Last synced: 10 months ago
JSON representation
`modern-errors` plugin to print where to report bugs.
- Host: GitHub
- URL: https://github.com/ehmicky/modern-errors-bugs
- Owner: ehmicky
- License: mit
- Created: 2022-11-04T20:13:44.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-13T05:04:08.000Z (11 months ago)
- Last Synced: 2025-03-13T05:35:54.991Z (11 months ago)
- Topics: browser, bug-reporting, bugs, error, error-handler, error-handling, error-monitoring, error-reporting, issue-management, issue-tracker, issues, javascript, library, modern-errors, modern-errors-plugin, nodejs, plugins, reporting, tracker, typescript
- Language: JavaScript
- Homepage:
- Size: 7.49 MB
- Stars: 6
- 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-bugs)
[](https://unpkg.com/modern-errors-bugs?module)
[](/src/main.d.ts)
[](https://codecov.io/gh/ehmicky/modern-errors-bugs)
[](https://bundlephobia.com/package/modern-errors-bugs)
[](https://fosstodon.org/@ehmicky)
[](https://medium.com/@ehmicky)
[`modern-errors`](https://github.com/ehmicky/modern-errors)
[plugin](https://github.com/ehmicky/modern-errors#-plugins) to print where to
report bugs.
This appends a bug reports URL to error messages.
# 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.
# 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 modernErrorsBugs from 'modern-errors-bugs'
export const BaseError = ModernError.subclass('BaseError', {
plugins: [modernErrorsBugs],
})
```
[Configuring](#configuration) the bugs report URL.
```js
export const UnknownError = BaseError.subclass('UnknownError', {
bugs: 'https://github.com/my-name/my-project/issues',
})
```
[Unknown errors](https://github.com/ehmicky/modern-errors#-unknown-errors) now
include the following message.
```
Please report this bug at: https://github.com/my-name/my-project/issues
```
# Install
```bash
npm install modern-errors-bugs
```
This package works in both Node.js >=18.18.0 and
[browsers](https://raw.githubusercontent.com/ehmicky/dev-tasks/main/src/browserslist).
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
## modernErrorsBugs
_Type_: `Plugin`
Plugin object to pass to the
[`plugins` option](https://github.com/ehmicky/modern-errors#adding-plugins) of
`ErrorClass.subclass()`.
## Configuration
The bug reports URL must be a `string` or a
[`URL`](https://developer.mozilla.org/en-US/docs/Web/API/URL).
While this plugin is especially useful with
[_unknown_ errors](https://github.com/ehmicky/modern-errors#-unknown-errors), it
can also 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: [modernErrorsBugs],
bugs: 'https://github.com/my-name/my-project/issues',
})
```
- 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 UnknownError = BaseError.subclass('UnknownError', {
bugs: 'https://github.com/my-name/my-project/issues',
})
```
- A specific error: second argument to
[`new ErrorClass()`](https://github.com/ehmicky/modern-errors#options-3)
```js
throw new ExampleError('...', {
bugs: 'https://github.com/my-name/my-project/issues',
})
```
# Related projects
- [`modern-errors`](https://github.com/ehmicky/modern-errors): Handle errors in
a simple, stable, consistent way
- [`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-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-winston`](https://github.com/ehmicky/modern-errors-winston):
Log errors with Winston
- [`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!