mrozbarry / hyperapp-debug

A debug HOA for hyperapp
MIT License
12 stars 0 forks source link
debug hyperapp

Hyperapp Debug

Mozilla Add-on Travis CI npm Slack

A debugger for your Hyperapp applications.

What is it

hyperapp-debug is a browser extension and higher-order app wrapper for your hyperapp applications. It is a tool similar to redux-dev-tools or vue-dev-tools, with tighter integration to the Hyperapp paradigm. To debug your application, you must install the browser extension. Don't worry, I don't collect any information at all, and the addon will always be free.

Hyperapp V1

If you are debugging Hyperapp V1 applications, check out the legacy debugger.

Installation

Install with npm or Yarn.

npm i hyperapp-debug

Then with a module bundler like Rollup or Webpack, use as you would anything else.

import { app, h } from 'hyperapp';
import withDebug from 'hyperapp-debug';

Or with <script type="module"> and unpkg:

import { app, h } from 'https://unpkg.com/hyperapp?module=1';
import withDebug from 'https://unpkg.com/hyperapp-debug?module=1';

If you don't want to set up a build environment, you can download Hyperapp Debug from a CDN like unpkg.com, and it will be globally available through the window['hyperapp-debug'].default object. hyperapp-debug supports all ES5-compliant browsers, including Internet Explorer 10 and above.

<head>
  <script src="https://unpkg.com/hyperapp"></script>
  <script src="https://unpkg.com/hyperapp-debug"></script>
</head>
<body>
  <script>
    const { app, h } = window.hyperapp;
    const withDebug = window['hyperapp-debug'].default;
    // Your code here...
  </script>
</body>

Usage

Use debug to wrap Hyperapp's app function.

import { app } from 'hyperapp';
import withDebug from 'hyperapp-debug';

withDebug(app)({
  init: {},
  view: () => null,
  subscriptions: () => [],
  node: document.getElementById('your-app'),
});

The debugger will only work if you also install the Firefox/Chrome Extension.

History

For those coming from the elm community, you may notice much inspiration from Elm's time-travelling debugger :heart:.

Contributing

Check out the CONTRIBUTING.md guidelines for more information.

License

Hyperapp Debug is MIT licensed. See LICENSE.md.

Other similar tools