-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
7d3f904
commit 60b0a00
Showing
1 changed file
with
15 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
## Development Setup | ||
|
||
For the time being the setup is unfortunately a bit complicated due to the dependencies between `rewrite-javascript` and `rewrite-remote`. | ||
To be able to make changes to both these projects and make sure that they work together, we use `npm link`. | ||
|
||
1. Start by cloning both `openrewrite/rewrite-javascript` (this repo) and `moderneinc/rewrite-remote` | ||
2. For both repos perform the following steps: | ||
1. Run the build using `npm run build` | ||
2. Copy the `package.json` file to the `dist` folder | ||
3. Go into the `dist` folder and run `npm link` | ||
4. This last step only needs to be done once | ||
3. Now `npm link` needs to be run in either project to link it into `node_modules`: | ||
1. For `openrewrite/rewrite-javascript` run `npm link @openrewrite/rewrite-remote` | ||
2. For `moderneinc/rewrite-remote` run `npm link @openrewrite/rewrite` | ||
4. Now you are basically all set. As the tests read the production source files from `dist` instead of `src` it is recommended to have `tsc --watch` running which you can do using `npm run dev` |