Skip to content

CHANGELOG.md

Latest commit

 

History

History
478 lines (279 loc) · 13 KB

CHANGELOG.md

File metadata and controls

478 lines (279 loc) · 13 KB
Raw

Changelog

"2.4.1" — 2026-02-20

Changed

  • Update to BIDS Schema v1.2.1 (BIDS v1.11.1)

  • The web validator now renders Markdown in issue messages.

Fixed

  • Validating directory names is now skipped for unknown DatasetTypes in dataset_description.json. Previously this would crash, preventing the error in DatasetType values from being reported to the user.

Infrastructure

  • Added a pre-commit configuration for developers. To enable, run pre-commit install. For speed, we recommend installing pre-commit via uv tool install pre-commit --with=pre-commit-uv.

"2.4.0" — 2026-02-05

Changed

  • Update to BIDS Schema v1.2.0 (BIDS v1.11.0)

"2.3.2" — 2026-02-02

Changed

  • File reads are temporarily cached to avoid multiple fetches/opens.

Fixed

  • Retrieval of remote data on S3 is now more robust, avoiding resource leaks by setting timeouts and a reasonable retry protocol.

"2.3.1" — 2026-01-27

Mismatch between version and tag. Re-releasing for consistency. No other changes.

"2.3.0" — 2026-01-27

Changed

  • Improve types for memoized functions by passing argument and return types to callers.

  • Render Markdown links as OSC-8 links in terminals where support is detected.

Fixed

  • Exit with a non-zero exit code if nested datasets are validated and found to have errors.

  • Prevent HED check from failing for null values found in sidecar metadata.

"2.2.10" — 2026-01-15

Changed

  • Improve types for memoized functions by passing argument and return types to callers.

Fixed

  • Extract AWS region from S3 special remote, defaulting to us-east-1.

"2.2.9" — 2026-01-15

Changed

  • Reverted terminal URLs for the 2.2.x series. It should be back in 2.3.0.

"2.2.8" — 2026-01-15

Changed

  • Render Markdown links as OSC-8 links in terminals where support is detected.

Fixed

  • Fix typo in S3 URL generation code that prevented reading remote files.

"2.2.7" — 2026-01-13

Added

  • Maintainer documentation for creating and fixing releases.

  • Support for rendering Markdown in validation messages in the terminal.

  • Display validation summaries for derivative datasets when recursive validation (-r/--recursive) is run.

  • Support for presigning S3 URLs if AWS credentials are detected.

Fixed

  • Validate derivative file paths relative to the derivative dataset root.

  • Have all three calls to fetch in HttpOpener use same error handling.

  • Fix memoization memory leak for readRemotes.

  • Replace SPEC_ROOT placeholder with actual documentation link in CLI output

Infrastructure

  • Pin Deno to 2.5.6 in wheel builds to account for bugs with MacOS binaries compiled with 2.6.0.

"2.2.5" — 2025-12-10

Added

  • Support for template and cohort directories, as introduced in BEP038.

Fixed

  • The AMBIGUOUS_AFFINE issue was given an error message and set to warning.

  • Very oblique affines are no longer considered ambiguous.

  • Resolved TypeError when rendering issues for JSON outputs.

"2.2.4" — 2025-12-05

Added

  • Annexed files with base-64-encoded version information are now supported.

"2.2.3" — 2025-11-25

Fixed

  • NIfTI files with bad qform matrices, resulting from non-normalized quaternions, would previously raise a NIFTI_HEADER_UNREADABLE error. Now only the axis codes are disabled, preventing orientation checks, but not raising errors.

"2.2.2" — 2025-11-12

Changed

  • Support min() and max() of numbers in the expression language. This allows for simpler rules when a field may be a number or array of numbers.

  • Annexed files that are not local are treated as empty instead of erroring if a remote URL could not be constructed. The size of missing files are included in the summary estimate of dataset size.

Fixed

  • INVALID_FILE_ENCODING issues now print sensible messages instead of crashing.

"2.2.1" — 2025-10-27

Added

  • Support for associations.physio and associations.events.sidecar.

  • Implement associations.coordsystems to collate multiple coordsystem.json files, as required by BEP 042 (EMG).

Changed

  • Validation context generation was tweaked to improve concurrency, giving 4x validation speedups in some cases.

"2.2.0" — 2025-10-14

Added

  • Added --format option to specify output format: text (default), json, or json_pp (pretty-printed JSON)

  • Pretty-printed JSON output support via --format json_pp option

  • Datalad/git-annex datasets with remote content in public S3 buckets can be validated with the --preferredRemote <remote-name> flag. If a public S3 bucket is detected without this flag, the most recent export is used.

Changed

  • Refactored file access classes to be more DRY.

Fixed

  • Circular references that could lead to a hanging process were mitigated. #278

Deprecated

  • Deprecated --json option in favor of --format json (backward compatibility maintained)

2.1.1 — 2025-09-26

Added

  • Additional (dataset-defined) columns are now validated against the definitions in the sidecar files.

  • Throw error on file name case collision.

  • Add support for the unique() function in schema expressions.

  • Support issues messages that access validation context variables.

