Welcome to issue-reporter 👋

> A lib that generates issue reports for unexcepted errors.

$3

Prerequisites

- npm >=5.5.0
- node >=10.0.0

Install

``sh
yarn add issue-reporter
`

Usage

`js
const issueReporter = require('issue-reporter')

async function main() {
try {
throw new Error('Some unexcepted error')
} catch (e) {
await issueReporter({
error: e,
user: 'frinyvonnick',
repo: 'issue-reporter',
})
}
}
`

$3

issue-reporter's output depends on your environment:

If you terminal supports Hyperlinks it will print a friendly error message with a clickable link that opens a form to create a new issue with a prefilled error report on your project.

If your terminal doesn't support Hyperlinks, issue-reporter will copy the error report in your clipboard and print an url that opens a new issue on your project so you can directly paste the report on the issue template.

In case of a CI it will print an url that opens a new issue on your project followed by a full report error in markdown you can copy paste in the issue body.

$3

| option | description | type | required |
|-------------------------|-------------------------------------------------------------------------------------------------|----------------------------|-------------|
| error | An Error instance | Error | required |
| user | You GitHub handle | string | required |
| repo | The repository name of your project | string | required |
| envinfo | A configuration object that is passed down to envinfo | Object | optional |
| sections | Custom sections to add in the error report | Array