Skip to content

Commit

Permalink
Acknowledge that the input option is conditionally required (#3696)
Browse files Browse the repository at this point in the history
* docs: explain when input is optional

* docs: conditionally required input

* docs: conditionally required input 2
  • Loading branch information
TomerAberbach committed Jul 28, 2020
1 parent 966838a commit cd47fcf
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/01-command-line-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Config files support the options listed below. Consult the [big list of options]
export default { // can be an array (for multiple inputs)
// core input options
external,
input, // required
input, // conditionally required
plugins,

// advanced input options
Expand Down
2 changes: 1 addition & 1 deletion docs/02-javascript-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ The `inputOptions` object can contain the following properties (see the [big lis
const inputOptions = {
// core input options
external,
input, // required
input, // condtionally required
plugins,

// advanced input options
Expand Down
2 changes: 2 additions & 0 deletions docs/999-big-list-of-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,8 @@ export default {
};
```

The option can be omitted if some plugin emits at least one chunk (using [`this.emitFile`](guide/en/#thisemitfileemittedfile-emittedchunk--emittedasset--string)) by the end of the [`buildStart`](guide/en/#buildstart) hook.

When using the command line interface, multiple inputs can be provided by using the option multiple times. When provided as the first options, it is equivalent to not prefix them with `--input`:

```sh
Expand Down

0 comments on commit cd47fcf

Please sign in to comment.