Skip to content
This repository has been archived by the owner on Jan 2, 2018. It is now read-only.

Latest commit

 

History

History
102 lines (76 loc) · 29.8 KB

Settings.md

File metadata and controls

102 lines (76 loc) · 29.8 KB

Settings for roc-package-web-component-dev

Build

Build settings.

Name Description Path CLI option Default Type Required Can be empty Extensions
disableProgressbar Should the progress bar be disabled for builds. build.disableProgressbar --build-disableProgressbar false Boolean Yes roc-package-webpack-dev
libraryTarget Which format to export the component as. build.libraryTarget --build-libraryTarget "umd" `/^var$ ^this$ ^commonjs$ ^commonjs2$
mode What mode the application should be built for. Possible values are "dev" and "dist". build.mode --build-mode "dist" `/^dev dist$/i` Yes No
name The name of the generated application bundle. build.name --build-name String Yes No roc-package-webpack-dev, roc-package-web-component-dev
path The basepath for the application. build.path --build-path "/" Filepath Yes No roc-package-webpack-dev
resources An array of files to include into the build process. build.resources --build-resources [] Array(Filepath) Yes Yes roc-package-webpack-web-dev
targets For what targets the code should be built for. build.targets --build-targets ["web","cjs","esm"] `Array(/^web$ ^cjs$ ^esm$/i)` Yes

Input

Name Description Path CLI option Default Type Required Can be empty Extensions
cjs What directory to build from. build.input.cjs --build-input-cjs "src" Filepath Yes No roc-package-web-component-dev
esm What directory to build from. build.input.esm --build-input-esm "src" Filepath Yes No roc-package-web-component-dev
web What file to use as entry file. build.input.web --build-input-web "src/index.js" Filepath Yes No roc-package-web-component-dev

Output

Name Description Path CLI option Default Type Required Can be empty Extensions
cjs The output directory for the CommonJS build. build.output.cjs --build-output-cjs "build/cjs" Filepath Yes No roc-package-module-dev, roc-package-web-component-dev
esm The output directory for the ES Modules build. build.output.esm --build-output-esm "build/esm" Filepath Yes No roc-package-module-dev, roc-package-web-component-dev
web The output directory for the Web build. build.output.web --build-output-web "build/web" Filepath Yes No roc-package-web-component-dev

Style

Name Description Path CLI option Default Type Required Can be empty Extensions
modules If CSS Modules should be enabled. build.style.modules --build-style-modules true Boolean Yes roc-plugin-style-css
name The naming pattern to use for the built style files. build.style.name --build-style-name "[name].[hash].css" String Yes No roc-plugin-style-css, roc-package-web-component-dev

Autoprefixer

✓ ― Supports __raw

Name Description Path CLI option Default Type Required Can be empty Extensions
browsers What browsers that should be supported. build.style.autoprefixer.browsers --build-style-autoprefixer-browsers "last 2 version" String No No roc-plugin-style-css

Dev

Development settings.

Name Description Path CLI option Default Type Required Can be empty Extensions
debug Filter for debug messages that should be shown during development, see https://npmjs.com/package/debug. dev.debug --dev-debug String No No roc-abstract-package-base-dev
demoPort The port that the demo server starts on. dev.demoPort --dev-demoPort 3002 Integer Yes roc-package-web-component-dev
host The host to use during development, will be automatically defined if left empty. dev.host --dev-host String No No roc-package-webpack-dev
port Port for the dev server. dev.port --dev-port 3001 Integer Yes roc-package-webpack-dev
serve What folders that the development server should expose. dev.serve --dev-serve [] Array(String) Yes Yes roc-package-web-component-dev

Browsersync

Name Description Path CLI option Default Type Required Can be empty Extensions
enabled If Browsersync should be enabled. dev.browsersync.enabled --dev-browsersync-enabled true Boolean Yes roc-plugin-browsersync

Options

✓ ― Supports __raw

Name Description Path CLI option Default Type Required Can be empty Extensions
open If Browsersync should open when the server is ready. dev.browsersync.options.open --dev-browsersync-options-open true Boolean Yes roc-plugin-browsersync
port The port that Browsersync should start on, should be a range of at least 2. dev.browsersync.options.port --dev-browsersync-options-port 3030 Integer Yes roc-plugin-browsersync

DevMiddleware

Settings for webpack-dev-middleware. https://github.com/webpack/webpack-dev-middleware

✓ ― Supports __raw

Name Description Path CLI option Default Type Required Can be empty Extensions
aggregateTimeout Fire aggregated events at interval. dev.devMiddleware.aggregateTimeout --dev-devMiddleware-aggregateTimeout Integer No roc-package-webpack-web-dev
noInfo If no info should be sent to the console. dev.devMiddleware.noInfo --dev-devMiddleware-noInfo true Boolean No roc-package-webpack-web-dev
poll If polling should be enabled. dev.devMiddleware.poll --dev-devMiddleware-poll false Boolean / Integer No roc-package-webpack-web-dev
quiet If nothing should be sent to the console. dev.devMiddleware.quiet --dev-devMiddleware-quiet false Boolean No roc-package-webpack-web-dev

HotMiddleware

Settings for webpack-hot-middleware. https://github.com/glenjamin/webpack-hot-middleware

✓ ― Supports __raw

Name Description Path CLI option Default Type Required Can be empty Extensions
noInfo If no info should be sent to the console. dev.hotMiddleware.noInfo --dev-hotMiddleware-noInfo false Boolean No roc-package-webpack-web-dev
overlay If a overlay should be shown when an error has occurred. dev.hotMiddleware.overlay --dev-hotMiddleware-overlay true Boolean No roc-package-webpack-web-dev
quiet If nothing should be sent to the console. dev.hotMiddleware.quiet --dev-hotMiddleware-quiet false Boolean No roc-package-webpack-web-dev
reload If the browser should be reloaded if it fails to hot update the code. dev.hotMiddleware.reload --dev-hotMiddleware-reload true Boolean No roc-package-webpack-web-dev

Template

Name Description Path CLI option Default Type Required Can be empty Extensions
customVariables An object representing custom variables to expose to the dev template. The properties of the object can be referenced in the template by using {{ customVariables.myPropertyName }}. dev.template.customVariables --dev-template-customVariables {} Object() Yes Yes roc-package-web-component-dev
path Path to a directory where the template can be found, can be both relative based on current working directory or absolute. Uses nunjucks and two variables are available, "name" and "bundlePath". dev.template.path --dev-template-path Filepath No No roc-package-web-component-dev