babel-plugin-mithril-add-data-attribute

babel-plugin-mithril-add-data-attribute

This plugin adds a data-component attribute to top-level DOM elements rendered by mithril component function m. Intended for development - bloats HTML. Helps debug: find your components in a large repo from generated HTML. Adds component name or file name to component data attributes which will be visible in the generated HTML.

• tries to figure out component name from function, class or variable def
• if no name found it tries to use the file name, so you'll know where to start
• when not resolvable: assumes attrs to be an object and getAttrs to be a function returning an attrs object

Needs more tests and better support, feel free to add issues with failing test code or commit a PR. Written in TypeScript. Not tested or used in production.

Examples

In

const Comp2 = () => m("div");

const MyComponent = () => {
  return m("div", m(Comp2));
};

Out

const Comp2 = () =>
  m("div", {
    "data-component": "Comp2",
  });

const MyComponent = () => {
  return m(
    "div",
    {
      "data-component": "MyComponent",
    },
    m(Comp2)
  );
};

For many more examples se test/index.test.js

Installation

# yarn
yarn add --dev babel-plugin-mithril-add-data-attribute

# npm
npm install --save-dev babel-plugin-mithril-add-data-attribute

Usage

Via .babelrc

.babelrc

{
  "env": {
    "development": {
      "plugins": ["mithril-add-data-attribute"]
    }
  }
}

(since it's not intended for production code)

Via CLI

babel --plugins mithril-add-data-attribute script.js

Via Node API

require("babel-core").transform("code", {
  plugins: ["mithril-add-data-attribute"],
});

Options

Under development.

Contribute

Please do. Add an issue or PR.