Skip to content

hed-validator v4.1.0

Compare
Choose a tag to compare
@happy5214 happy5214 released this 05 Aug 20:21
· 137 commits to main since this release
v4.1.0

📦 Release Highlights

This release includes major progress on support for browser-based HED validation, significant documentation improvements, refactoring, testing enhancements, and dependency upgrades to keep the codebase current.

🚀 Major Features

  • Initial implementation of browser-based HED validation:

    • Includes dataset upload, sidecar merging, and JSON validation.
    • Adds interface elements such as validation buttons, clear/reset, and download of issue reports.
    • Fully supports both web-based and filesystem-based workflows.
    • See: #400, #403, #416, #417
  • Bundled HED schemas updated and expanded:
    Bundled schemas now include the latest versions (e.g., 8.4.0), with proper access across environments.
    See: #381, #443, #496

  • Initial implementation of TypeScript type declarations for the public API.

🧪 Testing & CI Improvements

  • Split test framework: Separate testing paths for Node and browser environments.
  • New GitHub Actions workflows: CI updates, browser test automation, and deployment flow stabilization.
  • Code coverage tools reconfigured: Includes move to Qlty configuration and replacement for Code Climate.

Related PRs:
#344, #520, #445, #446

📘 Documentation

  • Reorganized and enhanced API documentation using TypeDoc.
  • Jekyll-based site created for GitHub Pages hosting of the documentation and browser validator.
  • Improved error message specificity and context in the validation output.

Related PRs:
#428, #426, #436

🛠️ Refactoring and Fixes

  • Reorganized internal structure for file loading, schema parsing, and better environment separation.
  • Added static methods for constructing BIDS file objects from paths.
  • Improved tokenizer and sidecar context-based error reporting.
  • Removed legacy dependencies and improved Jest and Vite configuration.

See:
#384, #397, #468, #510

📦 Dependency Updates

Numerous updates to keep dependencies current and secure. Notable upgrades include:

  • ESLint: 9.22.0 → 9.31.0
  • TypeDoc: 0.28.0 → 0.28.7
  • TypeScript: 5.8.2 → 5.8.3
  • Jest: 29.7.0 → 30.0.5
  • Prettier: 3.5.3 → 3.6.2
  • esbuild: 0.25.1 → 0.25.8
  • Plus related plugins (eslint-plugin-prettier, eslint-config-prettier, etc.)

Most updates were handled via Dependabot.

👥 Contributors

Thanks to everyone who contributed to this release:


Let us know if you run into any issues, and stay tuned for further improvements to the web interface and validation tools!

Full Changelog: v4.0.1...v4.1.0