hed-validator v3.13.2

This release deprecates BidsEventFile and BidsTabularFile in favor of the isTimelineFile property on their parent class, BidsTsvFile. A true value for isTimelineFile corresponds to the previous usage of BidsEventFile, while a false value corresponds to BidsTabularFile.

A bug was also fixed in the handling of sidecar parsing errors. The validation now stops immediately upon encountering parsing errors, instead of attempting to validate (invalid) ParsedHedString objects. This should also fix several reports of HED errors without useful messages in bids-validator, such as https://github.com/bids-standard/bids-validator/pull/1869#issuecomment-1865993337.

Full Changelog: v3.13.1...v3.13.2

hed-validator v3.13.1

This is a patch release to deal with a bug in version 3.13.0. We have added a new hasHedData() method on the BidsFile class hierarchy as the only supported way to determine if a file has HED data. All previous methods of detection, including those involving checking the object's fields directly, are immediately unsupported. They were never considered by us to be part of the stable external API, but rather package-internal.

Full Changelog: v3.13.0...v3.13.1

hed-validator v3.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

hed-validator v3.12.0

The only new feature in this release is support for validating HED data in non-event BIDS TSV files and sidecars (pending changes to bids-validator).

What's Changed

• Update package-lock.json for TypeScript by @happy5214 in #117
• Implement validation for non-event TSV files by @happy5214 in #119

Full Changelog: v3.11.0...v3.12.0

hed-validator v3.11.0

The primary new feature in v3.11.0 is validation of definitions based on their BIDS dataset context. To coincide with this change, the interfaces of the (deprecated) functions validateHedEvent and validateHedString were modified to allow for passing an object with the configuration options as the last parameter with the configuration options. The newest version of the SCORE library schema, v1.1.0, has been bundled with this release.

This release also sees the initial steps toward formal documentation of the validator, which makes up the bulk of the changelog below. The documentation is not yet ready for release.

What's Changed

• Bump semver from 7.3.5 to 7.5.2 by @dependabot in #107
• Initial setup for readthedocs documentation by @VisLab in #108
• Added a requirement for typescript by @VisLab in #109
• Added a nodejs tool requirement to readthedocs configuration by @VisLab in #111
• Added os to build configuration for readthedocs by @VisLab in #112
• Fixed nodejs version in build configuration for readthedocs by @VisLab in #113
• Removed the image option from the build configuration by @VisLab in #114
• Modified the Python install requirements for readthedocs by @VisLab in #115
• Bump tough-cookie from 4.1.2 to 4.1.3 by @dependabot in #110
• Bump word-wrap from 1.2.3 to 1.2.4 by @dependabot in #116
• Implement definition-related validation in BIDS by @happy5214 in #106

Full Changelog: v3.10.0...v3.11.0

hed-validator v3.10.0

New to this release:

• Segregated HED 2 code.
• Improved tag conversion.
• Added support for partnered schemas.
• Implemented support for Inset tags.
• Added warning for a BIDS categorical column value not found in sidecar (moved from bids-validator).
• Fixed fallback schema implementation.

What's Changed

• Bump xml2js from 0.4.23 to 0.5.0 by @dependabot in #99
• Separate HED 2 code by @happy5214 in #98
• Tag conversion improvements by @happy5214 in #100
• Update README.md to have code climate badges by @VisLab in #101
• Provide support for partner schemas by @happy5214 in #102
• Implement Inset validation by @happy5214 in #105

Full Changelog: v3.9.0...v3.10.0

hed-validator v3.9.0

New to this release:

• Support for Onset and Offset validation.
• Switched to ES modules.
• Started to link issues to HED 3 error codes.

What's Changed

• Port entire codebase to ES modules by @happy5214 in #86
• Add advanced features (part 1) by @happy5214 in #87
• Bump qs from 6.10.1 to 6.11.0 by @dependabot in #92
• Bump json5 from 2.2.1 to 2.2.3 by @dependabot in #93
• Update remote schema URLs and SCORE schema tests and bundled copy by @happy5214 in #94
• Implement onset-offset validation by @happy5214 in #95

Full Changelog: v3.8.0...v3.9.0

hed-validator v3.8.0

Highlights of this release include initial support for library schemas and a rewrite of the string parser. Several legacy APIs were also deprecated, and they will be removed in v4.0.0.

What's Changed

• Rewrite string parser by @happy5214 in #76
• Flatten schemas by @happy5214 in #77
• Library schemas added missing expected issues message by @VisLab in #78
• Fixed some of the tests in bids spec by @VisLab in #81
• Restructured tests for library schema with Defs by @VisLab in #82
• Implement support for library schemas by @happy5214 in #75
• Revision of the README by @VisLab in #85

Full Changelog: v3.7.1...v3.8.0

Bugs

This and earlier versions of hed-validator do not support versions 8.2.0 or above of the HED standard schema due to a change in schema properties. Please upgrade to version 3.9.0 of hed-validator or use versions 8.0.0-8.1.0 of the HED standard schema with this version.