mattdesl / error-help

simple error helper utility for client-side JavaScript

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

error-help

A standalone JavaScript file (error-help.js) that you can add to your HTML to improve the debugging experience when developing HTML/JS projects, without having to open your DevTools console.

This is particularly targeted towards new JavaScript coders and making it a bit easier to get started with the language.

error

Features:

  • On error, logs the file, line number, column, and error message
  • If possible, shows a link to MDN docs explaining the error, for example "x" is not defined.
  • Also fetches the text of the originating file to show the code causing the error
  • Can optionally de-duplicate console spam, in order to clean it up a bit (usueful for animation-based projects that may log errors at 60FPS)

Gotchas:

  • Best used for static workflows (i.e. no Webpack/Parcel/etc bundlers)
  • You may want to disable this for production

Usage with CDN

Include like so in your project, in the HEAD before all other script tags:

  ...
  <head>
    <script src="https://cdn.jsdelivr.net/npm/error-help@1.0.8/error-help.js"></script>
  </head>
  ...

Usage without CDN

You can download error-help.js, add it to your folder, and locally reference it like so:

  ...
  <head>
    <script src="./error-help.js"></script>
  </head>
  ...

Log Spam Deduplication

If you pass dedupe-logs attribute to the script tag, it will deduplicate console logs that repeat 10 or more times within 1.5 second intervals. This is helpful when working on CodeSandbox in an animated sketch (e.g. with p5.js), to avoid 60FPS console logs slowing down the browser experience.

Example:

  ...
  <head>
    <script
      src="https://cdn.jsdelivr.net/npm/error-help@1.0.8/error-help.js"
      dedupe-logs></script>
  </head>
  ...

License

MIT, see LICENSE.md for details.

About

simple error helper utility for client-side JavaScript

License:MIT License


Languages

Language:JavaScript 98.3%Language:HTML 1.7%