Changed

  • Initial column TSV checks now support missing, optional initial columns.

  • Index column TSV checks now support missing, optional index columns.

  • Now supports Deno 2.5 and Typescript 5.9.2.

  • Parsed JSON files are now cached to reduce I/O and parsing costs.

  • Throw an error if specified schema (e.g. via --schema or BIDS_SCHEMA env var) could not be loaded.

Fixed

  • File access failures consistently produce FILE_READ errors across all file types.

  • Fixed json encoding issue in web log download (#174).

  • Throw utf-8 encoding error for tsv files similar to json files.

2.1.0 — 2025-09-03

This release adds support for BIDS 1.10.1.

Added

  • Load .tsv.gz column contents for validation.

  • Issue deprecation warning for "89+" in age columns, per bids-standard/bids-specification#2162.

  • Added support for extracting image orientation from NIfTI headers, added to the BIDS schema in 1.10.1.

Changed

  • Raise errors for all TSV type check failures. Previously, recommended and optional fields would raise warnings.

  • Updated @bids/schema to ~1.1.0, corresponding to BIDS version 1.10.1.

Fixed

  • Avoid descending into opaque directories (such as *.zarr/) when checking for unused sidecars. (#227)

2.0.11 — 2025-08-29

Fixed

  • Docker build workflow should now run correctly on releases.

2.0.10 — 2025-08-29

Added

  • Added a FAQ to the user guide. (#215)

Changed

  • Improved handling of TSV columns with sidecar definitions. "Format", "Minimum" and "Maximum" keys are now supported.

  • --datasetTypes and --blacklistModalities options now accept a string array (--datasetTypes raw,derivative) and can be combined.

Fixed

  • A crash in the web validator prevented validation from taking place.

Infrastructure

"2.0.9" — 2025-08-26

Added

  • Display version in web app

  • The --datasetTypes flag accepts a list of DatasetTypes, allowing applications to restrict the datasets they accept.

Changed

  • Upgraded to BIDS schema version 1.0.13.

  • Raise error when JSON files are parsed and their root value is anything other than an object

"2.0.8" — 2025-08-07

Added

  • Support multi-inheritance for associated files. This will allow for multiple electrodes.tsv files, distinguished by the space- entity. (#206 #207)

2.0.7 — 2025-06-03

Changed

  • Handle TSV schema rules with missing or n/a values for additional_columns.

"2.0.6" — 2025-05-23

Added

  • Explain the issue data fields in the documentation. (#199)

Changed

  • Validator now returns exit code 16 instead of 1 for validation of a dataset with errors.

  • Rely on schema.meta.associations to load context associations instead of relying on list maintained in validator.

Fixed

  • Sidecar checks are skipped for text files that should not have sidecars. This resolves a problem in derivative datasets, where BIDS specifies a RECOMMENDED field of Description in all derivative files. (#202)

2.0.5 — 2025-03-31

A hot-fix release that adds missing entries to the 2.0.4 changelog and fixes publication to PyPI.

2.0.4 — 2025-03-31

Added

  • Validate directory names names according to schema.rules.directories entries. Use rules to identify "opaque" directories whose contents are unspecified by BIDS. (#180)
  • Report field descriptions for missing or invalid metadata. (#177)
  • Publish validator to PyPI as bids-validator-deno. (#186)

Changed

  • Update to HED Validator 4.0.0. (#173)

2.0.3 — 2025-02-24

Fixed

  • Subject detection in participants.tsv and phenotype/ directories has been restored, enabling checks that were deactivated by the missing data. (#162)
  • Skip HED tests if schema cannot be loaded. This was exhibiting as a HED_ERROR with "cannot read property null". (#160)
  • TSV_INCORRECT_VALUE_TYPE* error messages now indicate that a match failed, instead of confusingly claim success. (#165)

2.0.2 — 2025-02-10

Added

  • Enable glob-style wildcards for location field in configuration files. (#134)

Changed

  • Ensure HED schemas are loaded only once, improving efficiency. (#156)

  • Change the output of the intersects() function in the expression language to return the intersection, if non-empty. Corresponds to bids-standard/bids-specification#2044. (#150)

  • Update to BIDS schema version 1.0.1 (BIDSVersion 1.10.0) (#152)

  • Limit TSV validation to first 1000 rows by default, adding the --max-rows flag to control this behavior. (#139)

Fixed

  • TSV files may now have columns named set, clear, delete, keys, or value. These were previously masked by the methods on the data structure representing columns. (#155)

  • Improve handling of .bidsignore files in the web validator. Ignores matching directories but not the files they contained could fail to match. (#113)

  • Resolve issue with parsing headers of NIfTI files with large extensions. Fixes issue 126.

Infrastructure

  • Adopting scriv for changelog management.

2.0.1 — 2024-12-10

Fixed

  • Improve handling of .bidsignore files in the web validator. Ignores matching directories but not the files they contained could fail to match. (#113)

  • Resolve issue with parsing headers of NIfTI files with large extensions. Fixes issue 126.

Infrastructure

  • Adopting scriv for changelog management.