The problem

The problem your plugin solves

more resources the user shoudl read

This solution

What this plugin does

How this plugin works

Table of Contents

• Installation
• Usage
  • first usage style
  • usage style 2
• Configure with Babel
  • Via .babelrc (Recommended)
  • Via CLI
  • Via Node API
• Use with babel-plugin-macros
  • APIs not supported by the macro
• Caveats
• Examples
• Inspiration
• Other Solutions
• Contributors
• LICENSE

Installation

This module is distributed via npm which is bundled with node and should be installed as one of your project's devDependencies:

npm install --save-dev babel-plugin-boilerplate

Usage

More notes on usage

first usage style

Before:

// before

After some notes here:

// after

more notes here!

Before:

// before

After more notes here:

// after

usage style 2

Before:

// before

After more notes here:

// after

Configure with Babel

Via .babelrc (Recommended)

.babelrc

{
  "plugins": ["BOILERPLATE"]
}

Via CLI

babel --plugins BOILERPLATE script.js

Via Node API

require('babel-core').transform('code', {
  plugins: ['BOILERPLATE'],
})

Use with babel-plugin-macros

Once you've configured babel-plugin-macros you can import/require the boilerplate macro at babel-plugin-boilerplate/macro. For example:

import yourmacro from 'babel-plugin-boilerplate/macro'

// user yourmacro

      ↓ ↓ ↓ ↓ ↓ ↓

// output

APIs not supported by the macro

• one
• two

You could also use boilerplate.macro if you'd prefer to type less 😀

Caveats

any caveats you like to say

Examples

• Some examples and links here

Inspiration

This is based on babel-plugin-boilerplate.

Other Solutions

I'm not aware of any, if you are please make a pull request and add it here!

Contributors

Thanks goes to these people (emoji key):

| Kent C. Dodds💻 📖 🚇 ⚠️ | Michael Rawlings💻 📖 ⚠️ | Jan Willem Henckel💻 📖 ⚠️ | Karan Thakkar📖 | | :---: | :---: | :---: | :---: |

This project follows the all-contributors specification. Contributions of any kind welcome!

LICENSE

MIT