Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including @wheelroom/wheelroom-plugin-boilerplate with all npm packages installed. Try it out:

var wheelroomPluginBoilerplate = require("@wheelroom/wheelroom-plugin-boilerplate")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

@wheelroom/wheelroom-plugin-boilerplate v3.1.11

Site framework based on Contentful and Gatsby

@wheelroom/wheelroom-plugin-boilerplate

This is a plugin for the @wheelroom/wheelroom package.

Have a look at the boilerplate to so see how to use this.

Commands

This plugin adds the create-boilerplate command which lets you create boilerplate code from component data.

wheelroom create-boilerplate <template-set> <path> [options]

Config

The plugin is configured by adding it to wheelroom-config.js

var templateSets = require('./wheelroom-template-sets')

module.exports = {
  components: {
      ...
  },
  plugins: [
    {
      resolve: '@wheelroom/wheelroom-plugin-boilerplate',
      options: {
        templateSets: templateSets,
      },
    },
  ],
}

Template sets

Using typescript, template sets are defined like this.

import { TemplateSets } from '@wheelroom/wheelroom-plugin-boilerplate'
import { component } from './component'
import { componentIndex } from './component-index'
import { componentReadme } from './component-readme'
import { componentVariation } from './component-variation'

export const templateSets: TemplateSets = {
  components: {
    component: {
      filterComponentSetting: 'asBoilerplate',
      path: '%component-name%/%component-name%.tsx',
      template: component,
    },
    componentBasicVar: {
      filterComponentSetting: 'asBoilerplate',
      path: '%component-name%/%component-name%-%variation-name%-var.tsx',
      template: componentVariation,
    },
    componentIndex: {
      filterComponentSetting: 'asBoilerplate',
      path: '%component-name%/index.ts',
      template: componentIndex,
    },
    componentReadme: {
      filterComponentSetting: 'asBoilerplate',
      path: '%component-name%/README.md',
      template: componentReadme,
    },
  },
}
RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free