stevedlawrence commented on a change in pull request #37: URL: https://github.com/apache/daffodil-vscode/pull/37#discussion_r731027375
########## File path: README.md ########## @@ -23,14 +23,78 @@ This is a VS Code extension which enables the interactive debugging of DFDL schema parsing using [Apache Daffodil](https://daffodil.apache.org/). +## Build Requirements +- SDK 8 or higher +- SBT 0.13.8 or higher +- Node 10 or higher -## Installation +## Installation - via release Review comment: Thoughts on splitting into Build/Install sections? The build section describes how to build a .vsix file, and the Install sections describes how to install it into VSCode? And is if even necessary to mention an install? I would think if you're installing a VSCode extension, you would know how to install it? ########## File path: README.md ########## @@ -23,14 +23,78 @@ This is a VS Code extension which enables the interactive debugging of DFDL schema parsing using [Apache Daffodil](https://daffodil.apache.org/). +## Build Requirements +- SDK 8 or higher Review comment: Is this talking about Java? I don't usually think of SDK as being a java specific thing. Maybe JDK? ########## File path: README.md ########## @@ -23,14 +23,78 @@ This is a VS Code extension which enables the interactive debugging of DFDL schema parsing using [Apache Daffodil](https://daffodil.apache.org/). +## Build Requirements +- SDK 8 or higher +- SBT 0.13.8 or higher +- Node 10 or higher -## Installation +## Installation - via release 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>`. +## Installation - via source + +:exclamation: Currently only Daffodil 3.1.0 is support, will be updated in the future :exclamation: + +Firstly clone the repo: +* apache/daffodil-vscode (https://github.com/apache/daffodil-vscode) + +Backend - Debugger: +* Note down the current version listed in `package.json`, eg `1.0.0` + * Referenced later as `${package.json_version}` +* Note what the dapodil data folder location for your OS is. Review comment: Although `dapodil` is clever, I wonder if it might cause confusion? It almost looks like a typo. I think `daffodil-dap` or something might be better in the long term? ########## File path: README.md ########## @@ -23,14 +23,79 @@ This is a VS Code extension which enables the interactive debugging of DFDL schema parsing using [Apache Daffodil](https://daffodil.apache.org/). +## Build Requirements +- SDK 8 or higher +- SBT 0.13.8 or higher +- Node 10 or higher -## Installation +## Installation - via release 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>`. +## Installation - via source + +:exclamation: Currently only Daffodil 3.1.0 is support, will be updated in the future :exclamation: + +Firstly clone the repo: +* apache/daffodil-vscode (https://github.com/apache/daffodil-vscode) + +Backend - Debugger: +* Note down the current version listed in `package.json`, eg `1.0.0` + * Referenced later as `${package.json_version}` +* 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: + +* Create daffoil debugger zip + ```bash + sbt universal:packageBin + ``` + * Package will be at + ``` + server/core/target/universal/daffodil-debugger-3.1.0-${package.json_version}.zip + ``` + eg + ``` + server/core/target/universal/daffodil-debugger-3.1.0-1.0.0.zip + ``` + +* Unzip debugger zip in data folder + ``` + unzip server/core/target/universal/daffodil-debugger-3.1.0-${package.json_version}.zip -d ~/Library/Application\ Support/dapodil + ``` + +Extension: + +:exclamation: This requires there to be a release with the version specified in `package.json` or for the steps for `Backend - Debugger` have been completed. :exclamation: + +* Install Review comment: Does this install dependencies? Can we say `Install dependencies` to make it more clear what's going on? Someone somewhat new to this (like me) might think this actually installs the extension to vscode (that's what I assumed before I read on). ########## File path: README.md ########## @@ -23,14 +23,78 @@ This is a VS Code extension which enables the interactive debugging of DFDL schema parsing using [Apache Daffodil](https://daffodil.apache.org/). +## Build Requirements +- SDK 8 or higher +- SBT 0.13.8 or higher +- Node 10 or higher -## Installation +## Installation - via release 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>`. +## Installation - via source + +:exclamation: Currently only Daffodil 3.1.0 is support, will be updated in the future :exclamation: + +Firstly clone the repo: +* apache/daffodil-vscode (https://github.com/apache/daffodil-vscode) Review comment: I don't think this line is necessary, it's implied that a user had gotten the source some how. ########## File path: README.md ########## @@ -23,14 +23,78 @@ This is a VS Code extension which enables the interactive debugging of DFDL schema parsing using [Apache Daffodil](https://daffodil.apache.org/). +## Build Requirements +- SDK 8 or higher +- SBT 0.13.8 or higher +- Node 10 or higher -## Installation +## Installation - via release 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>`. +## Installation - via source + +:exclamation: Currently only Daffodil 3.1.0 is support, will be updated in the future :exclamation: + +Firstly clone the repo: +* apache/daffodil-vscode (https://github.com/apache/daffodil-vscode) + +Backend - Debugger: +* Note down the current version listed in `package.json`, eg `1.0.0` + * Referenced later as `${package.json_version}` +* 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: + +* Create daffoil debugger zip + ```bash + sbt universal:packageBin Review comment: Can this be automated as a yarn process? Seems like it's possible to trigger commands from yarn. Can part of the yarn instlal process be to build this file? ########## File path: README.md ########## @@ -23,14 +23,79 @@ This is a VS Code extension which enables the interactive debugging of DFDL schema parsing using [Apache Daffodil](https://daffodil.apache.org/). +## Build Requirements +- SDK 8 or higher +- SBT 0.13.8 or higher +- Node 10 or higher -## Installation +## Installation - via release 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>`. +## Installation - via source + +:exclamation: Currently only Daffodil 3.1.0 is support, will be updated in the future :exclamation: + +Firstly clone the repo: +* apache/daffodil-vscode (https://github.com/apache/daffodil-vscode) + +Backend - Debugger: +* Note down the current version listed in `package.json`, eg `1.0.0` + * Referenced later as `${package.json_version}` +* 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: + +* Create daffoil debugger zip + ```bash + sbt universal:packageBin + ``` + * Package will be at + ``` + server/core/target/universal/daffodil-debugger-3.1.0-${package.json_version}.zip + ``` + eg + ``` + server/core/target/universal/daffodil-debugger-3.1.0-1.0.0.zip + ``` + +* Unzip debugger zip in data folder + ``` + unzip server/core/target/universal/daffodil-debugger-3.1.0-${package.json_version}.zip -d ~/Library/Application\ Support/dapodil + ``` Review comment: Instead of unziping things to some directory, can these jars just all be put in the vsix file so it's all distributed as a single convenience binary? This avoids users having to manually maintain this directory and avoid errors where a particular vsix version might depend on a specific version of the daffodil-debugger? It doesn't seem unreasonable to me to lock things to a specific version. ########## File path: README.md ########## @@ -23,14 +23,78 @@ This is a VS Code extension which enables the interactive debugging of DFDL schema parsing using [Apache Daffodil](https://daffodil.apache.org/). +## Build Requirements +- SDK 8 or higher +- SBT 0.13.8 or higher +- Node 10 or higher -## Installation +## Installation - via release 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>`. +## Installation - via source + +:exclamation: Currently only Daffodil 3.1.0 is support, will be updated in the future :exclamation: Review comment: Is this necessary to mention? The build system will build whatever version of Daffodil we mention in the build.sbt file. Seems like this might just confuse users? And I would think as new Daffodil versions are release, we'll update this extension to build against those new versions. ########## File path: README.md ########## @@ -23,14 +23,79 @@ This is a VS Code extension which enables the interactive debugging of DFDL schema parsing using [Apache Daffodil](https://daffodil.apache.org/). +## Build Requirements +- SDK 8 or higher +- SBT 0.13.8 or higher +- Node 10 or higher -## Installation +## Installation - via release 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>`. +## Installation - via source + +:exclamation: Currently only Daffodil 3.1.0 is support, will be updated in the future :exclamation: + +Firstly clone the repo: +* apache/daffodil-vscode (https://github.com/apache/daffodil-vscode) + +Backend - Debugger: +* Note down the current version listed in `package.json`, eg `1.0.0` + * Referenced later as `${package.json_version}` +* 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: + +* Create daffoil debugger zip + ```bash + sbt universal:packageBin + ``` + * Package will be at + ``` + server/core/target/universal/daffodil-debugger-3.1.0-${package.json_version}.zip + ``` + eg + ``` + server/core/target/universal/daffodil-debugger-3.1.0-1.0.0.zip + ``` + +* Unzip debugger zip in data folder + ``` + unzip server/core/target/universal/daffodil-debugger-3.1.0-${package.json_version}.zip -d ~/Library/Application\ Support/dapodil + ``` + +Extension: + +:exclamation: This requires there to be a release with the version specified in `package.json` or for the steps for `Backend - Debugger` have been completed. :exclamation: + +* Install + ```bash + yarn install + ``` + +* Compile + ```bash + yarn compile + ``` + +* Package + ```bash + yarn package + ``` + + * Creates file `daffodil-debugger-${package.json_version}.vsix` Review comment: This is minor, but the heavy use of lists and nesting I find a bit hard to follow. I would suggest using sections and subsections rather than lists and sublists. ########## File path: README.md ########## @@ -23,14 +23,79 @@ This is a VS Code extension which enables the interactive debugging of DFDL schema parsing using [Apache Daffodil](https://daffodil.apache.org/). +## Build Requirements +- SDK 8 or higher +- SBT 0.13.8 or higher +- Node 10 or higher -## Installation +## Installation - via release 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>`. +## Installation - via source + +:exclamation: Currently only Daffodil 3.1.0 is support, will be updated in the future :exclamation: + +Firstly clone the repo: +* apache/daffodil-vscode (https://github.com/apache/daffodil-vscode) + +Backend - Debugger: +* Note down the current version listed in `package.json`, eg `1.0.0` Review comment: I prefer to avoid versions where possible since it's just one more thing to update with new releases. I suggest we remove this, and everywhere package.json_version is mentioend, we just add *, e.g. ``` server/core/target/universal/daffodil-debugger-*.zip daffodil-debugger-*.vsix ``` I think most people understand the *, it's clear concise, and it will always be accurate regardless of versions changes. ########## File path: README.md ########## @@ -23,14 +23,79 @@ This is a VS Code extension which enables the interactive debugging of DFDL schema parsing using [Apache Daffodil](https://daffodil.apache.org/). +## Build Requirements +- SDK 8 or higher +- SBT 0.13.8 or higher +- Node 10 or higher -## Installation +## Installation - via release 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>`. +## Installation - via source + +:exclamation: Currently only Daffodil 3.1.0 is support, will be updated in the future :exclamation: + +Firstly clone the repo: +* apache/daffodil-vscode (https://github.com/apache/daffodil-vscode) + +Backend - Debugger: +* Note down the current version listed in `package.json`, eg `1.0.0` + * Referenced later as `${package.json_version}` +* 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: + +* Create daffoil debugger zip + ```bash + sbt universal:packageBin + ``` + * Package will be at + ``` + server/core/target/universal/daffodil-debugger-3.1.0-${package.json_version}.zip + ``` + eg + ``` + server/core/target/universal/daffodil-debugger-3.1.0-1.0.0.zip + ``` + +* Unzip debugger zip in data folder + ``` + unzip server/core/target/universal/daffodil-debugger-3.1.0-${package.json_version}.zip -d ~/Library/Application\ Support/dapodil + ``` + +Extension: + +:exclamation: This requires there to be a release with the version specified in `package.json` or for the steps for `Backend - Debugger` have been completed. :exclamation: Review comment: I'm not sure I understand what this means? ########## File path: README.md ########## @@ -23,14 +23,79 @@ This is a VS Code extension which enables the interactive debugging of DFDL schema parsing using [Apache Daffodil](https://daffodil.apache.org/). +## Build Requirements +- SDK 8 or higher +- SBT 0.13.8 or higher +- Node 10 or higher -## Installation +## Installation - via release 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>`. +## Installation - via source + +:exclamation: Currently only Daffodil 3.1.0 is support, will be updated in the future :exclamation: + +Firstly clone the repo: +* apache/daffodil-vscode (https://github.com/apache/daffodil-vscode) + +Backend - Debugger: +* Note down the current version listed in `package.json`, eg `1.0.0` + * Referenced later as `${package.json_version}` +* 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: + +* Create daffoil debugger zip + ```bash + sbt universal:packageBin + ``` + * Package will be at + ``` + server/core/target/universal/daffodil-debugger-3.1.0-${package.json_version}.zip + ``` + eg + ``` + server/core/target/universal/daffodil-debugger-3.1.0-1.0.0.zip + ``` + +* Unzip debugger zip in data folder + ``` + unzip server/core/target/universal/daffodil-debugger-3.1.0-${package.json_version}.zip -d ~/Library/Application\ Support/dapodil + ``` + +Extension: + +:exclamation: This requires there to be a release with the version specified in `package.json` or for the steps for `Backend - Debugger` have been completed. :exclamation: + +* Install + ```bash + yarn install + ``` + +* Compile + ```bash + yarn compile + ``` + +* Package + ```bash + yarn package + ``` + + * Creates file `daffodil-debugger-${package.json_version}.vsix` + +* Install VSIX file Review comment: I think this belongs in an Install section. -- 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]
