Google Git
Sign in
apache / daffodil-vscode / 9f3957572577fdf4f53f36b187f4733656dd880c
commit9f3957572577fdf4f53f36b187f4733656dd880c[log] [tgz]
authorShane Dell <shanedell100@gmail.com>Thu Nov 03 22:06:48 2022 -0400
committerShane Dell <32347414+Shanedell@users.noreply.github.com>Fri Nov 04 12:37:35 2022 -0400
tree6f8ebb1b33d0d100855caf52bff332e40603f648
parent64bbb7e12d435f305383f5101e016688cb597940 [diff]
LICENSE and NOTICE updates:

- Create NOLICENSE file. Holds a list of yarn and scala depedencies that are either:
  - say they are licensed but do not provide any license data
  - have no license.
- Create NONOTICE file. Holds a list of yarn and scala dependencies that are ALv2 licensed but provide no notice in their repo.
- Add all node packages to LICENSE, NOTICE, NOLICENSE or NONOTICE files.
- Remove md5-file and run-script-os from build/package/LICENSE as these packages are no longer used

Closes #333
4 files changed
tree: 6f8ebb1b33d0d100855caf52bff332e40603f648
  1. .github/
  2. .vscode/
  3. build/
  4. images/
  5. language/
  6. project/
  7. server/
  8. src/
  9. .asf.yaml
  10. .gitignore
  11. .prettierignore
  12. .prettierrc
  13. .scalafmt.conf
  14. build.sbt
  15. LICENSE
  16. NOTICE
  17. package.json
  18. README.md
  19. tsconfig.json
  20. yarn.lock
README.md

Apache Daffodil VS Code Extension

CI

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.

Package 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 package

yarn package
  • 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
apache-daffodil-vscode-*.vsix

Running Debug Server

The debug server will automatically be run by the extension unless useExistingServer is to set to true inside of .vscode/launch.json

If you wish to run 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 apache-daffodil-vscode-*.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.