From 2ac58505ed22f67027e6da01d1235851fd4b7a58 Mon Sep 17 00:00:00 2001 From: Gustaf Dalemar Date: Wed, 19 Oct 2016 12:04:58 +0200 Subject: [PATCH] Version 1.0.0-beta.5 --- .../docs/Commands.md | 12 +- .../docs/Configuration.md | 7 +- .../docs/Extensions.md | 6 +- .../docs/Hooks.md | 34 +-- .../docs/Settings.md | 200 +++++++++--------- .../package.json | 2 +- .../docs/Dependencies.md | 15 +- .../docs/Extensions.md | 4 +- .../roc-package-web-app-react/docs/Hooks.md | 2 +- .../docs/Settings.md | 122 +++++------ .../roc-package-web-app-react/package.json | 2 +- 11 files changed, 208 insertions(+), 198 deletions(-) diff --git a/extensions/roc-package-web-app-react-dev/docs/Commands.md b/extensions/roc-package-web-app-react-dev/docs/Commands.md index b96712c..af8b167 100644 --- a/extensions/roc-package-web-app-react-dev/docs/Commands.md +++ b/extensions/roc-package-web-app-react-dev/docs/Commands.md @@ -41,9 +41,9 @@ roc development build [targets] #### Arguments -| Name | Description | Default | Type | Required | Can be empty | -| ------- | -------------------------------------------------------------------------------- | ------- | ---------- | -------- | ------------ | -| targets | The targets the project should be built for, overrides the settings if provided. | | `[String]` | No | Yes | +| Name | Description | Default | Type | Required | Can be empty | +| ------- | -------------------------------------------------------------------------------- | ------- | --------------- | -------- | ------------ | +| targets | The targets the project should be built for, overrides the settings if provided. | | `Array(String)` | No | Yes | #### Settings options * [build](docs/Settings.md#build) @@ -73,9 +73,9 @@ roc development dev [targets] #### Arguments -| Name | Description | Default | Type | Required | Can be empty | -| ------- | -------------------------------------------------------------------------------- | ------- | ---------- | -------- | ------------ | -| targets | The targets the project should be built for, overrides the settings if provided. | | `[String]` | No | Yes | +| Name | Description | Default | Type | Required | Can be empty | +| ------- | -------------------------------------------------------------------------------- | ------- | --------------- | -------- | ------------ | +| targets | The targets the project should be built for, overrides the settings if provided. | | `Array(String)` | No | Yes | #### Settings options _All groups are available._ diff --git a/extensions/roc-package-web-app-react-dev/docs/Configuration.md b/extensions/roc-package-web-app-react-dev/docs/Configuration.md index baf304f..598320b 100644 --- a/extensions/roc-package-web-app-react-dev/docs/Configuration.md +++ b/extensions/roc-package-web-app-react-dev/docs/Configuration.md @@ -2,7 +2,12 @@ Configuration that can be defined in `roc.config.js`, other than settings and project. +## `babel` +Babel configuration that can be either a plain object or a function that gets target as argument + +__Extensions__: roc-plugin-babel + ## `webpack` Can be either a function or a plain object. If it is a function the argument will be `target`. -__Extensions__: roc-package-webpack-dev \ No newline at end of file +__Extensions__: roc-package-webpack-dev diff --git a/extensions/roc-package-web-app-react-dev/docs/Extensions.md b/extensions/roc-package-web-app-react-dev/docs/Extensions.md index 5107fe7..1e63b9c 100644 --- a/extensions/roc-package-web-app-react-dev/docs/Extensions.md +++ b/extensions/roc-package-web-app-react-dev/docs/Extensions.md @@ -9,7 +9,7 @@ Package forming an abstract foundation of the Roc ecosystem. The package serves as a base from which other `dev` packages within the ecosystem are to be constructed. It is therefore _never to be included_ as a direct dependency in app or component projects. -### roc-package-webpack-dev — [v1.0.0-beta.2](https://www.npmjs.com/package/roc-package-webpack-dev) +### roc-package-webpack-dev — [v1.0.0-beta.3](https://www.npmjs.com/package/roc-package-webpack-dev) Package providing module support. ### roc-package-webpack-node-dev — [v1.0.0-beta.2](https://www.npmjs.com/package/roc-package-webpack-node-dev) @@ -22,7 +22,7 @@ Package providing browser support through Webpack for Roc (Development) Package for building web applications using Roc (Development) ## Plugins -### roc-plugin-babel — [v1.0.0-beta.2](https://www.npmjs.com/package/roc-plugin-babel) +### roc-plugin-babel — [v1.0.0-beta.3](https://www.npmjs.com/package/roc-plugin-babel) Roc plugin that adds basic Babel management ### roc-plugin-browsersync — [v1.0.0-beta.2](https://www.npmjs.com/package/roc-plugin-browsersync) @@ -34,5 +34,5 @@ Plugin providing CSS support for Webpack in Roc ### roc-plugin-assets-images — [v1.0.0-beta.2](https://www.npmjs.com/package/roc-plugin-assets-images) Adds image loading support to Roc -### roc-plugin-react-dev — [v1.0.0-beta.2](https://www.npmjs.com/package/roc-plugin-react-dev) +### roc-plugin-react-dev — [v1.0.0-beta.3](https://www.npmjs.com/package/roc-plugin-react-dev) Adds React support to Webpack and Roc (Development) diff --git a/extensions/roc-package-web-app-react-dev/docs/Hooks.md b/extensions/roc-package-web-app-react-dev/docs/Hooks.md index 5d5cdd2..8f28810 100644 --- a/extensions/roc-package-web-app-react-dev/docs/Hooks.md +++ b/extensions/roc-package-web-app-react-dev/docs/Hooks.md @@ -29,7 +29,7 @@ Expected to return new settings that should be merged with the existing ones. Makes it possible to modify the settings object before a command is started and after potential arguments from the command line and configuration file have been parsed. This is a good point to default to some value if no was given or modify something in the settings. __Initial value:__ _Nothing_ -__Expected return value:__ `{}` +__Expected return value:__ `Object()` #### Arguments @@ -51,7 +51,7 @@ __Expected return value:__ _Nothing_ Hook point for adding code that runs before the clean command is invoked. __Initial value:__ _Nothing_ -__Expected return value:__ `[String]` +__Expected return value:__ `Array(String)` ### run-build-command @@ -62,9 +62,9 @@ __Expected return value:__ `Function` #### Arguments -| Name | Description | Type | Required | Can be empty | -| ------- | -------------------------------------------------------------------------------------- | ---------- | -------- | ------------ | -| targets | The targets to build for, will be based on settings or a possible argument if defined. | `[String]` | Yes | No | +| Name | Description | Type | Required | Can be empty | +| ------- | -------------------------------------------------------------------------------------- | --------------- | -------- | ------------ | +| targets | The targets to build for, will be based on settings or a possible argument if defined. | `Array(String)` | Yes | No | ### run-dev-command @@ -75,9 +75,9 @@ __Expected return value:__ _Nothing_ #### Arguments -| Name | Description | Type | Required | Can be empty | -| ------- | ------------------------------------------------------------------------------------- | ---------- | -------- | ------------ | -| targets | The targets use for dev, will be based on settings or a possible argument if defined. | `[String]` | Yes | No | +| Name | Description | Type | Required | Can be empty | +| ------- | ------------------------------------------------------------------------------------- | --------------- | -------- | ------------ | +| targets | The targets use for dev, will be based on settings or a possible argument if defined. | `Array(String)` | Yes | No | ## roc-package-web-app-dev @@ -102,7 +102,7 @@ __Expected return value:__ _Nothing_ Used to create a Babel configuration to be used in the Webpack build. __Initial value:__ `{}` -__Expected return value:__ `{}` +__Expected return value:__ `Object()` #### Arguments @@ -115,28 +115,28 @@ __Expected return value:__ `{}` Used to create the final Webpack configuration object. __Initial value:__ `{}` -__Expected return value:__ `{}` +__Expected return value:__ `Object()` #### Arguments -| Name | Description | Type | Required | Can be empty | -| ----------- | ------------------------------------------------------------------- | -------- | -------- | ------------ | -| target | The target for which the Webpack configuration should be build for. | `String` | No | Yes | -| babelConfig | The Babel configuration that should be used for the Webpack build. | `{}` | No | Yes | +| Name | Description | Type | Required | Can be empty | +| ----------- | ------------------------------------------------------------------- | ---------- | -------- | ------------ | +| target | The target for which the Webpack configuration should be build for. | `String` | No | Yes | +| babelConfig | The Babel configuration that should be used for the Webpack build. | `Object()` | No | Yes | ### create-watchers Used to add watchers that should follow a specific format. __Initial value:__ `{}` -__Expected return value:__ `{Function}` +__Expected return value:__ `Object(Function)` ### get-webpack-targets Used to inform which targets that should be considered as Webpack targets. Actions should concat the previousValue to build the complete value. __Initial value:__ `[]` -__Expected return value:__ `[String]` +__Expected return value:__ `Array(String)` ## roc-package-webpack-node-dev @@ -164,4 +164,4 @@ Important that the _actions_ return an object matching the following: `{ extensions: String/[String], loaders: String/[String] }` __Initial value:__ _Nothing_ -__Expected return value:__ `{String / [String]}` +__Expected return value:__ `Object(String / Array(String))` diff --git a/extensions/roc-package-web-app-react-dev/docs/Settings.md b/extensions/roc-package-web-app-react-dev/docs/Settings.md index d8208a5..2650200 100644 --- a/extensions/roc-package-web-app-react-dev/docs/Settings.md +++ b/extensions/roc-package-web-app-react-dev/docs/Settings.md @@ -3,21 +3,21 @@ ## Build Build settings. -| Name | Description | Path | CLI option | Default | Type | Required | Can be empty | Extensions | -| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | --------------------------- | -------- | ------------ | ----------------------------------------------------------------------------------------------------------------- | -| 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 | roc-package-webpack-dev | -| name | The name of the generated application bundle. | build.name | --build-name | `"app"` | `[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 | -| 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"]` | `[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"]` | `[/^web|node$/i]` | No | Yes | roc-abstract-package-base-dev, roc-package-webpack-web-dev, roc-package-webpack-node-dev, roc-package-web-app-dev | -| 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 | +| Name | Description | Path | CLI option | Default | Type | Required | Can be empty | Extensions | +| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | ---------------------------- | -------- | ------------ | ----------------------------------------------------------------------------------------------------------------- | +| 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 | roc-package-webpack-dev | +| 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 | +| 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 | roc-abstract-package-base-dev, roc-package-webpack-web-dev, roc-package-webpack-node-dev, roc-package-web-app-dev | +| 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 | ### Assets @@ -29,174 +29,174 @@ 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"]` | `[String]` | Yes | No | roc-plugin-assets-images | +| 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 | +| 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"]` | `[String]` | Yes | No | roc-plugin-assets-images | +| 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 | +| 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 | ### 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 | +| 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 | +| 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 | -| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | --------------------------- | -------- | ------------ | ----------------------------------------------------------------------------------------------------------------- | -| 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 | +| Name | Description | Path | CLI option | Default | Type | Required | Can be empty | Extensions | +| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | ---------------------------- | -------- | ------------ | ----------------------------------------------------------------------------------------------------------------- | +| 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 | -| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | --------------------------- | -------- | ------------ | ----------------------------------------------------------------------------------------------------------------- | -| 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 | +| 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 | #### 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 | +| 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 | -| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | --------------------------- | -------- | ------------ | ----------------------------------------------------------------------------------------------------------------- | -| 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 / [Filepath]` | Yes | | roc-package-webpack-node-dev, roc-package-web-app-dev | +| 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 | +| 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 | +| 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 | +| 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 | +| 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 | +| 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$/` | Yes | | roc-package-web-app-react-dev | -| 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 | +| 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$/` | Yes | | roc-package-web-app-react-dev | +| 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 | +| 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 | +| 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 | | roc-package-web-app-react-dev | -| 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 | +| 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 | | roc-package-web-app-react-dev | +| 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"]` | `[String]` | No | Yes | roc-package-web-app-react-dev | +| 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 | diff --git a/extensions/roc-package-web-app-react-dev/package.json b/extensions/roc-package-web-app-react-dev/package.json index 58964fe..f41e773 100644 --- a/extensions/roc-package-web-app-react-dev/package.json +++ b/extensions/roc-package-web-app-react-dev/package.json @@ -1,7 +1,7 @@ { "name": "roc-package-web-app-react-dev", "description": "Package for building React applications with Roc (Development)", - "version": "1.0.0-beta.4", + "version": "1.0.0-beta.5", "main": "lib/index.js", "scripts": { "lint": "eslint .", diff --git a/extensions/roc-package-web-app-react/docs/Dependencies.md b/extensions/roc-package-web-app-react/docs/Dependencies.md index 56d374c..c7d2053 100644 --- a/extensions/roc-package-web-app-react/docs/Dependencies.md +++ b/extensions/roc-package-web-app-react/docs/Dependencies.md @@ -14,12 +14,12 @@ __Extension__: roc-package-web-app-react __Custom resolve function__: No ### [react](https://www.npmjs.com/package/react) -__Version__: ~15.0.1 +__Version__: ^15.3.2 __Extension__: roc-plugin-react __Custom resolve function__: No ### [react-dom](https://www.npmjs.com/package/react-dom) -__Version__: ~15.0.1 +__Version__: ^15.3.2 __Extension__: roc-plugin-react __Custom resolve function__: No @@ -34,12 +34,12 @@ __Extension__: roc-package-web-app-react __Custom resolve function__: No ### [react-router](https://www.npmjs.com/package/react-router) -__Version__: ~2.3.0 +__Version__: ~2.8.1 __Extension__: roc-package-web-app-react __Custom resolve function__: No ### [react-router-redial](https://www.npmjs.com/package/react-router-redial) -__Version__: ~0.2.2 +__Version__: ~0.3.0 __Extension__: roc-package-web-app-react __Custom resolve function__: No @@ -48,13 +48,18 @@ __Version__: ~4.0.2 __Extension__: roc-package-web-app-react __Custom resolve function__: No +### [react-router-scroll](https://www.npmjs.com/package/react-router-scroll) +__Version__: ~0.3.2 +__Extension__: roc-package-web-app-react +__Custom resolve function__: No + ### [react-server-status](https://www.npmjs.com/package/react-server-status) __Version__: ~1.0.0 __Extension__: roc-package-web-app-react __Custom resolve function__: No ### [redial](https://www.npmjs.com/package/redial) -__Version__: ~0.4.1 +__Version__: ~0.5.0 __Extension__: roc-package-web-app-react __Custom resolve function__: No diff --git a/extensions/roc-package-web-app-react/docs/Extensions.md b/extensions/roc-package-web-app-react/docs/Extensions.md index 8296aea..8fb2029 100644 --- a/extensions/roc-package-web-app-react/docs/Extensions.md +++ b/extensions/roc-package-web-app-react/docs/Extensions.md @@ -9,7 +9,7 @@ Package forming an abstract foundation of the Roc ecosystem. The package serves as a base from which other packages within the ecosystem are to be constructed. It is therefore _never to be included_ as a direct dependency in app or component projects. -### roc-package-webpack — [v1.0.0-beta.2](https://www.npmjs.com/package/roc-package-webpack) +### roc-package-webpack — [v1.0.0-beta.3](https://www.npmjs.com/package/roc-package-webpack) Package providing Webpack support for Roc ### roc-package-webpack-node — [v1.0.0-beta.2](https://www.npmjs.com/package/roc-package-webpack-node) @@ -25,5 +25,5 @@ Package for building web applications using Roc ### roc-plugin-start — [v1.0.0-beta.2](https://www.npmjs.com/package/roc-plugin-start) Adds start command with a way to modify the runtime -### roc-plugin-react — [v1.0.0-beta.2](https://www.npmjs.com/package/roc-plugin-react) +### roc-plugin-react — [v1.0.0-beta.3](https://www.npmjs.com/package/roc-plugin-react) Adds React support to Webpack and Roc diff --git a/extensions/roc-package-web-app-react/docs/Hooks.md b/extensions/roc-package-web-app-react/docs/Hooks.md index ed1b060..add9610 100644 --- a/extensions/roc-package-web-app-react/docs/Hooks.md +++ b/extensions/roc-package-web-app-react/docs/Hooks.md @@ -16,7 +16,7 @@ Expected to return new settings that should be merged with the existing ones. Makes it possible to modify the settings object before a command is started and after potential arguments from the command line and configuration file have been parsed. This is a good point to default to some value if no was given or modify something in the settings. __Initial value:__ _Nothing_ -__Expected return value:__ `{}` +__Expected return value:__ `Object()` #### Arguments diff --git a/extensions/roc-package-web-app-react/docs/Settings.md b/extensions/roc-package-web-app-react/docs/Settings.md index 25b5cd6..ef9b5b9 100644 --- a/extensions/roc-package-web-app-react/docs/Settings.md +++ b/extensions/roc-package-web-app-react/docs/Settings.md @@ -2,73 +2,73 @@ ## Runtime -| Name | Description | Path | CLI option | Default | Type | Required | Can be empty | Extensions | -| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ----------------------- | -------- | ------------ | ------------------------------------- | -| applicationName | Default application name to use for <title>. | runtime.applicationName | --runtime-applicationName | | `String` | Yes | Yes | roc-package-web-app-react | -| configWhitelistProperty | A single property to expose to the client from node-config. Make sure that this property does NOT contain any secrets that should not be exposed to the world. | runtime.configWhitelistProperty | --runtime-configWhitelistProperty | `"DANGEROUSLY_EXPOSE_TO_CLIENT"` | `String` | No | No | roc-package-web-app-react | -| favicon | Path to the favicon file, specially handled on the server. | runtime.favicon | --runtime-favicon | | `String` | No | No | roc-package-web-app | -| port | Port for the server to use. | runtime.port | --runtime-port | `3000` | `Integer` | Yes | No | roc-package-web-app | -| serve | What folder the server should expose. | runtime.serve | --runtime-serve | `["build/client"]` | `Filepath / [Filepath]` | No | | roc-package-web-app | -| ssr | If server side rendering should be enabled. | runtime.ssr | --runtime-ssr | `true` | `Boolean` | Yes | | roc-package-web-app-react | -| startBundle | Relative path to a bundle to start when calling "start", is not needed in most cases. | runtime.startBundle | --runtime-startBundle | `"build/server/app.js"` | `Filepath` | No | No | roc-plugin-start, roc-package-web-app | -| stats | Path to client stats file from build. | runtime.stats | --runtime-stats | `"build/client/webpack-stats.json"` | `Filepath` | Yes | No | roc-package-web-app-react | +| Name | Description | Path | CLI option | Default | Type | Required | Can be empty | Extensions | +| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | --------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------- | -------- | ------------ | ------------------------------------- | +| applicationName | Default application name to use for <title>. | runtime.applicationName | --runtime-applicationName | | `String` | Yes | Yes | roc-package-web-app-react | +| configWhitelistProperty | A single property to expose to the client from node-config. Make sure that this property does NOT contain any secrets that should not be exposed to the world. | runtime.configWhitelistProperty | --runtime-configWhitelistProperty | `"DANGEROUSLY_EXPOSE_TO_CLIENT"` | `String` | No | No | roc-package-web-app-react | +| favicon | Path to the favicon file, specially handled on the server. | runtime.favicon | --runtime-favicon | | `String` | No | No | roc-package-web-app | +| port | Port for the server to use. | runtime.port | --runtime-port | `3000` | `Integer` | Yes | No | roc-package-web-app | +| serve | What folder the server should expose. | runtime.serve | --runtime-serve | `["build/client"]` | `Filepath / Array(Filepath)` | No | | roc-package-web-app | +| ssr | If server side rendering should be enabled. | runtime.ssr | --runtime-ssr | `true` | `Boolean` | Yes | | roc-package-web-app-react | +| startBundle | Relative path to a bundle to start when calling "start", is not needed in most cases. | runtime.startBundle | --runtime-startBundle | `"build/server/app.js"` | `Filepath` | No | No | roc-plugin-start, roc-package-web-app | +| stats | Path to client stats file from build. | runtime.stats | --runtime-stats | `"build/client/webpack-stats.json"` | `Filepath` | Yes | No | roc-package-web-app-react | ### Debug -| Name | Description | Path | CLI option | Default | Type | Required | Can be empty | Extensions | -| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ----------------------- | -------- | ------------ | ------------------------------------- | -| client | Filter for debug messages that should be shown for the client, see https://npmjs.com/package/debug. | runtime.debug.client | --runtime-debug-client | `"roc:*"` | `String` | No | Yes | roc-package-web-app-react | -| server | Filter for debug messages that should be shown for the server, see https://npmjs.com/package/debug. | runtime.debug.server | --runtime-debug-server | `"roc:*"` | `String` | No | Yes | roc-package-web-app | +| Name | Description | Path | CLI option | Default | Type | Required | Can be empty | Extensions | +| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | --------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------- | -------- | ------------ | ------------------------------------- | +| client | Filter for debug messages that should be shown for the client, see https://npmjs.com/package/debug. | runtime.debug.client | --runtime-debug-client | `"roc:*"` | `String` | No | Yes | roc-package-web-app-react | +| server | Filter for debug messages that should be shown for the server, see https://npmjs.com/package/debug. | runtime.debug.server | --runtime-debug-server | `"roc:*"` | `String` | No | Yes | roc-package-web-app | ### Fetch -| Name | Description | Path | CLI option | Default | Type | Required | Can be empty | Extensions | -| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ----------------------- | -------- | ------------ | ------------------------------------- | -| server | What redial hooks that should run on the server and in what order. | runtime.fetch.server | --runtime-fetch-server | `["fetch"]` | `[String]` | Yes | Yes | roc-package-web-app-react | +| Name | Description | Path | CLI option | Default | Type | Required | Can be empty | Extensions | +| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | --------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------- | -------- | ------------ | ------------------------------------- | +| server | What redial hooks that should run on the server and in what order. | runtime.fetch.server | --runtime-fetch-server | `["fetch"]` | `Array(String / Array(String))` | Yes | Yes | roc-package-web-app-react | #### Client -| Name | Description | Path | CLI option | Default | Type | Required | Can be empty | Extensions | -| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ----------------------- | -------- | ------------ | ------------------------------------- | -| blocking | What redial hooks that should run on the client that blocks route transitions and in what order. | runtime.fetch.client.blocking | --runtime-fetch-client-blocking | `["fetch"]` | `[String]` | Yes | Yes | roc-package-web-app-react | -| defer | What redial hooks that should run on the client that should not block route transitions and in what order. | runtime.fetch.client.defer | --runtime-fetch-client-defer | `["defer"]` | `[String]` | Yes | Yes | roc-package-web-app-react | -| parallel | If defer hooks should be started at the same time as the blocking ones. | runtime.fetch.client.parallel | --runtime-fetch-client-parallel | `false` | `Boolean` | Yes | | roc-package-web-app-react | +| Name | Description | Path | CLI option | Default | Type | Required | Can be empty | Extensions | +| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | --------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------- | -------- | ------------ | ------------------------------------- | +| afterTransition | What redial hooks that should run on the client that should not block route transitions and in what order. | runtime.fetch.client.afterTransition | --runtime-fetch-client-afterTransition | `["defer"]` | `Array(String / Array(String))` | Yes | Yes | roc-package-web-app-react | +| beforeTransition | What redial hooks that should run on the client that blocks route transitions and in what order. | runtime.fetch.client.beforeTransition | --runtime-fetch-client-beforeTransition | `["fetch"]` | `Array(String / Array(String))` | Yes | Yes | roc-package-web-app-react | +| parallel | If defer hooks should be started at the same time as the blocking ones. | runtime.fetch.client.parallel | --runtime-fetch-client-parallel | `false` | `Boolean` | Yes | | roc-package-web-app-react | ### Head Settings that will be used with React Helmet. https://github.com/nfl/react-helmet ✓ ― Supports __raw -| Name | Description | Path | CLI option | Default | Type | Required | Can be empty | Extensions | -| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ----------------------- | -------- | ------------ | ------------------------------------- | -| htmlAttributes | Attributes that should be added to the <html> tag. | runtime.head.htmlAttributes | --runtime-head-htmlAttributes | `{}` | `{}` | Yes | Yes | roc-package-web-app-react | -| link | Link tags to be used in <head>, should be formatted as objects. | runtime.head.link | --runtime-head-link | `[{"rel":"icon","href":"favicon.png"}]` | `[{String}]` | Yes | Yes | roc-package-web-app-react | -| meta | Meta tags to be used in <head>, should be formatted as objects. | runtime.head.meta | --runtime-head-meta | `[{"name":"viewport","content":"width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"}]` | `[{String}]` | Yes | Yes | roc-package-web-app-react | -| script | Script tags to be used in <head>, should be formatted as objects. | runtime.head.script | --runtime-head-script | `[]` | `[{String}]` | Yes | Yes | roc-package-web-app-react | -| style | Style tags to be used in <head>, should be formatted as objects. | runtime.head.style | --runtime-head-style | `[]` | `[{String}]` | Yes | Yes | roc-package-web-app-react | -| titleTemplate | Template to be used for <title>. | runtime.head.titleTemplate | --runtime-head-titleTemplate | | `String` | No | No | roc-package-web-app-react | +| Name | Description | Path | CLI option | Default | Type | Required | Can be empty | Extensions | +| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | --------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------- | -------- | ------------ | ------------------------------------- | +| htmlAttributes | Attributes that should be added to the <html> tag. | runtime.head.htmlAttributes | --runtime-head-htmlAttributes | `{}` | `Object()` | Yes | Yes | roc-package-web-app-react | +| link | Link tags to be used in <head>, should be formatted as objects. | runtime.head.link | --runtime-head-link | `[{"rel":"icon","href":"favicon.png"}]` | `Array(Object(String))` | Yes | Yes | roc-package-web-app-react | +| meta | Meta tags to be used in <head>, should be formatted as objects. | runtime.head.meta | --runtime-head-meta | `[{"name":"viewport","content":"width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"}]` | `Array(Object(String))` | Yes | Yes | roc-package-web-app-react | +| script | Script tags to be used in <head>, should be formatted as objects. | runtime.head.script | --runtime-head-script | `[]` | `Array(Object(String))` | Yes | Yes | roc-package-web-app-react | +| style | Style tags to be used in <head>, should be formatted as objects. | runtime.head.style | --runtime-head-style | `[]` | `Array(Object(String))` | Yes | Yes | roc-package-web-app-react | +| titleTemplate | Template to be used for <title>. | runtime.head.titleTemplate | --runtime-head-titleTemplate | | `String` | No | No | roc-package-web-app-react | #### Base Base tag to be used in . -| Name | Description | Path | CLI option | Default | Type | Required | Can be empty | Extensions | -| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ----------------------- | -------- | ------------ | ------------------------------------- | -| href | The document base address from which relative links are made. | runtime.head.base.href | --runtime-head-base-href | `"ROC_PATH"` | `String` | No | No | roc-package-web-app-react | -| target | The browsing context in which the links should open. | runtime.head.base.target | --runtime-head-base-target | | `String` | No | No | roc-package-web-app-react | +| Name | Description | Path | CLI option | Default | Type | Required | Can be empty | Extensions | +| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | --------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------- | -------- | ------------ | ------------------------------------- | +| href | The document base address from which relative links are made. | runtime.head.base.href | --runtime-head-base-href | `"ROC_PATH"` | `String` | No | No | roc-package-web-app-react | +| target | The browsing context in which the links should open. | runtime.head.base.target | --runtime-head-base-target | | `String` | No | No | roc-package-web-app-react | ### History -| Name | Description | Path | CLI option | Default | Type | Required | Can be empty | Extensions | -| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ----------------------- | -------- | ------------ | ------------------------------------- | -| forceRefresh | Whether to force load from server rather than do single page navigation | runtime.history.forceRefresh | --runtime-history-forceRefresh | | `Boolean / Function` | No | | roc-package-web-app-react | +| Name | Description | Path | CLI option | Default | Type | Required | Can be empty | Extensions | +| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | --------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------- | -------- | ------------ | ------------------------------------- | +| forceRefresh | Whether to force load from server rather than do single page navigation | runtime.history.forceRefresh | --runtime-history-forceRefresh | | `Boolean / Function` | No | | roc-package-web-app-react | ### Https -| Name | Description | Path | CLI option | Default | Type | Required | Can be empty | Extensions | -| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ----------------------- | -------- | ------------ | ------------------------------------- | -| cert | The certificate file to use when using HTTPS. If none is provided and if running in dev a file will be provided automatically. | runtime.https.cert | --runtime-https-cert | | `Filepath` | No | No | roc-package-web-app | -| key | The key file to use when using HTTPS. If none is provided and if running in dev a file will be provided automatically. | runtime.https.key | --runtime-https-key | | `Filepath` | No | No | roc-package-web-app | -| port | Port for the server to use for HTTPS. If none is defined it will not launch in HTTPS. | runtime.https.port | --runtime-https-port | | `Integer` | No | No | roc-package-web-app | +| Name | Description | Path | CLI option | Default | Type | Required | Can be empty | Extensions | +| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | --------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------- | -------- | ------------ | ------------------------------------- | +| cert | The certificate file to use when using HTTPS. If none is provided and if running in dev a file will be provided automatically. | runtime.https.cert | --runtime-https-cert | | `Filepath` | No | No | roc-package-web-app | +| key | The key file to use when using HTTPS. If none is provided and if running in dev a file will be provided automatically. | runtime.https.key | --runtime-https-key | | `Filepath` | No | No | roc-package-web-app | +| port | Port for the server to use for HTTPS. If none is defined it will not launch in HTTPS. | runtime.https.port | --runtime-https-port | | `Integer` | No | No | roc-package-web-app | ### Koa Settings for how Koa should handle paths. @@ -76,36 +76,36 @@ Settings for how Koa should handle paths. #### Lowercase -| Name | Description | Path | CLI option | Default | Type | Required | Can be empty | Extensions | -| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ----------------------- | -------- | ------------ | ------------------------------------- | -| defer | If this should be performed after looking for a file on disk. | runtime.koa.lowercase.defer | --runtime-koa-lowercase-defer | `true` | `Boolean` | Yes | | roc-package-web-app | -| enabled | If paths should be transformed to lowercase. | runtime.koa.lowercase.enabled | --runtime-koa-lowercase-enabled | `true` | `Boolean` | Yes | | roc-package-web-app | +| Name | Description | Path | CLI option | Default | Type | Required | Can be empty | Extensions | +| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | --------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------- | -------- | ------------ | ------------------------------------- | +| defer | If this should be performed after looking for a file on disk. | runtime.koa.lowercase.defer | --runtime-koa-lowercase-defer | `true` | `Boolean` | Yes | | roc-package-web-app | +| enabled | If paths should be transformed to lowercase. | runtime.koa.lowercase.enabled | --runtime-koa-lowercase-enabled | `true` | `Boolean` | Yes | | roc-package-web-app | #### Normalize -| Name | Description | Path | CLI option | Default | Type | Required | Can be empty | Extensions | -| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ----------------------- | -------- | ------------ | ------------------------------------- | -| defer | If this should be performed after looking for a file on disk. | runtime.koa.normalize.defer | --runtime-koa-normalize-defer | `false` | `Boolean` | Yes | | roc-package-web-app | -| enabled | If paths should be normalized, that is remove extra slashes. | runtime.koa.normalize.enabled | --runtime-koa-normalize-enabled | `true` | `Boolean` | Yes | | roc-package-web-app | +| Name | Description | Path | CLI option | Default | Type | Required | Can be empty | Extensions | +| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | --------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------- | -------- | ------------ | ------------------------------------- | +| defer | If this should be performed after looking for a file on disk. | runtime.koa.normalize.defer | --runtime-koa-normalize-defer | `false` | `Boolean` | Yes | | roc-package-web-app | +| enabled | If paths should be normalized, that is remove extra slashes. | runtime.koa.normalize.enabled | --runtime-koa-normalize-enabled | `true` | `Boolean` | Yes | | roc-package-web-app | #### StaticServe ✓ ― Supports __raw -| Name | Description | Path | CLI option | Default | Type | Required | Can be empty | Extensions | -| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ----------------------- | -------- | ------------ | ------------------------------------- | -| maxage | Browser cache max-age in milliseconds. Production only. | runtime.koa.staticServe.maxage | --runtime-koa-staticServe-maxage | `60000` | `Integer` | Yes | | roc-package-web-app | +| Name | Description | Path | CLI option | Default | Type | Required | Can be empty | Extensions | +| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | --------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------- | -------- | ------------ | ------------------------------------- | +| maxage | Browser cache max-age in milliseconds. Production only. | runtime.koa.staticServe.maxage | --runtime-koa-staticServe-maxage | `60000` | `Integer` | Yes | | roc-package-web-app | #### TrailingSlashes -| Name | Description | Path | CLI option | Default | Type | Required | Can be empty | Extensions | -| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ----------------------- | -------- | ------------ | ------------------------------------- | -| defer | If this should be performed after looking for a file on disk. | runtime.koa.trailingSlashes.defer | --runtime-koa-trailingSlashes-defer | `true` | `Boolean` | Yes | | roc-package-web-app | -| enabled | Set to true to enforce trailing slashes, false to remove them and null for no rule. | runtime.koa.trailingSlashes.enabled | --runtime-koa-trailingSlashes-enabled | `true` | `Boolean` | Yes | | roc-package-web-app | +| Name | Description | Path | CLI option | Default | Type | Required | Can be empty | Extensions | +| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | --------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------- | -------- | ------------ | ------------------------------------- | +| defer | If this should be performed after looking for a file on disk. | runtime.koa.trailingSlashes.defer | --runtime-koa-trailingSlashes-defer | `true` | `Boolean` | Yes | | roc-package-web-app | +| enabled | Set to true to enforce trailing slashes, false to remove them and null for no rule. | runtime.koa.trailingSlashes.enabled | --runtime-koa-trailingSlashes-enabled | `true` | `Boolean` | Yes | | roc-package-web-app | ### Template -| Name | Description | Path | CLI option | Default | Type | Required | Can be empty | Extensions | -| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ----------------------- | -------- | ------------ | ------------------------------------- | -| name | Name of the template file that will be used. Uses Nunjucks, please see documentation for more info. | runtime.template.name | --runtime-template-name | `"main.html"` | `String` | Yes | No | roc-package-web-app-react | -| path | A directory where the template for the application can be found. Will default to internal path. | runtime.template.path | --runtime-template-path | | `Filepath` | No | No | roc-package-web-app-react | +| Name | Description | Path | CLI option | Default | Type | Required | Can be empty | Extensions | +| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | --------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------- | -------- | ------------ | ------------------------------------- | +| name | Name of the template file that will be used. Uses Nunjucks, please see documentation for more info. | runtime.template.name | --runtime-template-name | `"main.html"` | `String` | Yes | No | roc-package-web-app-react | +| path | A directory where the template for the application can be found. Will default to internal path. | runtime.template.path | --runtime-template-path | | `Filepath` | No | No | roc-package-web-app-react | diff --git a/extensions/roc-package-web-app-react/package.json b/extensions/roc-package-web-app-react/package.json index 13035cd..267e119 100644 --- a/extensions/roc-package-web-app-react/package.json +++ b/extensions/roc-package-web-app-react/package.json @@ -1,7 +1,7 @@ { "name": "roc-package-web-app-react", "description": "Package for building React applications with Roc", - "version": "1.0.0-beta.4", + "version": "1.0.0-beta.5", "main": "lib/index.js", "scripts": { "lint": "eslint .",