Skip to content

Commit 2c3f388

Browse files
authored
Correct developing doc to use yalc (#3123)
The document outlining how to develope webpacker side-by-side with an app uses `yalc` to "build" and link the package to the test app's `node_modules`. It mentions using `yarn link` to link the packages together, however I have yet to get it to work. ```bash $ yarn link @rails/webpacker yarn link v1.22.5 error No registered package found called "@rails/webpacker". info Visit https://yarnpkg.com/en/docs/cli/link for documentation about this command. ``` I am able to get it to work with `yalc link`, however. ```bash $ yalc link @rails/webpacker Package @rails/[email protected] linked ==> /home/user/work/testapp/node_modules/@rails/webpacker ``` Unless I'm doing something very wrong with the other steps, I am running under the assumption that this was a mistype in the document and yalc is the correct command to use to link. I updated the document accordingly.
1 parent f0a29a5 commit 2c3f388

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

Diff for: docs/developing_webpacker.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ Let's call the rails/webpacker directory `WEBPACKER_DIR` which has rails/webpack
1111

1212
## Changing the Package
1313
### Setup with Yalc
14-
Use [`yalc`](https://github.com/wclr/yalc) unless you like yak shaving weird errors.
15-
1. In `WEBPACKER_DIR`, run `yalc publish`
16-
2. In `TEST_APP_DIR`, run `yarn link @rails/webpacker`
17-
14+
Use [`yalc`](https://github.com/wclr/yalc) unless you like yak shaving weird errors.
15+
1. In `WEBPACKER_DIR`, run `yalc publish`
16+
2. In `TEST_APP_DIR`, run `yalc link @rails/webpacker`
17+
1818
## Update the Package Code
1919
1. Make some JS change in WEBPACKER_DIR
2020
2. Run `yalc push` and your changes will be pushed to your `TEST_APP_DIR`'s node_modules.

0 commit comments

Comments
 (0)