Transform to Typescript - #274

[subzero10]

Status

READY

Description

This PR introduces a typescript version of the react component, which means auto-generated typescript delcaration files (.d.ts).
It also exports the Honeybadger object from @honeybadger-io/js.
This simplifies the component's integration from:

import Honeybadger from '@honeybadger-io/js
import ErrorBoundary from '@honeybadger-io/react'

to:

import {Honeybadger, HoneybadgerErrorBoundary} from '@honeybadger-io/react'

Related PRs

docs - https://github.com/honeybadger-io/docs/pull/141

Todos

• Transform to TS
• New rollup config
• Remove unused dependencies
• Generate .d.ts files automatically
• Export Honeybadger from @honeybadger-js - BREAKING CHANGE
• Commit example project in typescript
• Tests
• Documentation
• Changelog Entry (unreleased)

Steps to Test or Reproduce

I tested this by creating a react app with the typescript template.
I then installed the honeybadger-react package and imported the component slightly differently.

> npx create-react-app honeybadger-react-ts-app --template typescript
> cd honeybadger-react-ts-app
> npm i "[email protected]:honeybadger-io/honeybadger-react.git#ts"

2. Open src/index.tsx and do:

import {Honeybadger, HoneybadgerErrorBoundary} from '@honeybadger-io/react';

const apikey = (
    process.env.REACT_APP_HONEYBADGER_API_KEY ||
    prompt('Enter the API key for your Honeybadger project:') as string
);

const honeybadgerClient = Honeybadger.configure({
    apiKey: apikey,
    environment: 'production'
})

ReactDOM.render(
    <HoneybadgerErrorBoundary honeybadger={honeybadgerClient}>
    <App />
    </HoneybadgerErrorBoundary>,
  document.getElementById('root')
);

[subzero10]

Type definitions are now generated dynamically when installing the package! 🥳

[subzero10]

I decided to bump the major version because we are introducing a breaking change. See details in PR description and we can discuss this further.

[subzero10]

A number of these deps were unnecessary so I did some cleanup.

[subzero10]

Exporting core Honeybadger from @honeybadger-op/js to make react integration simpler.

[joshuap]

Looks good, thanks! Feel free to merge this when ready. I'll cut the release and then merge the docs PR.

[subzero10]

Looks good, thanks! Feel free to merge this when ready. I'll cut the release and then merge the docs PR.

👌 Will do another round of testing (probably tomorrow) and merge.

[subzero10]

@joshuap This is ready to release.

[joshuap]

2.0.0 has been released

[subzero10]

2.0.0 has been released

Awesome! Will test the release asap.