From f55bef23c23c0d33d30e971b9306a79273f8ecc6 Mon Sep 17 00:00:00 2001 From: Henning Dieterichs Date: Tue, 25 Feb 2020 12:28:18 +0100 Subject: [PATCH] Adds build instructions. --- README.md | 23 +++++++++++++++++++++++ package.json | 9 ++++++++- shared/package.json | 3 ++- 3 files changed, 33 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0992047..b11600f 100644 --- a/README.md +++ b/README.md @@ -6,3 +6,26 @@ See the [extension](extension) directory for the extension readme. You can get the extension in the [marketplace](https://marketplace.visualstudio.com/items?itemName=hediet.debug-visualizer). ![](./docs/doubly-linked-list-reverse-demo.gif) + +## Build Instructions + +- Clone the repository +- Run `yarn` in the repository root +- Run `yarn build` + +## Dev Instructions + +- Clone the repository +- Run `yarn` in the repository root +- Run `yarn build` initially (or `yarn dev` for every project) +- Run `yarn dev` **inside** the project you are working on. + +For the UI, `yarn dev` will start a webserver that you can access on port 8080. +You can use VS Code do launch and debug the extension. +Chose `Run Extension (Dev UI)` as debug configuration so that the extension loads the UI from the webpack server. + +## Publish Instructions + +- Follow the Build Instructions +- `cd extension` +- `yarn pub` diff --git a/package.json b/package.json index bcc2716..dc69cdd 100644 --- a/package.json +++ b/package.json @@ -5,5 +5,12 @@ "./data-extraction", "./extension", "./extension/ui" - ] + ], + "scripts": { + "build": "yarn build-data-extraction && yarn build-shared && yarn build-extension && yarn build-ui", + "build-data-extraction": "yarn workspace @hediet/debug-visualizer-data-extraction build", + "build-shared": "yarn workspace @hediet/debug-visualizer-vscode-shared build", + "build-extension": "yarn workspace debug-visualizer build", + "build-ui": "yarn workspace debug-visualizer-ui build" + } } diff --git a/shared/package.json b/shared/package.json index 7f6173b..cfc6e49 100644 --- a/shared/package.json +++ b/shared/package.json @@ -14,7 +14,8 @@ "src" ], "scripts": { - "dev": "tsc --watch" + "dev": "tsc --watch", + "build": "tsc" }, "dependencies": { "@hediet/std": "^0.6.0",