stevedlawrence commented on a change in pull request #37: URL: https://github.com/apache/daffodil-vscode/pull/37#discussion_r739166949
########## 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: Review comment: Do these directories need to be mentioned? Doesn't the extension handle this directory automatically so he user doesn't need to do anything with it? Also, isn't it daffodil-dap now? ########## 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 Review comment: At first I thought this was a list of things that need to be done, but it's actually a list of things that yarn build does? Can you add a sentence that makes this clear? Something like `This command performs the following tasks:` ########## 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: Review comment: I'm not sure what "Backend - Debugger Server" refers do? It's also not clear what does "debugging the extension locally" mean? Is this building things using VSCode? Is this another way to build/test other than VSIX? I don't think that's made clear. This section feels like you're assuming knowledge that someone new to this isn't going to understand. If this is about how to build this with VSCode, I wonder if a better option would be to just have a wiki page that goes into all the details about how to do that? So this page is really all about building the .vsix file so that someone can build/install from scratch. If they want to do more and get into development, the wiki has that detail? That's essentially what we do with Daffodil. The main README just talks about how to build and test plus a few helpful commands. The wiki has much more inforamtion about how to set things up to use eclipse/intellij, code contribution workflow, release workflow, etc (i.e. everything a developer needs to know) ########## 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: While you're making changes, can you copy the `Getting Help` and `License` sections from the Daffodil README? ########## 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 Review comment: This doesn't need to be a list. ########## 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: Review comment: What does "debugging an extension" mean? And doesn't `yarn build` install the dependencies? Ah guess this is saying if your following the "Backend - Debugger Server" steps? ########## 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 Review comment: `Creates Files:` -- 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]
