npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

electrum-compiler

v1.9.0

Published

Run-time compiler for Electrum-enabled React components.

Downloads

3

Readme

electrum-compiler

NPM version Build Status Build status

This is a run-time compiler for Electrum-enabled React components, based on Babel. It is relying on babel-standalone for the real work and provides additional logic to build live React components directly from source code.

The Compiler class

Transform JavaScript to ES5

To transform JavaScript to ES5, use:

  • transform(input) → produces ES5 output based on the JavaScript source.
let input = 'const greet = x => `Hello ${x}.`;';
let compiler = new Compiler ();
let source = compiler.transform (input);
// ES5 compatible source

Build Electrum-enabled React component

To build an Electrum-enabled React component, use:

  • build(name, input) → produces a component description; the name of the compoment will be name and its source code defined by input, which must be a source containing a class definition.
  • build(name, input, locals) → same as above, but inject the key/value pairs found in locals into the compilation context.
  • build(name, input, locals, more) → same as above, more represents additional source code which will be provided to Electrum.wrap() as the more argument (it can be used to bind the component with styles).
let input = 'class extends React.Component { render() { return <div>Hi.</div>; } }';
let compiler = new Compiler ();
let output = compiler.build ('Foo', input);
// Component in output.component

If the source code needs to reference external symbols (for instance other components), they must be registered before calling build():

let input = `
class extends React.Component {
  render() {
    return <Button>{text}</Button>;
  }
}`;

let compiler = new Compiler ();

compiler.register (Button);
compiler.register ('text', 'Hello')

let output = compiler.build ('Foo', input);
// Component in output.component

The output of build() is an object with following properties:

  • name → name of the component.
  • code → source code used to produce the component.
  • component → the component.
  • error → the error (if there was an error).

Properties code and component are only present if the call to build() was successful. Otherwise, the error message is stored in error.

Note that the position in the error message will be offset by one line, as build() prepends some code to the given input source.

Accessing the catalog

Items registered on the compiler with register() are stored in a catalog. The catalog can be retrieved through the catalog getter:

let compiler = new Compiler ();

compiler.register ('x', {a: 1});
compiler.register ('y', {b: 2});

expect (compiler.catalog.x).to.have.property ('a', 1);
expect (compiler.catalog.y).to.have.property ('b', 2);

Evaluating an expression

The compiler also includes an ES6/JSX compatible version of eval() which can be used to evaluate expressions:

let compiler = new Compiler ();

expect (compiler.eval ('2 + 3')).to.equal (5);
expect (compiler.eval ('<div></div>')).to.equalJSX (<div />);