Skip to content

Latest commit

 

History

History
41 lines (24 loc) · 1.84 KB

options.md

File metadata and controls

41 lines (24 loc) · 1.84 KB

options

how to set

Options can be set by commandline args or through the options parameter using Vitreum as a requirable. You can also set defaults in your package.json using the vitreum key.

targets - array of paths to entry points for your web app

shared - array of paths vitreum will consider to be part of the require look-up paths. default: ['./client']

app - string path to the server entry point. default: pckg.main

prod - boolean flag to determine if vitreum should compress files. If not set defaults to true if NODE_ENV is set to production. default: process.env.NODE_ENV == 'production'

dev - boolean indicating to certain steps if we are doing a dev step. Automatically set by detecting environment, but you can manually set it. default: auto on env

static - boolean indicating if during a build vitreum should also render a static html version of each entry point. default: false

embed - boolean or array of regexes indicating which assets should be base64 encoding and embedding into the bundle. Not implimented yet.

bundle - an array of globs that should be ignored when considering which packages to bundle in libs.js. This is useful when using private npm modules. defaults: []

packagesToTransform - an array of package names that should be ignored when considering which packages to bundle in libs.js. This is useful when using private npm modules. defaults: []

template - string path to a js file that will be used to create the html renders for each entrypoint. default: vitreum/src/default.template.js

paths - an object that defines what paths and files naming conventions vitruem will use. defaults:

paths  : {
  build  : './build',
  code   : 'bundle.js',
  style  : 'bundle.css',
  render : 'render.js',
  static : 'static.html',
  libs   : 'libs.js'
}