Add bundled example project #7
Conversation
| click: function () { | ||
| this.clicks += 1 | ||
| if (this.clicks === 10) { | ||
| bugsnagClient(new Error('user clicked button too many times!'), { severity: 'info' }) |
|
app works perfectly, except for one 'notify()' missing in HelloWorld.vue I'd be happy to add some more complex config details, metadata & comments -- but that's all extra. Easy install, all errors reported as expected. |
| are left, how errors are grouped and how they relate to the original source. | ||
|
|
||
| To get set up, follow the instructions below. Don't forget to replace the placeholder | ||
| API token with your own! |
There was a problem hiding this comment.
Where does a user get their own API key?
There was a problem hiding this comment.
There is a link in the paragraphs above to create a new user. For existing users, there isn't a predictable link to get the api key because the url path contains the project slug. I guess we could be verbose here and give instructions, but I think that might be overkill?
| <meta charset="utf-8"> | ||
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> | ||
| <meta name="viewport" content="width=device-width,initial-scale=1.0"> | ||
| <link rel="shortcut icon" href="<%= webpackConfig.output.publicPath %>favicon.ico"> |
There was a problem hiding this comment.
What does this do? If this is common knowledge for JS devs then this is fine as is
There was a problem hiding this comment.
It is part of the output generated by vue-cli. Looks like it links to the static output dir to look for the favicon rather than the default path. I think it's fine to leave as-is – this is meant to be a project with more complexity and this is indicative of the kinds of things that will be going on in a bigger project.
| @@ -0,0 +1,63 @@ | |||
| <template> | |||
| <div class="hello"> | |||
| <p>This example shows how to initialize the <code>bugsnagClient</code> once and import<br/>it invarious parts of your application to report your own errors to Bugsnag.</p> | |||
| } | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
Might be nice to add a couple of short inline comments to explain what Bugsnag is capturing here
There was a problem hiding this comment.
What would you suggest? I think the part that says…
<p>Example: we want to know if a user ends up clicking this button more than 10 times.</p>
…explains the high level intention and…
bugsnagClient.notify(new Error('user clicked button too many times!'), { severity: 'info' })
…seems self explanatory:
- notify bugsnag
- with the error explaining "too many clicks"
- and the severity is "info"
There was a problem hiding this comment.
Maybe something very simple like:
// sends a handled Error to bugsnag
bugsnagClient.notify(e)
I don't think this is essential so it's up to you
fractalwrench
left a comment
fractalwrench
left a comment
There was a problem hiding this comment.
Left a few nits as inline comments, but I think this is mostly ready to go. Did we have any plans to build the example projects on CI at all?
|
Thanks for the comments! Updated the critical bits. Getting this on CI might be something that we want to do – though for it to be of any use we would need to build and run end-to-end tests on it, because it building is not a good indication of whether it will work or not. |
Uh oh!
There was an error while loading. Please reload this page.