[js] Update hed-validator 3.12.0 → 3.13.0 (minor)

[depfu]

• closes https://github.com/bids-standard/bids-validator/issues/1868

Here is everything you need to know about this update. Please take a good look at what changed and the test results before merging this pull request.

What changed?

✳️ hed-validator (3.12.0 → 3.13.0) · Repo

Release Notes

3.13.0

Version 3.13.0 of the HED JavaScript validator introduces support for validating curly braces in sidecar data, as described in the HED specification.

Several aspects of the code layout were reconfigured:

• The BIDS validation and type modules have been refactored into folders based on file format.
• BidsData and its unused fields have been deleted.
• The string parsing code folder has been moved to the top level.
• The data underlying the BIDS tests has been moved to a separate data module.

Other smaller changes include:

• Bounds are no longer included in error messages.
• Sidecar keys and TSV line numbers are included in some error messages where appropriate.
• Internal errors during BIDS data validation now produce an error instead of a warning.
• The BidsTsvFile constructor (and its subclasses) now accept an unparsed string as the TSV file data, and this is now the preferred API.
• ParsedHedString and the subclasses of ParsedHedSubstring can now be pretty-printed using the format method.

Improvements were also made to the documentation, including an initial working version of an online documentation.

What's Changed

• Updated the readthedocs.yml by @VisLab in #120
• Updated readthedocs configuration as required by @VisLab in #121
• Added a post_install job to readthedocs.yml to generate docs by @VisLab in #122
• Relocated jobs to build section by @VisLab in #123
• Updated the readthedocs again by @VisLab in #124
• Bump @babel/traverse from 7.18.13 to 7.23.2 by @dependabot in #126
• Initial pass of javascript docs by @IanCa in #127
• Implement support for curly braces by @happy5214 in #125

New Contributors

• @IanCa made their first contribution in #127

Full Changelog: v3.12.0...v3.13.0

Does any of this look wrong? Please let us know.

Commits

See the full diff on Github. The new version differs by 69 commits:

• 3.13.0
• Merge pull request #125 from hed-standard/curly-braces
• Fix code setting ending bound of group specs
• Add additional test for coverage
• Add additional test
• Uncomment internal error handler
• Implement HED column splicing
• Refactor BIDS HED validation code into type-specific classes
• Implement placeholder splicing for curly braces
• Remove bounds from most issue messages
• Rewrite column splicer as class
• Reorganize BIDS curly brace tests
• Code Climate fixes
• Several changes to BIDS file structure
• Add new tests for curly braces (part 1) and related changes
• Compare indices instead of objects for duplicate tags
• Split BIDS test data into separate module
• Move HED-to-BIDS issue conversion functions to BidsHedIssue
• Add line number to issue
• Fix off-by-one typo
• Add missing initializer
• Implement column splicing for TSV files
• Update node CI matrix
• Add function to convert from old TSV format to new one
• Use port of BIDS TypeScript TSV parser
• Convert remaining uses of @return to @returns
• Implement sidecar-level validation of curly braces
• Fix BIDS issue code for internal error
• Add formatting methods to parsed substring classes
• Move string parsing to top level
• Flatten column splice type hierarchy
• Implement initial version of column splicer
• Add documentation
• Use lodash function to shorten Issue parameter string pre-conversion
• Refactor similar code in convertHedIssuesToBidsIssues
• Rewrite non-exported BIDS validation functions as class
• Split BidsSidecar.parseHedStrings for Code Climate reasons
• Merge tag and column splice iterators
• Add documentation for new functions
• Merge branch 'master' into curly-braces
• Rewrite issue message generation and add sidecar key to sidecar issues
• Merge pull request #127 from IanCa/dev_docs_final
• Add headers to the rest of the files
• Initial pass of javascript docs
• Merge pull request #126 from hed-standard/dependabot/npm_and_yarn/babel/traverse-7.23.2
• Bump @babel/traverse from 7.18.13 to 7.23.2
• Fix curly brace validation in definitions
• Don't run validator if there were parsing issues
• Parse sidecar HED strings in BidsSidecar
• Add list of column splices to ParsedHedString
• Merge pull request #124 from VisLab/master
• Reorder check for efficiency
• Initial implementation of curly braces
• Minor change to the readthedocs
• Fixed the docs
• Changed @return to @returns in the doc strings
• Updated the readthedocs again
• Merge pull request #123 from VisLab/master
• Relocated jobs to build section
• Merge pull request #122 from VisLab/master
• Added a post_install job to readthedocs.yml to generate docs
• Merge pull request #121 from VisLab/master
• Updated readthedocs configuration as required
• Merge pull request #120 from VisLab/master
• Adjusted the readthedocs.yml
• Removed python.version from readthedocs.yaml
• Updated the readthedocs.yml
• Add BIDS test for missing HEDVersion field
• Move XML file transformer to root

---

Depfu will automatically keep this PR conflict-free, as long as you don't add any commits to this branch yourself. You can also trigger a rebase manually by commenting with @depfu rebase.

All Depfu comment commands

@​depfu rebase

Rebases against your default branch and redoes this update

@​depfu recreate

Recreates this PR, overwriting any edits that you've made to it

@​depfu merge

Merges this PR once your tests are passing and conflicts are resolved

@​depfu cancel merge

Cancels automatic merging of this PR

@​depfu close

Closes this PR and deletes the branch

@​depfu reopen

Restores the branch and reopens this PR (if it's closed)

@​depfu pause

Ignores all future updates for this dependency and closes this PR

@​depfu pause [minor|major]

Ignores all future minor/major updates for this dependency and closes this PR

@​depfu resume

Future versions of this dependency will create PRs again (leaves this PR as is)

[effigies]

@happy5214 looks like there are some compatibility issues

[happy5214]

@happy5214 looks like there are some compatibility issues

Yes. BidsTsvFile.parsedTsv now uses a Map (like the bids-validator Deno parser) instead of the object format inherited from the current bids-validator parser. The field was not intended to be part of the public API, despite it being a public field (it's really package-private, and I usually only mark class-private members as such), so bids-validator should really have never relied on it being stable. I created a new method on BidsFile and subclasses to detect HED data, to be released in a new 3.13.1 release (tagged but not on npm at this moment). This method API should remain stable.

[happy5214]

This PR should be replaced with #1869, which updates the dependency to 3.13.1 and resolves the compatibility issue.