You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@daffodil.apache.org by GitBox <gi...@apache.org> on 2021/11/04 15:24:42 UTC
[GitHub] [daffodil-vscode] stevedlawrence commented on a change in pull request #37: Add Build Instructions to README.md
stevedlawrence commented on a change in pull request #37:
URL: https://github.com/apache/daffodil-vscode/pull/37#discussion_r742944105
##########
File path: README.md
##########
@@ -21,14 +21,81 @@
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 running extension via VSCode without VSIX but a `yarn install` will be required**:exclamation:
+
+Run full build
+ ```bash
+ yarn build
+ ```
+
+* This command performs the following tasks:
+ * Create sbt zip package
+ * Install dependencies
+ * Compiles Extension
+ * Packages Extension
+ * Creates Files
+ ```
+ server/core/target/universal/daffodil-debugger-*.zip
+ daffodil-debugger-*.vsix
+ ```
+
+## Running Debug Server
+
+The debug server will automatically be ran by the extension unless `useExistingServer` is to set to `true` inside of `.vscode/launch.json`
+
+If you wish to ran the debug server manually the scripts to do so are at the following locations:
+* Debugging through VSCode with or without VSIX:
+ * Linux = `/home/USERNAME/.local/share/daffodil-dap`
+ * Mac = `/Users/USERNAME/Library/Application\ Support/daffodil-dap`
+ * Windows = `C:\\Users\\USERNAME\\AppData\\Roaming\\daffodil-dap`
+
+
## 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
Please refer to the Wiki page at https://github.com/apache/daffodil-vscode/wiki
+
+## Getting Help
+
+You can ask questions on the dev@daffodil.apache.org or
+users@daffodil.apache.org mailing lists. You can report bugs via the
+[Daffodil JIRA].
+
+## License
+
+Apache Daffodil VSCode is licensed under the [Apache License, v2.0].
+
+[Apache License, v2.0]: https://www.apache.org/licenses/LICENSE-2.0
+[Apache RAT]: https://creadur.apache.org/rat/
+[Daffodil JIRA]: https://issues.apache.org/jira/projects/DAFFODIL/
+[Github Actions]: https://github.com/apache/daffodil-vscode/actions?query=branch%3Amain+
+[Releases]: https://github.com/apache/daffodil-vscode/releases
+[SBT]: https://www.scala-sbt.org/
Review comment:
None of these link references are used, except for the Apache license. All except that one can be removed.
##########
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:
JIRA is used just for Daffodil. We are using the GitHub issues for the vscode extension.
--
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: commits-unsubscribe@daffodil.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org