Code Monkey home page Code Monkey logo

nib-component-builder's Introduction

nib-component-builder

One stop method for building JS, CSS and other assets with the Component builder.

Methods

build(directory : String, options : Object, callback : function(errors : Array))

  • directory - The component directory
  • options - The builder options
  • callback - The builder callback called when the component has been built

Options

/**
 * @param   {string}    directory                     The component directory
 * @param   {object}    options                       The build options
 * @param   {boolean}   [options.install=true]        Whether the dependencies should be installed
 * @param   {boolean}   [options.require=true]        Whether the require method should be included in the outputted script (only one script on the page needs this)
 * @param   {boolean}   [options.autorequire=true]    Whether to automatically require the canonical component
 * @param   {boolean}   [options.development=false]   Whether the development dependencies should be built
 * @param   {boolean}   [options.verbose=false]       Whether to print warnings and status messages to stdout
 * @param   {boolean}   [options.scripts=true]        Whether to build the scripts
 * @param   {boolean}   [options.styles=true]         Whether to build the styles
 * @param   {boolean}   [options.files=true]          Whether to build the files
 * @param   {string}    [options.installDir]          The directory where the components are installed to
 * @param   {string}    [options.buildDir]            The directory where the components are built to
 * @param   {string}    [options.scriptBuildFile]     The name of the script build file e.g. build.js
 * @param   {string}    [options.styleBuildFile]      The name of the style build file e.g. build.css
 * @param   {function}  callback                      The callback
 */

Usage

require('nib-component-builder')('C:\\temp\\app', {}, function(err) {
  if (err.length) {
    console.log(err);
  } else {
    console.log('done');
  }
});

nib-component-builder's People

Contributors

benjaminwilliams avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.