Skip to content

Latest commit

 

History

History
215 lines (155 loc) · 63 KB

Settings.md

File metadata and controls

215 lines (155 loc) · 63 KB

Settings for roc-package-web-app-react-dev

Build

Build settings.

Name Description Path CLI option Default Type Required Can be empty Extensions
apollo The path to the file containing the Apollo configurations, expectedto export two functions (client, server). build.apollo --build-apollo "src/apollo.js" Filepath No No roc-package-web-app-react-dev
clientLoading The React component to use on the first client load while fetching data, will only be used if some blocking hooks are defined. build.clientLoading --build-clientLoading Filepath No No roc-package-web-app-react-dev
disableProgressbar Should the progress bar be disabled for builds. build.disableProgressbar --build-disableProgressbar false Boolean Yes roc-package-webpack-dev
koaMiddlewares The koa middlewares to add to the server instance, will be added after the default middlewares. build.koaMiddlewares --build-koaMiddlewares "src/server/middlewares.js" Filepath No No roc-package-web-app-dev
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 "app" Array(String) / String Yes No roc-package-webpack-dev
path The basepath for the application. build.path --build-path "/" Filepath Yes No roc-package-webpack-dev, roc-package-web-app-dev
reducers The reducers to use if no entry file is given, will use default entry files internally. build.reducers --build-reducers "src/redux/reducers.js" Filepath No No roc-package-web-app-react-dev
resources An array of files to include into the build process. build.resources --build-resources ["roc-package-web-app-react/styles/base.css"] Array(Filepath) Yes Yes roc-package-webpack-web-dev, roc-package-web-app-react-dev
routes The routes to use if no entry file is given, will use default entry files internally. build.routes --build-routes "src/routes/routes.js" Filepath No No roc-package-web-app-react-dev
targets For what targets the code should be built for. build.targets --build-targets ["web","node"] `Array(/^web node$/i)` No Yes
templateValues [UNDOCUMENTED] build.templateValues --build-templateValues "src/template-values.js" Unknown No Yes roc-package-web-app-react-dev
useDefaultKoaMiddlewares If Roc should use internally defined koa middlewares, please look at the documentation for what middlewares that are included. build.useDefaultKoaMiddlewares --build-useDefaultKoaMiddlewares true Boolean Yes roc-package-web-app-dev
useDefaultRoutes If Roc should use an internal wrapper around the routes, please look at the documentation for more details. build.useDefaultRoutes --build-useDefaultRoutes true Boolean Yes roc-package-web-app-react-dev
useReactRouterScrollAsync Use react-router-scroll-async middleware to help with scroll behavior for Single Page Applications. Disable this if SPA functionality is turned off. build.useReactRouterScrollAsync --build-useReactRouterScrollAsync true Boolean Yes roc-package-web-app-react-dev

Assets

Images

Settings for image asset related things.

FileLoader

Settings for https://github.com/webpack/file-loader

Name Description Path CLI option Default Type Required Can be empty Extensions
filetypes The filetypes that should be used together with file-loader. build.assets.images.fileLoader.filetypes --build-assets-images-fileLoader-filetypes ["jpg"] Array(String) Yes No roc-plugin-assets-images
Options

Options that will be used as query parameters.

✓ ― Supports __raw

Name Description Path CLI option Default Type Required Can be empty Extensions
name The name for the generated files. build.assets.images.fileLoader.options.name --build-assets-images-fileLoader-options-name "[hash].[ext]" String Yes No roc-plugin-assets-images
UrlLoader

Settings for https://github.com/webpack/url-loader

Name Description Path CLI option Default Type Required Can be empty Extensions
filetypes The filetypes that should be used together with url-loader. build.assets.images.urlLoader.filetypes --build-assets-images-urlLoader-filetypes ["png","svg"] Array(String) Yes No roc-plugin-assets-images
Options

Options that will be used as query parameters.

✓ ― Supports __raw

Name Description Path CLI option Default Type Required Can be empty Extensions
limit The maximum size (in bytes) for base64 encoding an image. build.assets.images.urlLoader.options.limit --build-assets-images-urlLoader-options-limit 10000 Integer Yes roc-plugin-assets-images

I18n

