Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Acknowledge that the input option is conditionally required #3696

Merged
merged 3 commits into from
Jul 28, 2020
Merged

Acknowledge that the input option is conditionally required #3696

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8579239
docs: explain when input is optional
TomerAberbach Jul 26, 2020
ded0b91
docs: conditionally required input
TomerAberbach Jul 26, 2020
511aa93
docs: conditionally required input 2
TomerAberbach Jul 26, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/01-command-line-reference.md
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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