@psychobolt/generator-react-renderer v0.0.8

Generator React Renderer

Yeoman generator for scaffolding extensible ES6 React Fiber renderers. NOTE: Includes a synchronous and experimental configuration of React reconciler, which is currently being used for my React renderer libraries.

Install

npm install -g @psychobolt/generator-react-renderer
# or
yarn global add @psychobolt/generator-react-renderer

Usage

With yo:

yo @psychobolt/react-renderer # (Recommended) Runs all sub generators - see section bellow.

Sub Generators

Types

Scaffolds a Instance factory template to be invoked in Reconciler's createInstance.

yo @psychobolt/react-renderer:Types 

Component

Scaffolds a file that exports helper functions for renderer.

yo @psychobolt/react-renderer:Component

Renderer

Scaffolds a React ES6 Renderer class.

yo @psychobolt/react-renderer:Renderer types.js component.js

ES6 class Renderer allows third-party extensions.

import React from 'React';
import Renderer from './renderer'

import MyCustomType from './MyCustomType';

export default class MyCustomRenderer extends Renderer {
  getInstanceFactory() {
    return {
      ...this.defaultTypes,
      [MyCustomType.TYPE_NAME]: (props, container) => new MyCustomType(props),
    };
  }
}

Container

Scaffolds a ES6 class Component Container which forwards the children node to the default renderer.

yo @psychobolt/react-renderer:Container CustomRenderer renderer.js types.js

You can override the default renderer.

import CustomContainer from './container'
import MyCustomType from './MyCustomType';

import MyCustomRenderer from './MyCustomRenderer'

export default () => (
  <CustomContainer renderer={MyCustomRenderer}>
    <MyCustomType />
  </CustomContainer>
);

Provider

Enables forwarding of the context, including container object, to child nodes.

yo @psychobolt/react-renderer:Provider CustomRenderer renderer.js types.js

Opt-in child nodes with the context:

import CustomContainer from './container';
import { Context } from './provider';

import MyCustomType from './MyCustomType';

export default () => (
  <CustomContainer>
    <Context.Consumer>
      {({ container }) => <MyCustomType container={containter} />}
    </Context.Consumer>
  </CustomContainer>
);

Module

Organizes scripts into a module.

# without Container
yo @psychobolt/react-renderer:Module CustomRenderer renderer.js types.js component.js
# with Container
yo @psychobolt/react-renderer:Module CustomRenderer renderer.js types.js component.js CustomContainer container.js
# with Provider
yo @psychobolt/react-renderer:Module CustomRenderer renderer.js types.js component.js CustomContainer container.js CustomProvider provider.js

Dependencies

Installs NPM dependencies. See packages.

yo @psychobolt/react-renderer:Dependencies