Package Exports

handroll

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 (handroll) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

handroll

Expertly rolled JavaScript

JavaScript API and CLI for for bundling opinionated JavaScript with Rollup. Tastes great with shortcake.

Install

$ npm install handroll --save-dev

CLI

$ handroll src/index.coffee --format web > index.js

JavaScript API

As magical as possible. Built-in support for CoffeeScript, Stylus and Pug. Rollup.js options, plugins and write destination are automatically derived for you from format option in most instances. Defaults can of course be easily over-written.

import handroll from 'handroll'

bundle = handroll.bundle
  entry: 'src/index.coffee'  # Path to entry module

  # The following defaults may configured to customize logging and override the
  # behavior of handroll.
  # cache:      true    Enable automatic caching
  # es3:        false   Emit slightly more ES3-compliant output
  # sourceMap:  true    Collect and save source maps
  # strip:      false   Remove debugging and console log statements
  # executable: false   Include shebang and chmod+x output
  # quiet:      false   Suppress default output
  # verbose:    false   Print extra details about bundle

# Save ES module for use by bundlers...
await bundle.save
  format:     'es'
  # dest:     pkg.module
  # external: true

# Save CommonJS module for use by Node.js...
await bundle.save
  format: 'cjs'
  # dest: pkg.main
  # external: true

# Save bundle + deps for use on the web...
await bundle.save
  format:       'web'
  # dest:       pkg.name + '.js'
  # es3:        true
  # moduleName: camelCase pkg.name

# Save binary with shebang for quick cli, using top-level save method and new
# entry module...
await handroll.save
  entry:        'src/cli.coffee'
  format:       'cli'
  # dest:       pkg.bin
  # executable: true
  # external:   true

Motivating example

autoTransform = require 'rollup-plugin-auto-transform'
builtins      = require 'rollup-plugin-node-builtins'
coffee        = require 'rollup-plugin-coffee-script'
commonjs      = require 'rollup-plugin-commonjs'
filesize      = require 'rollup-plugin-filesize'
globals       = require 'rollup-plugin-node-globals'
json          = require 'rollup-plugin-json'
nodeResolve   = require 'rollup-plugin-node-resolve'
pug           = require 'rollup-plugin-pug'
rollup        = require 'rollup'
stylup        = require 'rollup-plugin-stylup'

postcss      = require 'poststylus'
autoprefixer = require 'autoprefixer'
comments     = require 'postcss-discard-comments'
lost         = require 'lost-stylus'

pkg         = require './package.json'

plugins = [
  autoTransform()
  globals()
  builtins()
  coffee()
  pug
    pretty:                 true
    compileDebug:           true
    sourceMap:              false
    inlineRuntimeFunctions: false
    staticPattern:          /\S/
  stylup
    sourceMap: false
    plugins: [
      lost()
      postcss [
        autoprefixer browsers: '> 1%'
        'lost'
        'css-mqpacker'
        comments removeAll: true
      ]
    ]
  json()
  nodeResolve
    browser: true
    extensions: ['.js', '.coffee', '.pug', '.styl']
    module: true
    jsnext: true
  commonjs
    extensions: ['.js', '.coffee']
    sourceMap: false
  filesize()
]

bundle = await rollup.rollup
  entry:    'src/app.coffee'
  plugins:  plugins

# App bundle for browser
await bundle.write
  dest:      'public/js/app.js'
  format:    'iife'

..and that's with all the necessary scaffolding omitted.

License

MIT