Shanedell commented on a change in pull request #37: URL: https://github.com/apache/daffodil-vscode/pull/37#discussion_r739284861
########## File path: README.md ########## @@ -21,13 +21,65 @@ This is a VS Code extension which enables the interactive debugging of DFDL schema parsing using [Apache Daffodil](https://daffodil.apache.org/). +## Build Requirements +- Java Development Kit (JDK) 11 or higher +- SBT 0.13.8 or higher +- Node 10 or higher +- Yarn (https://yarnpkg.com/getting-started/install) + +## Download - Prebuilt + +Until the extension is available in the [VS Code Extension Marketplace](https://marketplace.visualstudio.com/vscode), please download the latest `.vsix` file from the [releases page](https://github.com/apache/daffodil-vscode/releases). + + +## Build VSIX and Debugger +:exclamation:**NOT necessary if using prebuilt VSIX**:exclamation: + +:exclamation:**NOT necessary if debugging extension but a `yarn install` will be required**:exclamation: + +* Note what the dapodil data folder location for your OS is. + * Linux = `/home/USERNAME/.local/share/dapodil` + * Mac = `/Users/USERNAME/Library/Application\ Support/dapodil` + * Windows = `C:\\Users\\USERNAME\\AppData\\Roaming\\dapodil` + + :exclamation: Ensure this folder location exists :exclamation: + +* Run full build + ```bash + yarn build + ``` + + * Create sbt zip package + * Install dependencies + * Compiles Extension + * Packages Extension + * Files + ``` + server/core/target/universal/daffodil-debugger-*.zip + daffodil-debugger-*.vsix + ``` + +## Backend - Debugger Server +* When debugging the extension locally: + * Extension will automatically build the sbt zip package if it does not exist, it should if you ran the build step prior. + * Once the zip is there the extension will unzip the package into the data folder + +* When using the extension via VSIX it will use the sbt zip package included in the extension files + +* For both the extension being either debugger or installed via VSIX it will automatically launch the debugging server as long as `useExistingServer: true` is not set ## Installation -Until the extension is available in the [VS Code Extension Marketplace](https://marketplace.visualstudio.com/vscode), please download the latest `.vsix` file from the [releases page](https://github.com/apache/daffodil-vscode/releases). Then install it by either: - * using the "Extensions: Install from VSIX" command from within VS Code (open the Command Palette with Shift-Command-P, then type `vsix` to bring up the command and pointing it at the downloaded `vsix` file); or - * on the command-line via `code --install-extension <path-to-downloaded-vsix>`. +Once you have either downloaded the VSIX file or created it you can now install it. There are two options to do this: + +* Via "Extensions: Install from VSIX" command from within VS Code. + * Open the Command Palette with Shift-Command-P (Mac) OR Shift-Ctrl-P (Windows/Linux) + * Type `vsix` to bring up the command and pointing it at the `vsix` file +* Via command line + ```bash + code --install-extension daffodil-debugger-*.vsix + ``` ## Usage Review comment: Yeah I will do that now -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
