-
Notifications
You must be signed in to change notification settings - Fork 15
Description
The problem
I've been following the guide on the getting started page and I noticed an error.
(I'm sorry if this isn't the correct repo, but it seems like it would be the right place)
The page says the following:
To run a build, run
yarn build(if you added the script) orbroccoli build --overwrite(note: without--overwritethe contents of the output directorydistwill NOT be overwritten and produce an error).
I tried running npx broccoli build --overwrite yarn broccoli build --overwrite and yarn build --overwrite yet they all have approximately this output:
yarn run v1.17.3
warning package.json: No license field
$ broccoli build --overwrite
error: unknown option `--overwrite'
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
My hunch is that this command was deprecated, and the guide hasn't been updated yet.
Solutions
Here's a list of different independent possible solutions.
- Update the website to reflect above-mentioned depreciation/removal
- Add the feature back to the code
- Repair the bug
My personal opinion is that the argument should be ignored, for compatibility, and should be removed from the doc.
(My reason the tsc compilation command automatically replaces any file effected by the source change. I really like this approach.)
Note: I had previously opened the issue on this repository,
but I did a bit more digging, and this may be the one to propose the issue too.I'll close the issue on the other one for now, at least.