boilerplate

boilerplate

Tools and conventions for authoring and publishing boilerplates that can be generated by any build system or generator.

Welcome to boilerplate! Here you'll find both the tools and conventions for creating project boilerplates.

Table of contents

• Example
• QA
• Install
• Usage
• API
• Related projects
• Test coverage
• Running tests
• Contributing
• Author
• License

(Table of contents generated by verb)

Example

This example shows how easy it is to convert an existing project into a Boilerplate project using the most popular boilerplate of them all: html5-boilerplate.

First, install boilerplate and html5-boilerplate:

$ npm i boilerplate && git clone https://github.com/h5bp/html5-boilerplate.git vendor/h5bp

The following examples returns a normalized configuration object for every file in the html5-boilerplate project, organized exactly the way the project itself is organized.

var Boilerplate = require('boilerplate');
var h5bp = new Boilerplate({
  options: {
    cwd: 'vendor/h5bp/dist'
  },
  root: {src: ['{.*,*.*}'],   dest: 'src/'},
  css:  {src: ['css/*.css'],  dest: 'src/'},
  doc:  {src: ['doc/*.md'],   dest: 'src/'},
  js:   {src: ['js/**/*.js'], dest: 'src/'}
});
console.log(h5bp);

Results in the following object:

{
  options: {
    cwd: 'vendor/h5bp/dist'
  },
  config: {},
  targets: {
    root: {
      options: {
        cwd: 'vendor/h5bp/dist'
      },
      files: [
        {
          src: [
            'vendor/h5bp/dist/.DS_Store',
            'vendor/h5bp/dist/.editorconfig',
            'vendor/h5bp/dist/.gitattributes',
            'vendor/h5bp/dist/.gitignore',
            'vendor/h5bp/dist/.htaccess',
            'vendor/h5bp/dist/404.html',
            'vendor/h5bp/dist/apple-touch-icon.png',
            'vendor/h5bp/dist/browserconfig.xml',
            'vendor/h5bp/dist/crossdomain.xml',
            'vendor/h5bp/dist/favicon.ico',
            'vendor/h5bp/dist/humans.txt',
            'vendor/h5bp/dist/index.html',
            'vendor/h5bp/dist/LICENSE.txt',
            'vendor/h5bp/dist/robots.txt',
            'vendor/h5bp/dist/tile-wide.png',
            'vendor/h5bp/dist/tile.png'
          ],
          dest: 'src/',
          options: {
            cwd: 'vendor/h5bp/dist'
          },
          name: 'scaffold'
        }
      ]
    },
    css: {
      options: {
        cwd: 'vendor/h5bp/dist'
      },
      files: [
        {
          src: [
            'vendor/h5bp/dist/css/main.css',
            'vendor/h5bp/dist/css/normalize.css'
          ],
          dest: 'src/',
          options: {
            cwd: 'vendor/h5bp/dist'
          },
          name: 'scaffold'
        }
      ]
    },
    doc: {
      options: {
        cwd: 'vendor/h5bp/dist'
      },
      files: [
        {
          src: [
            'vendor/h5bp/dist/doc/css.md',
            'vendor/h5bp/dist/doc/extend.md',
            'vendor/h5bp/dist/doc/faq.md',
            'vendor/h5bp/dist/doc/html.md',
            'vendor/h5bp/dist/doc/js.md',
            'vendor/h5bp/dist/doc/misc.md',
            'vendor/h5bp/dist/doc/TOC.md',
            'vendor/h5bp/dist/doc/usage.md'
          ],
          dest: 'src/',
          options: {
            cwd: 'vendor/h5bp/dist'
          },
          name: 'scaffold'
        }
      ]
    },
    js: {
      options: {
        cwd: 'vendor/h5bp/dist'
      },
      files: [
        {
          src: [
            'vendor/h5bp/dist/js/main.js',
            'vendor/h5bp/dist/js/plugins.js',
            'vendor/h5bp/dist/js/vendor/jquery-1.11.3.min.js',
            'vendor/h5bp/dist/js/vendor/modernizr-2.8.3.min.js'
          ],
          dest: 'src/',
          options: {
            cwd: 'vendor/h5bp/dist'
          },
          name: 'scaffold'
        }
      ]
    }
  }
}

QA

What is a boilerplate?

A boilerplate is a project with generic, reusable code, files or content that is intended to be used as a starting point for creating new projects.

What does this project provide?

• opinionated conventions for defining and organizing project boilerplates
• API for actually creating boilerplates
• documentation and guide to help you get started with authoring your own boilerplates
• website for discovering boilerplates created by the community

What does this NOT provide?

Workflows and tools for actually generating new projects from a boilerplate. This is a job much better suited to build systems like assemble, gulp, grunt, and yeoman.

If you publish a library that works with Boilerplate, please let us know about it!

Install

Install with npm

$ npm i boilerplate --save

Usage

var boilerplate = require('boilerplate');

API

Boilerplate

Create an instance of Boilerplate with the given options

Params

• options {Object}

Example

var boilerplate = new Boilerplate({
  templates: {
    files: [{src: 'templates/*.hbs', dest: 'src/'}]
  }
});

.target

Register a boilerplate target with the given name and configuration options. A target is just a way to organize the files or content of a boilerplate into smaller groups.

Params

• name {String}: The name of the target.
• config {Object}: The configuration to use.
• returns {Object}

Example

boilerplate.target('webapp', ...);

Related projects

• assemble: Static site generator for Grunt.js, Yeoman and Node.js. Used by Zurb Foundation, Zurb Ink, H5BP/Effeckt,… more | homepage
• boilerplate: Tools and conventions for authoring and publishing boilerplates that can be generated by any build… more | homepage
• scaffold: Conventions and API for creating scaffolds that can by used by any build system or… more | homepage
• template: Render templates using any engine. Supports, layouts, pages, partials and custom template types. Use template… more | homepage

Test coverage

As of September 04, 2015:

Statements   : 100% (40/40)
Branches     : 100% (24/24)
Functions    : 100% (4/4)
Lines        : 100% (39/39)

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2015 Jon Schlinkert Released under the MIT license.

This file was generated by verb-cli on September 04, 2015.