Skip to content

Commit 706762f

Browse files
committed
Use OmegaEdit data editor extension dependency
1 parent 7c99986 commit 706762f

112 files changed

Lines changed: 733 additions & 17298 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.prettierrc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
{
2-
"plugins": ["prettier-plugin-svelte"],
32
"semi": false,
43
"singleQuote": true,
54
"tabWidth": 2,

DEVELOPMENT.md

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,6 @@
6969
- [Yarn Package Issues](#yarn-package-issues)
7070
- [If Yarn Keeps Updating to The Latest Version](#if-yarn-keeps-updating-to-the-latest-version)
7171
- [Yarn Test Issues](#yarn-test-issues)
72-
- [Data Editor Opens Test Case Failing](#data-editor-opens-test-case-failing)
7372
- [TLS Certificate Issues](#tls-certificate-issues)
7473
- [Tests Failing When Connected Through SSH](#tests-failing-when-connected-through-ssh)
7574
- [Debugging Issues](#debugging-issues)
@@ -397,7 +396,7 @@ Your window should look like the following. Note that you may have to move some
397396

398397
![ide-debug](https://github.com/user-attachments/assets/dbc8a48e-b528-4861-8163-6c167c4d60fa)
399398

400-
Here’s an example view of the data editor (OmegaEdit) with the schema on the left.
399+
Here’s an example view of the Ωedit Data Editor dependency with the schema on the left.
401400

402401
![ide-debug2](https://github.com/user-attachments/assets/9b982947-2f9c-45b0-8d6f-7b86eef1bacd)
403402

@@ -489,7 +488,7 @@ As of typing this document (Feb 2025), the latest version of yarn is 4.6.0. If y
489488
➤ YN0087: Migrated your project to the latest Yarn version ��
490489
➤ YN0000: · Yarn 4.6.0
491490
➤ YN0000: ┌ Resolution step
492-
➤ YN0085: │ + @omega-edit/client@npm:0.9.83, @tsconfig/svelte@npm:5.0.2, @types/glob@npm:8.1.0, @types/mocha@npm:10.0.6, @types/node@npm:20.11.30, @types/vscode-webview@npm:1.57.4, @types/vscode@npm:1.95.0, @viperproject/locate-java-home@npm:1.1.15, @vscode/debugadapter-testsupport@npm:1.65.0, @vscode/debugadapter@npm:1.67.0, @vscode/test-electron@npm:2.3.8, @vscode/vsce@npm:2.22.0, @vscode/webview-ui-toolkit@npm:1.4.0, await-notify@npm:1.0.1, chai@npm:4.4.1, and 703 more.
491+
➤ YN0085: │ + @types/glob@npm:8.1.0, @types/mocha@npm:10.0.6, @types/node@npm:20.11.30, @types/vscode@npm:1.95.0, @viperproject/locate-java-home@npm:1.1.15, @vscode/debugadapter-testsupport@npm:1.65.0, @vscode/debugadapter@npm:1.67.0, @vscode/test-electron@npm:2.3.8, @vscode/vsce@npm:2.22.0, @vscode/webview-ui-toolkit@npm:1.4.0, await-notify@npm:1.0.1, chai@npm:4.4.1, and more.
493492
➤ YN0000: └ Completed in 9s 958ms
494493
➤ YN0000: ┌ Post-resolution validation
495494
➤ YN0002: │ apache-daffodil-vscode@workspace:. doesn't provide react (pa7c88), requested by @vscode/webview-ui-toolkit.
@@ -500,8 +499,6 @@ As of typing this document (Feb 2025), the latest version of yarn is 4.6.0. If y
500499
➤ YN0000: └ Completed in 4m 47s
501500
➤ YN0000: ┌ Link step
502501
➤ YN0007: │ esbuild@npm:0.19.9 must be built because it never has been before or the last one failed
503-
➤ YN0007: │ svelte-preprocess@npm:5.1.1 [5fe27] must be built because it never has been before or the last one failed
504-
➤ YN0007: │ svelte-preprocess@npm:5.1.1 [ab741] must be built because it never has been before or the last one failed
505502
➤ YN0007: │ keytar@npm:7.9.0 must be built because it never has been before or the last one failed
506503
➤ YN0007: │ protobufjs@npm:7.4.0 must be built because it never has been before or the last one failed
507504
➤ YN0000: └ Completed in 2m 40s
@@ -514,10 +511,6 @@ To remedy this, you need to change versions of Yarn. Use `yarn set version 1.22.
514511

515512
#### Yarn Test Issues
516513

517-
##### Data Editor Opens Test Case Failing
518-
519-
This means port 9000 is Occupied. See the current workarounds section in ["data editor opens" test fails if Port 9000 is Occupied · Issue #1175 · apache/daffodil-vscode](https://github.com/apache/daffodil-vscode/issues/1175).
520-
521514
##### TLS Certificate Issues
522515

523516
HTTPS TLS certificates are verified by default. When running the test suite in certain environments (e.g., company VPN that uses endpoint protection), TLS certificate verifications may fail with a self-signed certificate error. If this is the case, either have node trust the endpoint protection certificate, or use one of these workarounds to disable the certificate verification:
@@ -600,8 +593,6 @@ If issues persist, you may want to uninstall Node and reinstall it. If that does
600593

601594
For issues not mentioned in this section, the log files for the debugger are located in your OS temp directory (e.g. `/tmp` for Ubuntu 24.04.2). The log file for the debugger should be named `daffodil-debugger-<port>.log` when debugging the extension or `yarn-test-daffodil-debugger-<port>.log` when running yarn test.
602595

603-
The log files for the data editor are located in your OS app data path (e.g. `/home/<user>/.local/share/omega_edit`). The log files for the data editor should be named `serv-<port>.log` for the server logs and `dataEditor-<port>.log` for the data editor logs when using the data editor or `test-serv-<port>.log` and `test-dataEditor-<port>.log` when running yarn test.
604-
605596
## Development Specific
606597

607598
### Dependency Licensing Information

LICENSE

Lines changed: 0 additions & 195 deletions
Original file line numberDiff line numberDiff line change
@@ -410,201 +410,6 @@ conditions of the following licenses.
410410
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
411411
SOFTWARE.
412412

413-
- src/svelte/resources/fonts/RedHatMono-Regular.woff2
414-
This product bundles the above files from the 'RedHatFont' repo. (https://github.com/RedHatOfficial/RedHatFont)
415-
These files are available under the SIL Open Font License, Version 1.1:
416-
Copyright 2021 Red Hat, Inc.,
417-
with Reserved Font Name Red Hat.
418-
419-
This Font Software is licensed under the SIL Open Font License, Version 1.1.
420-
This license is copied below, and is also available with a FAQ at:
421-
http://scripts.sil.org/OFL
422-
423-
424-
-----------------------------------------------------------
425-
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
426-
-----------------------------------------------------------
427-
428-
PREAMBLE
429-
The goals of the Open Font License (OFL) are to stimulate worldwide
430-
development of collaborative font projects, to support the font creation
431-
efforts of academic and linguistic communities, and to provide a free and
432-
open framework in which fonts may be shared and improved in partnership
433-
with others.
434-
435-
The OFL allows the licensed fonts to be used, studied, modified and
436-
redistributed freely as long as they are not sold by themselves. The
437-
fonts, including any derivative works, can be bundled, embedded,
438-
redistributed and/or sold with any software provided that any reserved
439-
names are not used by derivative works. The fonts and derivatives,
440-
however, cannot be released under any other type of license. The
441-
requirement for fonts to remain under this license does not apply
442-
to any document created using the fonts or their derivatives.
443-
444-
DEFINITIONS
445-
"Font Software" refers to the set of files released by the Copyright
446-
Holder(s) under this license and clearly marked as such. This may
447-
include source files, build scripts and documentation.
448-
449-
"Reserved Font Name" refers to any names specified as such after the
450-
copyright statement(s).
451-
452-
"Original Version" refers to the collection of Font Software components as
453-
distributed by the Copyright Holder(s).
454-
455-
"Modified Version" refers to any derivative made by adding to, deleting,
456-
or substituting -- in part or in whole -- any of the components of the
457-
Original Version, by changing formats or by porting the Font Software to a
458-
new environment.
459-
460-
"Author" refers to any designer, engineer, programmer, technical
461-
writer or other person who contributed to the Font Software.
462-
463-
PERMISSION & CONDITIONS
464-
Permission is hereby granted, free of charge, to any person obtaining
465-
a copy of the Font Software, to use, study, copy, merge, embed, modify,
466-
redistribute, and sell modified and unmodified copies of the Font
467-
Software, subject to the following conditions:
468-
469-
1) Neither the Font Software nor any of its individual components,
470-
in Original or Modified Versions, may be sold by itself.
471-
472-
2) Original or Modified Versions of the Font Software may be bundled,
473-
redistributed and/or sold with any software, provided that each copy
474-
contains the above copyright notice and this license. These can be
475-
included either as stand-alone text files, human-readable headers or
476-
in the appropriate machine-readable metadata fields within text or
477-
binary files as long as those fields can be easily viewed by the user.
478-
479-
3) No Modified Version of the Font Software may use the Reserved Font
480-
Name(s) unless explicit written permission is granted by the corresponding
481-
Copyright Holder. This restriction only applies to the primary font name as
482-
presented to the users.
483-
484-
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
485-
Software shall not be used to promote, endorse or advertise any
486-
Modified Version, except to acknowledge the contribution(s) of the
487-
Copyright Holder(s) and the Author(s) or with their explicit written
488-
permission.
489-
490-
5) The Font Software, modified or unmodified, in part or in whole,
491-
must be distributed entirely under this license, and must not be
492-
distributed under any other license. The requirement for fonts to
493-
remain under this license does not apply to any document created
494-
using the Font Software.
495-
496-
TERMINATION
497-
This license becomes null and void if any of the above conditions are
498-
not met.
499-
500-
DISCLAIMER
501-
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
502-
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
503-
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
504-
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
505-
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
506-
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
507-
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
508-
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
509-
OTHER DEALINGS IN THE FONT SOFTWARE.
510-
511-
- src/svelte/resources/fonts/SpaceGrotesk-Variable.woff2
512-
This product bundles the above files from the 'space-grotesk' repo. (https://github.com/floriankarsten/space-grotesk)
513-
These files are available under the SIL Open Font License, Version 1.1:
514-
Copyright 2020 The Space Grotesk Project Authors (https://github.com/floriankarsten/space-grotesk)
515-
516-
This Font Software is licensed under the SIL Open Font License, Version 1.1.
517-
This license is copied below, and is also available with a FAQ at:
518-
http://scripts.sil.org/OFL
519-
520-
521-
-----------------------------------------------------------
522-
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
523-
-----------------------------------------------------------
524-
525-
PREAMBLE
526-
The goals of the Open Font License (OFL) are to stimulate worldwide
527-
development of collaborative font projects, to support the font creation
528-
efforts of academic and linguistic communities, and to provide a free and
529-
open framework in which fonts may be shared and improved in partnership
530-
with others.
531-
532-
The OFL allows the licensed fonts to be used, studied, modified and
533-
redistributed freely as long as they are not sold by themselves. The
534-
fonts, including any derivative works, can be bundled, embedded,
535-
redistributed and/or sold with any software provided that any reserved
536-
names are not used by derivative works. The fonts and derivatives,
537-
however, cannot be released under any other type of license. The
538-
requirement for fonts to remain under this license does not apply
539-
to any document created using the fonts or their derivatives.
540-
541-
DEFINITIONS
542-
"Font Software" refers to the set of files released by the Copyright
543-
Holder(s) under this license and clearly marked as such. This may
544-
include source files, build scripts and documentation.
545-
546-
"Reserved Font Name" refers to any names specified as such after the
547-
copyright statement(s).
548-
549-
"Original Version" refers to the collection of Font Software components as
550-
distributed by the Copyright Holder(s).
551-
552-
"Modified Version" refers to any derivative made by adding to, deleting,
553-
or substituting -- in part or in whole -- any of the components of the
554-
Original Version, by changing formats or by porting the Font Software to a
555-
new environment.
556-
557-
"Author" refers to any designer, engineer, programmer, technical
558-
writer or other person who contributed to the Font Software.
559-
560-
PERMISSION & CONDITIONS
561-
Permission is hereby granted, free of charge, to any person obtaining
562-
a copy of the Font Software, to use, study, copy, merge, embed, modify,
563-
redistribute, and sell modified and unmodified copies of the Font
564-
Software, subject to the following conditions:
565-
566-
1) Neither the Font Software nor any of its individual components,
567-
in Original or Modified Versions, may be sold by itself.
568-
569-
2) Original or Modified Versions of the Font Software may be bundled,
570-
redistributed and/or sold with any software, provided that each copy
571-
contains the above copyright notice and this license. These can be
572-
included either as stand-alone text files, human-readable headers or
573-
in the appropriate machine-readable metadata fields within text or
574-
binary files as long as those fields can be easily viewed by the user.
575-
576-
3) No Modified Version of the Font Software may use the Reserved Font
577-
Name(s) unless explicit written permission is granted by the corresponding
578-
Copyright Holder. This restriction only applies to the primary font name as
579-
presented to the users.
580-
581-
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
582-
Software shall not be used to promote, endorse or advertise any
583-
Modified Version, except to acknowledge the contribution(s) of the
584-
Copyright Holder(s) and the Author(s) or with their explicit written
585-
permission.
586-
587-
5) The Font Software, modified or unmodified, in part or in whole,
588-
must be distributed entirely under this license, and must not be
589-
distributed under any other license. The requirement for fonts to
590-
remain under this license does not apply to any document created
591-
using the Font Software.
592-
593-
TERMINATION
594-
This license becomes null and void if any of the above conditions are
595-
not met.
596-
597-
DISCLAIMER
598-
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
599-
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
600-
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
601-
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
602-
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
603-
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
604-
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
605-
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
606-
OTHER DEALINGS IN THE FONT SOFTWARE.
607-
608413
The following NOTICE information applies to binary components distributed with this project:
609414

610415
- com.fasterxml.jackson.core.jackson-core-2.13.4.jar

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,12 +48,12 @@ The Apache Daffodil™ Extension for Visual Studio provides a Daffodil parse deb
4848

4949
![image 3](images/DE-brief.png)
5050

51-
The Apache Daffodil™ Extension for Visual Studio Code provides an integrated data editor tuned specifically for challenging Daffodil use cases. It is designed to support large files, of any type, that are well beyond the limits of the standard text editor in VS Code. The Data Editor enables the editing of single or multiple bytes in various encodings. The Data Editor can seek to file offsets, search and replace byte sequences, profile data, and determine a file's content type. Features of the Data Editor will evolve to address the specific needs of the Daffodil community.
51+
The Apache Daffodil™ Extension for Visual Studio Code integrates with the Ωedit™ Data Editor extension for challenging Daffodil use cases. The data editor is declared as a VS Code extension dependency and is designed to support large files, of any type, that are well beyond the limits of the standard text editor in VS Code. It enables editing single or multiple bytes in various encodings, seeking to file offsets, searching and replacing byte sequences, profiling data, and determining a file's content type.
5252

5353
### Data Debugger Integration
5454
![image](https://github.com/apache/daffodil-vscode/assets/30351915/7f906c91-83bc-454e-a164-4dad51842887)
5555

56-
The Data Editor component can be configured to run alongside and open the designated file specified by the data debugger. During this operation, whenever the debug session steps to a new byte position or stops at a breakpoint, the data content within the Data Editor will illustrate the byte location.
56+
The Data Editor can be configured to open the designated data file when a Daffodil debug session starts. As the debug session steps to new byte positions, Daffodil sends byte-location highlights to the Ωedit™ Data Editor so the parse location is visible in the data content.
5757

5858
# Prerequisites
5959

0 commit comments

Comments
 (0)