Skip to content

Releases: bids-standard/bids-validator

2.2.0

14 Oct 17:40

Choose a tag to compare

What's Changed

  • fix: Weakly reference parent FileTrees, upgrade hed-validator by @effigies in #279
  • feat: add --format option for output formatting by @djken2009 in #271
  • rf: Make BIDSFile generic wrapper, with FileOpener providing the file type handling by @effigies in #280
  • feat: Load annexed data from public S3 special remotes by @effigies in #281

Full Changelog: 2.1.1...2.2.0

2.1.1

29 Sep 16:29
c331a16

Choose a tag to compare

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.

Pull requests merged

  • feat: Allow initial and index columns to be non-required by @effigies in #243
  • fix: Check index columns by @effigies in #255
  • chore: Use deno 2.4 in CI by @effigies in #257
  • type: Adapt to changes in ArrayBuffers in Typescript 5.9.2 by @effigies in #258
  • chore: Bump dependency specs by @effigies in #256
  • feat: Add file access functions that translate errors into issues by @effigies in #259
  • feat: Cache JSON file loads by @effigies in #262
  • fix: properly encode JSON data in data URL for download link by @djken2009 in #263
  • feat: add unique() function for expressions by @drammock in #261
  • throw utf8 encoding error for tsv files, add non utf-8 test data and test. by @rwblair in #264
  • Throw an error, do not just log an error, if provided schema is not legit by @yarikoptic in #270
  • fix: Include target entities in exact match check by @effigies in #273
  • feat: Load datatype and modality when building file context by @effigies in #272
  • feat: Add issue message formatting by @effigies in #267
  • Add per context check to see if any files in its directory have the same name with different case by @rwblair in #265
  • rf: Validate additional columns when defined by @effigies in #254
  • rel: 2.1.1 by @effigies in #274

New Contributors

Full Changelog: 2.1.0...2.1.1

2.1.0

03 Sep 20:24

Choose a tag to compare

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)

Pull requests merged

  • chore(dev): Bump @bids/schema v1.1.0-dev by @effigies in #129
  • chore: Bump @bids/schema v1.1.0-dev.5 by @effigies in #153
  • feat: Implement warning for sidecar overrides by @effigies in #214
  • chore: Upgrade schema for dev validator by @effigies in #241
  • chore(ci): Verify only first tag by @effigies in #246
  • chore: Bump @bids/schema to 1.1.0 by @effigies in #249
  • feat: Enable type checking on tsv.gz files by @effigies in #240
  • feat: Split out deprecation warning for age=="89+" by @effigies in #242
  • feat: Extract image orientation from NIfTI header by @effigies in #112
  • feat: Always error on incorrect TSV types by @effigies in #247
  • fix: Do not descend into pseudo-files or opaque directories when checking for unused files by @rwblair in #231

Full Changelog: 2.0.11...2.1.0

2.0.11

29 Aug 16:31

Choose a tag to compare

Fixed

  • Docker build workflow should now run correctly on releases.

What's Changed

  • chore(ci): Fix actions/checkout invocation for tags by @effigies in #245

Full Changelog: 2.0.10...2.0.11

2.0.10

29 Aug 16:18

Choose a tag to compare

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

Pull requests merged

  • fix: Use string[] options for datasetTypes and blacklistModalities by @nellh in #238
  • chore: Reenable DockerHub pushes by @effigies in #237
  • doc: Add FAQ by @effigies in #233
  • rf: Throw more issue-like objects in loading functions by @effigies in #236
  • feat: Unify schema and sidecar-defined column validation by @effigies in #234
  • fix: Do not crash on missing datasetTypes option by @effigies in #244

Full Changelog: 2.0.9...2.0.10

2.0.9

26 Aug 17:07

Choose a tag to compare

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

PRs

  • chore: Bump schema version by @effigies in #223
  • chore(deps): Bump hed-validator dependency to 4.1.4 by @happy5214 in #220
  • chore: Update BIDS schema, relax to ~version by @effigies in #230
  • Raise error when json files are parsed and their root value is an array instead of object. by @rwblair in #225
  • feat: Display version in web app by @effigies in #208
  • fix: Revert to HED validator 4.0 by @effigies in #232
  • feat: Add DatasetType passlist to allow applications to limit support by @effigies in #235

Full Changelog: 2.0.8...2.0.9

2.0.8

08 Aug 17:39

Choose a tag to compare

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

03 Jun 13:03

Choose a tag to compare

Changed

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

Full Changelog: 2.0.6...2.0.7

2.0.6

27 May 17:01

Choose a tag to compare

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])

Full Changelog: 2.0.5...2.0.6

2.0.5

31 Mar 15:39

Choose a tag to compare

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

Full Changelog: 2.0.4...2.0.5