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

Commit

Permalink
Version 1.0.0-beta.5
Browse files Browse the repository at this point in the history
  • Loading branch information
dlmr committed Oct 19, 2016
1 parent b32b9c8 commit 2ac5850
Show file tree
Hide file tree
Showing 11 changed files with 208 additions and 198 deletions.
12 changes: 6 additions & 6 deletions extensions/roc-package-web-app-react-dev/docs/Commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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._
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
__Extensions__: roc-package-webpack-dev
6 changes: 3 additions & 3 deletions extensions/roc-package-web-app-react-dev/docs/Extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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)
Expand All @@ -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)
34 changes: 17 additions & 17 deletions extensions/roc-package-web-app-react-dev/docs/Hooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand All @@ -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

Expand All @@ -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

Expand All @@ -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

Expand All @@ -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

Expand Down Expand Up @@ -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))`
Loading

0 comments on commit 2ac5850

Please sign in to comment.