Name Description Path CLI option Default Type Required Can be empty Extensions
locales List of locales polyfills to load on the client - these are listed in the intl package (see node_modules/intl/locale-date/jsonp/. build.i18n.locales --build-i18n-locales [] Unknown No Yes roc-package-web-app-react-dev
usePolyfill If Roc should load Intl polyfill and locales on client and server. build.i18n.usePolyfill --build-i18n-usePolyfill false Unknown No Yes roc-package-web-app-react-dev

Input

Name Description Path CLI option Default Type Required Can be empty Extensions
node The node/server entry point file. build.input.node --build-input-node Filepath No No roc-package-web-app-dev, roc-package-web-app-react-dev
web The web/client entry point file. build.input.web --build-input-web Filepath No No roc-package-web-app-dev, roc-package-web-app-react-dev

Output

Name Description Path CLI option Default Type Required Can be empty Extensions
node The output directory for the server build. build.output.node --build-output-node "build/server" Filepath Yes No roc-package-web-app-dev
web The output directory for the client build. build.output.web --build-output-web "build/client" Filepath Yes No roc-package-web-app-dev

Redux

Name Description Path CLI option Default Type Required Can be empty Extensions
enhancers The enhancers to use if no entry file is given, will use default entry files internally. build.redux.enhancers --build-redux-enhancers "src/redux/enhancers.js" Filepath No No roc-package-web-app-react-dev
middlewares The middlewares to use if no entry file is given, will use default entry files internally. build.redux.middlewares --build-redux-middlewares "src/redux/middlewares.js" Filepath No No roc-package-web-app-react-dev
sagas The Redux Saga to use as the root saga. build.redux.sagas --build-redux-sagas "src/redux/sagas.js" Filepath No No roc-package-web-app-react-dev
useDefaultMiddlewares If Roc should use internally defined middlewares, please look at the documentation for what middlewares that are included. build.redux.useDefaultMiddlewares --build-redux-useDefaultMiddlewares true Boolean Yes roc-package-web-app-react-dev
useDefaultReducers If Roc should use internally defined reducers, please look at the documentation for what reducers that are included. build.redux.useDefaultReducers --build-redux-useDefaultReducers true Boolean Yes roc-package-web-app-react-dev

Style

Name Description Path CLI option Default Type Required Can be empty Extensions
minimize If minification should be enabled. build.style.minimize --build-style-minimize true Boolean No roc-plugin-style-css
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
sourceMap If CSS source maps should be enabled. build.style.sourceMap --build-style-sourceMap false Boolean No roc-plugin-style-css

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 / Array(String) No roc-plugin-style-css

Dev

Development settings.

Name Description Path CLI option Default Type Required Can be empty Extensions
a11y If A11Y validation should be active. Currently it´s suggested to not enable Redux Devtools with this. dev.a11y --dev-a11y false Boolean Yes roc-package-web-app-react-dev
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
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
watch Files/folders that should trigger a restart of the server. dev.watch --dev-watch ["roc.config.js","config/"] Filepath / Array(Filepath) Yes roc-package-webpack-node-dev, roc-package-web-app-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
host The host that Browsersync should use, will be automatic by default. dev.browsersync.options.host --dev-browsersync-options-host null String No No roc-plugin-browsersync
open Decide which URL to open automatically when Browsersync starts. Defaults to "local" if none set. Can be true, local, external, ui, ui-external, tunnel or false. dev.browsersync.options.open --dev-browsersync-options-open true `/^(external ui ui-external tunnel)$/ / Boolean`
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 false Boolean No roc-package-webpack-web-dev, roc-plugin-react-dev

Redux

DevTools

Name Description Path CLI option Default Type Required Can be empty Extensions
enabled If Redux Devtools should be enabled. dev.redux.devTools.enabled --dev-redux-devTools-enabled true Boolean Yes roc-package-web-app-react-dev
DockMonitor

✓ ― Supports __raw

Name Description Path CLI option Default Type Required Can be empty Extensions
changePositionKey The key that should change position of the Redux Devtools. dev.redux.devTools.dockMonitor.changePositionKey --dev-redux-devTools-dockMonitor-changePositionKey "ctrl-q" String Yes Yes roc-package-web-app-react-dev
defaultIsVisible If the Redux Devtools should be shown by default. dev.redux.devTools.dockMonitor.defaultIsVisible --dev-redux-devTools-dockMonitor-defaultIsVisible false Boolean Yes roc-package-web-app-react-dev
defaultPosition Starting position of the Devtools, can be left, right, top or bottom. dev.redux.devTools.dockMonitor.defaultPosition --dev-redux-devTools-dockMonitor-defaultPosition "right" `/^left right top bottom$/`
defaultSize Default size of the Devtools, should be a number between 0 and 1. dev.redux.devTools.dockMonitor.defaultSize --dev-redux-devTools-dockMonitor-defaultSize 0.3 Unknown No Yes roc-package-web-app-react-dev
toggleVisibilityKey The key that should toogle the Redux Devtools, will be combine with CTRL. dev.redux.devTools.dockMonitor.toggleVisibilityKey --dev-redux-devTools-dockMonitor-toggleVisibilityKey "ctrl-h" String Yes Yes roc-package-web-app-react-dev
Instrument

✓ ― Supports __raw

Name Description Path CLI option Default Type Required Can be empty Extensions
maxAge Maximum allowed actions to be stored on the history tree. Good if the application generates a lot of actions. dev.redux.devTools.instrument.maxAge --dev-redux-devTools-instrument-maxAge Integer No roc-package-web-app-react-dev
LogMonitor

✓ ― Supports __raw

Name Description Path CLI option Default Type Required Can be empty Extensions
theme The theme to use for the Redux Devtools, see https://github.com/gaearon/redux-devtools-themes for the available ones. dev.redux.devTools.logMonitor.theme --dev-redux-devTools-logMonitor-theme "ocean" String No Yes roc-package-web-app-react-dev

Logger

✓ ― Supports __raw

Name Description Path CLI option Default Type Required Can be empty Extensions
collapsed If the logged actions by Redux Logger should be collapsed by default. dev.redux.logger.collapsed --dev-redux-logger-collapsed true Boolean Yes roc-package-web-app-react-dev
duration If Redux Logger should print the duration of each action. dev.redux.logger.duration --dev-redux-logger-duration true Boolean Yes roc-package-web-app-react-dev
level The logging level for Redux Logger, can be either warn, error or info. dev.redux.logger.level --dev-redux-logger-level "info" `/^warn error info$/` Yes
timestamp If Redux Logger should print the timestamp with each action. dev.redux.logger.timestamp --dev-redux-logger-timestamp true Boolean Yes roc-package-web-app-react-dev

Yellowbox

Name Description Path CLI option Default Type Required Can be empty Extensions
enabled If YellowBox should be enabled. dev.yellowbox.enabled --dev-yellowbox-enabled true Boolean No roc-package-web-app-react-dev
ignore Array of prefix strings that should be ignored by YellowBox. dev.yellowbox.ignore --dev-yellowbox-ignore ["[HMR]","Warning: React attempted to reuse markup in a container"] Array(String) No Yes roc-package-web-app-react-dev