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

Commit 6ee52a2

Browse files
committed
Version 1.0.0-alpha.13
1 parent 295cf79 commit 6ee52a2

File tree

6 files changed

+6
-609
lines changed

6 files changed

+6
-609
lines changed

packages/roc-package-web-app-react-dev/docs/Actions.md

-165
Original file line numberDiff line numberDiff line change
@@ -10,35 +10,8 @@
1010
* [react](#react)
1111
* [roc-package-web-app-react](#roc-package-web-app-react)
1212
* [react](#react)
13-
* [roc-package-base-dev](#roc-package-base-dev)
14-
* [afterClean](#afterClean)
15-
* [beforeClean](#beforeClean)
16-
* [roc-package-webpack-dev](#roc-package-webpack-dev)
17-
* [build](#build)
18-
* [dev](#dev)
19-
* [webpack](#webpack)
20-
* [roc-package-webpack-node-dev](#roc-package-webpack-node-dev)
21-
* [target](#target)
22-
* [watcher](#watcher)
23-
* [webpack](#webpack)
24-
* [roc-package-webpack-web-dev](#roc-package-webpack-web-dev)
25-
* [target](#target)
26-
* [watcher](#watcher)
27-
* [webpack](#webpack)
28-
* [roc-plugin-style-css](#roc-plugin-style-css)
29-
* [css](#css)
30-
* [roc-plugin-browsersync](#roc-plugin-browsersync)
31-
* [browsersync](#browsersync)
32-
* [roc-plugin-assets-images](#roc-plugin-assets-images)
33-
* [images](#images)
34-
* [roc-package-web-app-dev](#roc-package-web-app-dev)
35-
* [devStarted](#devStarted)
36-
* [webpack](#webpack)
3713
* [roc-plugin-react-dev](#roc-plugin-react-dev)
3814
* [react](#react)
39-
* [roc-package-web-app-react-dev](#roc-package-web-app-react-dev)
40-
* [settings](#settings)
41-
* [webpack](#webpack)
4215

4316
## roc-plugin-start
4417

@@ -75,147 +48,9 @@ __Connects to hook:__ `get-resolve-paths`
7548
__Connects to extension:__ `roc-plugin-start`
7649
__Connects to hook:__ `get-resolve-paths`
7750

78-
## roc-package-base-dev
79-
80-
### afterClean
81-
82-
Runs after clean command is executed. Logs that the action has been completed successfully.
83-
84-
__Connects to extension:__ `roc-package-base-dev`
85-
__Connects to hook:__ `after-clean`
86-
87-
### beforeClean
88-
89-
Runs before clean command is executed. Returns an array of strings that should be removed.
90-
91-
__Connects to extension:__ `roc-package-base-dev`
92-
__Connects to hook:__ `before-clean`
93-
94-
## roc-package-webpack-dev
95-
96-
### build
97-
98-
Build with Webpack.
99-
100-
__Connects to extension:__ Not specified
101-
__Connects to hook:__ `run-build-command`
102-
103-
### dev
104-
105-
Run in development mode using Webpack.
106-
107-
__Connects to extension:__ Not specified
108-
__Connects to hook:__ `run-dev-command`
109-
110-
### webpack
111-
112-
Adds base Webpack configuration.
113-
114-
__Connects to extension:__ Not specified
115-
__Connects to hook:__ `build-webpack`
116-
117-
## roc-package-webpack-node-dev
118-
119-
### target
120-
121-
Adds __node__ as a valid Webpack target.
122-
123-
__Connects to extension:__ `roc-package-webpack-dev`
124-
__Connects to hook:__ `get-webpack-targets`
125-
126-
### watcher
127-
128-
Adds a watcher for automatic reload on change.
129-
130-
__Connects to extension:__ `roc-package-webpack-dev`
131-
__Connects to hook:__ `create-watchers`
132-
133-
### webpack
134-
135-
Adds configuration needed for building for Node.
136-
137-
__Connects to extension:__ Not specified
138-
__Connects to hook:__ `build-webpack`
139-
140-
## roc-package-webpack-web-dev
141-
142-
### target
143-
144-
Adds __web__ as a valid Webpack target.
145-
146-
__Connects to extension:__ `roc-package-webpack-dev`
147-
__Connects to hook:__ `get-webpack-targets`
148-
149-
### watcher
150-
151-
Adds a web watcher using Webpack Dev Server.
152-
153-
__Connects to extension:__ `roc-package-webpack-dev`
154-
__Connects to hook:__ `create-watchers`
155-
156-
### webpack
157-
158-
Adds configuration need for web builds for Webpack.
159-
160-
__Connects to extension:__ Not specified
161-
__Connects to hook:__ `build-webpack`
162-
163-
## roc-plugin-style-css
164-
165-
### css
166-
167-
Adds CSS support.
168-
169-
__Connects to extension:__ Not specified
170-
__Connects to hook:__ `build-webpack`
171-
172-
## roc-plugin-browsersync
173-
174-
### browsersync
175-
176-
Adds a Browsersync instance.
177-
178-
__Connects to extension:__ Not specified
179-
__Connects to hook:__ `server-started`
180-
181-
## roc-plugin-assets-images
182-
183-
### images
184-
185-
Adds images support.
186-
187-
__Connects to extension:__ Not specified
188-
__Connects to hook:__ `build-webpack`
189-
190-
## roc-package-web-app-dev
191-
192-
### devStarted
193-
194-
__Connects to extension:__ Not specified
195-
__Connects to hook:__ `dev-process-created`
196-
197-
### webpack
198-
199-
Adds needed configuration to being able to build web applications.
200-
201-
__Connects to extension:__ Not specified
202-
__Connects to hook:__ `build-webpack`
203-
20451
## roc-plugin-react-dev
20552

20653
### react
20754

20855
__Connects to extension:__ Not specified
20956
__Connects to hook:__ `build-webpack`
210-
211-
## roc-package-web-app-react-dev
212-
213-
### settings
214-
215-
__Connects to extension:__ `roc`
216-
__Connects to hook:__ `update-settings`
217-
218-
### webpack
219-
220-
__Connects to extension:__ Not specified
221-
__Connects to hook:__ `build-webpack`
Original file line numberDiff line numberDiff line change
@@ -1,101 +1 @@
1-
# Commands for `roc-package-web-app-react-dev`
2-
3-
## General Information
4-
All commands can be called with some additional options as can be seen below.
5-
6-
### General options
7-
8-
| Name | Description | Required |
9-
| --------------- | ------------------------------------------------------------------------------------------------------------- | -------- |
10-
| -c, --config | Path to configuration file, will default to roc.config.js in current working directory. | No |
11-
| -d, --directory | Path to working directory, will default to the current working directory. Can be either absolute or relative. | No |
12-
| -h, --help | Output usage information. | No |
13-
| -V, --verbose | Enable verbose mode. | No |
14-
| -v, --version | Output version number. | No |
15-
16-
## Commands
17-
* [build](#build)
18-
* [clean](#clean)
19-
* [dev](#dev)
20-
* [list-settings](#list-settings)
21-
* [markdown-actions](#markdown-actions)
22-
* [markdown-hooks](#markdown-hooks)
23-
* [markdown-settings](#markdown-settings)
24-
* [start](#start)
25-
26-
## build
27-
__Build the current project.__
28-
29-
```
30-
roc-package-web-app-react-dev build
31-
```
32-
33-
### Settings options
34-
* [build](/packages/roc-package-web-app-react-dev/docs/Settings.md#build)
35-
36-
## clean
37-
__Cleans the current project.__
38-
39-
```
40-
roc-package-web-app-react-dev clean
41-
```
42-
43-
### Settings options
44-
* [build](/packages/roc-package-web-app-react-dev/docs/Settings.md#build)
45-
46-
## dev
47-
__Starts the current project in development mode.__
48-
49-
```
50-
roc-package-web-app-react-dev dev
51-
```
52-
53-
### Settings options
54-
_All groups are available._
55-
* [build](/packages/roc-package-web-app-react-dev/docs/Settings.md#build)
56-
* [dev](/packages/roc-package-web-app-react-dev/docs/Settings.md#dev)
57-
* [runtime](/packages/roc-package-web-app-react-dev/docs/Settings.md#runtime)
58-
59-
## list-settings
60-
__Prints all the available settings that can be changed.__
61-
62-
```
63-
roc-package-web-app-react-dev list-settings
64-
```
65-
66-
## markdown-actions
67-
__Prints all the registered actions in a markdown format.__
68-
69-
```
70-
roc-package-web-app-react-dev markdown-actions
71-
```
72-
73-
## markdown-hooks
74-
__Prints all the registered hooks in a markdown format.__
75-
76-
```
77-
roc-package-web-app-react-dev markdown-hooks
78-
```
79-
80-
## markdown-settings
81-
__Prints all the available settings that can be changed in a markdown format.__
82-
83-
```
84-
roc-package-web-app-react-dev markdown-settings
85-
```
86-
87-
## start
88-
__Starts the current project.__
89-
90-
```
91-
roc-package-web-app-react-dev start [artifact]
92-
```
93-
94-
### Arguments
95-
96-
| Name | Description | Required | Type | Default |
97-
| -------- | ----------------------------- | -------- | ---------- | ------- |
98-
| artifact | Path to an artifact to start. | No | `Filepath` | |
99-
100-
### Settings options
101-
* [runtime](/packages/roc-package-web-app-react-dev/docs/Settings.md#runtime)
1+
No commands available.

0 commit comments

Comments
 (0)