JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 742
  • Score
    100M100P100Q97710F

The JavaScript Project Buildr. Built with Node.js and used by Aloha Editor and History.js

Package Exports

  • buildr

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (buildr) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Welcome to Buildr. The JavaScript Package Buildr.

Installation

npm install buildr

Note: if you would like to be able to compress image files, you will also need to follow the installation instructions here

Usage

buildr .

Configuration

Buildr does not require any configuration by default, but if you would like to configure it you can create a package.json file which contains the following keys a buildr key:

  • compress: a boolean value or an object, if an object:

    • js: a boolean value
    • css: a boolean value
    • img: a boolean value
    • html: a boolean value

  • check: a boolean value or an object, if an object:

    • js: a boolean value or a javascript filename
    • css: a boolean value or a css filename
    • jsOptions: a object

  • bundle: a boolean value or an object, if an object:

    • js: a boolean value or a javascript filename
    • css: a boolean value or a css filename
    • src: a boolean value; for whether or not we should bundle the source files too

  • directories: an object

    • out: a directory path; of where the compiled files will go
    • src: a directory path; of where source files come from

  • subpackages: an array; containing the locations of each subpackage to compress and bundle

  • files: an object

    • js: a boolean value or array; of javascript files to compress and bundle
    • css: a boolean value or array; of css files to compress and bundle
    • img: a boolean value or array; of css files to compress and bundle

  • templates: an object

    • out_bundle_header.js: a file path; to the header for the out bundled file
    • out_bundle_footer.js: a file path; to the footer for the out bundled file
    • out_bundle_item.js: a file path; to the replace string for each out bundled file
    • out_bundle_subpackage.js: a file path; to the replace string for each out bundled subpackage
    • src_bundle_header.js: a file path; to the header for the src bundled file
    • src_bundle_footer.js: a file path; to the footer for the src bundled file
    • src_bundle_item.js: a file path; to the replace string for each src bundled file
    • src_bundle_subpackage.js: a file path; to the replace string for each src bundled subpackage

License

Licensed under the MIT License Copyright 2011 Benjamin Arthur Lupton

Todo

  1. Make it asynchronous
  2. Turn the CSS minifier into it's own project