Support installing Waku package from git repo #1344
Conversation
Prior to this commit, when installing Waku from a git repository, the `dist` directory would not be built, and all `waku` CLI commands would throw an `ERR_MODULE_NOT_FOUND` error. This commit adds a `prepare` command to `packages/waku/package.json`, which is just an alias for `pnpm run compile`. pnpm will automatically run `prepare` when installing the package from a git repo, thus solving the problem. Also, documentation about referencing a package inside a monorepo seems to be scarce and inaccurate (many sources specify incorrect syntax). Therefore, this commit adds instructions to the README on how to build an app that uses an experimental version of Waku.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. |
TIL |
It is also supported by npm, but since the Thank you for reviewing! |
Ah, I think I knew it.
But not that. Thanks for sharing. |
| @@ -1080,3 +1080,15 @@ Please join our friendly [GitHub discussions](https://github.com/wakujs/waku/dis | |||
| ## Roadmap | |||
|
|
|||
| Waku is in active development and we’re seeking additional contributors. Check out our [roadmap](https://github.com/wakujs/waku/issues/24) for more information. | |||
|
|
|||
| ## Contributing | |||
There was a problem hiding this comment.
Actually, I misunderstood. This was added to README.md. It should have added to CONTRIBUTING.md.
@jonathanhefner Can you move this section from README.md to CONTRIBUTING.md please? Feel free to improve CONTRIBUTING.md too.
Prior to this commit, when installing Waku from a git repository, the
distdirectory would not be built, and allwakuCLI commands would throw anERR_MODULE_NOT_FOUNDerror.This commit adds a
preparecommand topackages/waku/package.json, which is just an alias forpnpm run compile. pnpm will automatically runpreparewhen installing the package from a git repo, thus solving the problem.Also, documentation about referencing a package inside a monorepo seems to be scarce and inaccurate (many sources specify incorrect syntax). Therefore, this commit adds instructions to the README on how to build an app that uses an experimental version of Waku.