Google Git
Sign in
apache / daffodil-vscode / 0ce6dd1d3ecaaf09682c3ddacd49a0250f8adcee
commit0ce6dd1d3ecaaf09682c3ddacd49a0250f8adcee[log] [tgz]
authorShane Dell <32347414+Shanedell@users.noreply.github.com>Fri Feb 18 11:18:59 2022 -0500
committerShane Dell <32347414+Shanedell@users.noreply.github.com>Fri Feb 18 13:08:49 2022 -0500
tree853260a08ed28b60c87df4fda3ac232f5e84ce88
parent96a30df51cc51a01b5b766a25112d9e23b2abbed [diff]
Multiple Updates:

- Update apache daffodil logo to be png not svg
- Fix icon issue by:
  - Downloading apache daffodil logo locally to images folder
  - Fix path to it in package.json "images/daffodil.ico"
- Update binary name so that when yarn build run it creates "apache-daffodil-vscode-VERSION.vsix"
  - change "name" attribute inside of package.json to "apache-daffodil-vscode"
- Update ratchCheck to ignore "images/daffodil.ico" instead of "images/daffodil.jpg"

Closes #81
Closes #82
Closes #83
4 files changed
tree: 853260a08ed28b60c87df4fda3ac232f5e84ce88
  1. .github/
  2. .vscode/
  3. build/
  4. images/
  5. project/
  6. server/
  7. snippets/
  8. src/
  9. .asf.yml
  10. .gitignore
  11. .prettierignore
  12. .prettierrc
  13. .scalafmt.conf
  14. .vscodeignore
  15. build.sbt
  16. LICENSE
  17. NOTICE
  18. package.json
  19. README.md
  20. tsconfig.json
  21. yarn.lock
README.md

Apache Daffodil VS Code Extension

Unit Tests Code Formatting Rat Check

This is a VS Code extension which enables the interactive debugging of DFDL schema parsing using Apache Daffodil.

Build Requirements

Download - Prebuilt

Until the extension is available in the VS Code Extension Marketplace, please download the latest .vsix file from the releases page.

Build VSIX and Debugger

:exclamation:NOT necessary if using prebuilt VSIX:exclamation:

:exclamation:NOT necessary if running extension via VS Code without VSIX but a yarn install will be required:exclamation:

Run full build

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 VS Code 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

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

    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 GitHub Issues.

License

Apache Daffodil VS Code Extension is licensed under the Apache License, v2.0.

This product includes the logback library, which is available under the Eclipse Public License v1.0.

This product includes the Java Debug Server for Visual Studio Code library, which is available under the Eclipse Public License v1.0.