[](https://github.com/bids-standard/bids-validator/actions/workflows/deno_tests.yml)
[](https://github.com/bids-standard/bids-validator/actions/workflows/web_build.yml)
[](https://bids-validator.readthedocs.io/en/latest/?badge=latest)
[](https://doi.org/10.5281/zenodo.3688707)
# The BIDS Validator
The BIDS Validator is a web application, command-line utility,
and Javascript/Typescript library for assessing compliance with the
[Brain Imaging Data Structure (BIDS)][BIDS] standard.
## Getting Started
In most cases,
the simplest way to use the validator is to browse to the [BIDS Validator][] web page:
The web validator runs in-browser, and does not transfer data to any remote server.
In some contexts, such as when working on a remote server,
it may be easier to use the command-line.
The BIDS Validator can be run with the [Deno][] runtime
(see [Deno - Installation][] for detailed installation instructions):
```shell
deno run -ERWN jsr:@bids/validator
```
Deno by default sandboxes applications like a web browser.
`-E`, `-R`, `-W`, and `-N` allow the validator to read environment variables,
read/write local files, and read network locations.
A pre-compiled binary is published to [PyPI][] and may be installed with:
```
pip install bids-validator-deno
bids-validator-deno --help
```
### Configuration file
The schema validator accepts a JSON configuration file that reclassifies issues as
warnings, errors or ignored.
```json
{
"ignore": [
{ "code": "JSON_KEY_RECOMMENDED", "location": "/T1w.json" }
],
"warning": [],
"error": [
{ "code": "NO_AUTHORS" }
]
}
```
The issues are partial matches of the `issues` that the validator accumulates.
Pass the `--json` flag to see the issues in detail.
### Development tools
From the repository root, use `./local-run` to run with all permissions enabled by default:
```shell
# Run from within the /bids-validator directory
cd bids-validator
# Run validator:
./local-run path/to/dataset
```
## Schema validator test suite
```shell
# Run tests:
deno test --allow-env --allow-read --allow-write src/
```
This test suite includes running expected output from bids-examples and may throw some expected failures for bids-examples datasets where either the schema or validator are misaligned with the example dataset while under development.
## Modifying and building a new schema
To modify the schema a clone of bids-standard/bids-specification will need to be made. README and schema itself live here https://github.com/bids-standard/bids-specification/tree/master/src/schema.
After changes to the schema have been made to a local copy the dereferenced single json file used by the validator will need to be built. The `bidsschematools` python package does this. It can be installed from pypi via pip or a local installation can be made. It lives in the specification repository here https://github.com/bids-standard/bids-specification/tree/master/tools/schemacode
The command to compile a dereferenced schema is `bst -v export --schema src/schema --output src/schema.json` (this assumes you are in the root of the bids-specification repo). Once compiled it can be passed to the validator via the `-s` flag, `./bids-validator-deno -s <path to schema> <path to dataset>`
## Documentation
The BIDS validator documentation is available on [Read the Docs](https://bids-validator.readthedocs.io/en/latest/).
[BIDS]: https://bids.neuroimaging.io
[BIDS Validator]: https://bids-standard.github.io/bids-validator/
[Deno]: https://deno.com/
[Deno - Installation]: https://docs.deno.com/runtime/getting_started/installation/
[PyPI]: https://pypi.org/project/bids-validator-deno/
Raw data
{
"_id": null,
"home_page": null,
"name": "bids-validator-deno",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "BIDS, BIDS validator",
"author": "bids-standard developers",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/4f/80/8ca6313ae4a077115275f748ddf5b52b86ec07ac4e1b422fb1fe53cc8065/bids_validator_deno-2.0.11.tar.gz",
"platform": null,
"description": "[](https://github.com/bids-standard/bids-validator/actions/workflows/deno_tests.yml)\n[](https://github.com/bids-standard/bids-validator/actions/workflows/web_build.yml)\n[](https://bids-validator.readthedocs.io/en/latest/?badge=latest)\n[](https://doi.org/10.5281/zenodo.3688707)\n\n# The BIDS Validator\n\nThe BIDS Validator is a web application, command-line utility,\nand Javascript/Typescript library for assessing compliance with the\n[Brain Imaging Data Structure (BIDS)][BIDS] standard.\n\n## Getting Started\n\nIn most cases,\nthe simplest way to use the validator is to browse to the [BIDS Validator][] web page:\n\n\n\n\nThe web validator runs in-browser, and does not transfer data to any remote server.\n\nIn some contexts, such as when working on a remote server,\nit may be easier to use the command-line.\nThe BIDS Validator can be run with the [Deno][] runtime\n(see [Deno - Installation][] for detailed installation instructions):\n\n```shell\ndeno run -ERWN jsr:@bids/validator\n```\n\nDeno by default sandboxes applications like a web browser.\n`-E`, `-R`, `-W`, and `-N` allow the validator to read environment variables,\nread/write local files, and read network locations.\n\nA pre-compiled binary is published to [PyPI][] and may be installed with:\n\n```\npip install bids-validator-deno\nbids-validator-deno --help\n```\n\n### Configuration file\n\nThe schema validator accepts a JSON configuration file that reclassifies issues as\nwarnings, errors or ignored.\n\n```json\n{\n \"ignore\": [\n { \"code\": \"JSON_KEY_RECOMMENDED\", \"location\": \"/T1w.json\" }\n ],\n \"warning\": [],\n \"error\": [\n { \"code\": \"NO_AUTHORS\" }\n ]\n}\n```\n\nThe issues are partial matches of the `issues` that the validator accumulates.\nPass the `--json` flag to see the issues in detail.\n\n### Development tools\n\nFrom the repository root, use `./local-run` to run with all permissions enabled by default:\n\n```shell\n# Run from within the /bids-validator directory\ncd bids-validator\n# Run validator:\n./local-run path/to/dataset\n```\n\n## Schema validator test suite\n\n```shell\n# Run tests:\ndeno test --allow-env --allow-read --allow-write src/\n```\n\nThis test suite includes running expected output from bids-examples and may throw some expected failures for bids-examples datasets where either the schema or validator are misaligned with the example dataset while under development.\n\n## Modifying and building a new schema\n\nTo modify the schema a clone of bids-standard/bids-specification will need to be made. README and schema itself live here https://github.com/bids-standard/bids-specification/tree/master/src/schema.\n\nAfter changes to the schema have been made to a local copy the dereferenced single json file used by the validator will need to be built. The `bidsschematools` python package does this. It can be installed from pypi via pip or a local installation can be made. It lives in the specification repository here https://github.com/bids-standard/bids-specification/tree/master/tools/schemacode\n\nThe command to compile a dereferenced schema is `bst -v export --schema src/schema --output src/schema.json` (this assumes you are in the root of the bids-specification repo). Once compiled it can be passed to the validator via the `-s` flag, `./bids-validator-deno -s <path to schema> <path to dataset>`\n\n\n## Documentation\n\nThe BIDS validator documentation is available on [Read the Docs](https://bids-validator.readthedocs.io/en/latest/).\n\n[BIDS]: https://bids.neuroimaging.io\n[BIDS Validator]: https://bids-standard.github.io/bids-validator/\n[Deno]: https://deno.com/\n[Deno - Installation]: https://docs.deno.com/runtime/getting_started/installation/\n[PyPI]: https://pypi.org/project/bids-validator-deno/\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Typescript implementation of the BIDS validator",
"version": "2.0.11",
"project_urls": {
"Documentation": "https://bids-validator.readthedocs.io/",
"Issues": "https://github.com/bids-standard/bids-validator/issues",
"Source code": "https://github.com/bids-standard/bids-validator"
},
"split_keywords": [
"bids",
" bids validator"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "a08216372c32db7b01bd3a23c94be5d8011f9ff711b66404a88b3af4727ddc68",
"md5": "32106794983c973919d0bb44e5744fc6",
"sha256": "cc71bb1cd13d8cd706f362bd3c45b42adabc29ed5246d7382be925a8c135f2b5"
},
"downloads": -1,
"filename": "bids_validator_deno-2.0.11-py2.py3-none-macosx_10_12_x86_64.whl",
"has_sig": false,
"md5_digest": "32106794983c973919d0bb44e5744fc6",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 41927175,
"upload_time": "2025-08-29T16:32:06",
"upload_time_iso_8601": "2025-08-29T16:32:06.818644Z",
"url": "https://files.pythonhosted.org/packages/a0/82/16372c32db7b01bd3a23c94be5d8011f9ff711b66404a88b3af4727ddc68/bids_validator_deno-2.0.11-py2.py3-none-macosx_10_12_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "7b2166f4ecadf9d7d9b73debed57d190eab03599ddcc11c52abf742dda646334",
"md5": "5a95f8d1d1549f35b182e22fde358985",
"sha256": "7cd91f6013e8f765454ae5b6639c08815aed9dd1478a3aaa2dfc82462eae8852"
},
"downloads": -1,
"filename": "bids_validator_deno-2.0.11-py2.py3-none-macosx_11_0_arm64.whl",
"has_sig": false,
"md5_digest": "5a95f8d1d1549f35b182e22fde358985",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 41152637,
"upload_time": "2025-08-29T16:32:10",
"upload_time_iso_8601": "2025-08-29T16:32:10.989497Z",
"url": "https://files.pythonhosted.org/packages/7b/21/66f4ecadf9d7d9b73debed57d190eab03599ddcc11c52abf742dda646334/bids_validator_deno-2.0.11-py2.py3-none-macosx_11_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "cf4516e7194ca74b3892daf23fe8f8540c92da7421a97c98249233831c9a47f6",
"md5": "f6cba34c3afe0b2b4e5f73ee7bb36980",
"sha256": "61815122a8b57b487447082cd088efc0b1283462dd0d8f349e5c7044b02fadbb"
},
"downloads": -1,
"filename": "bids_validator_deno-2.0.11-py2.py3-none-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl",
"has_sig": false,
"md5_digest": "f6cba34c3afe0b2b4e5f73ee7bb36980",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 42756720,
"upload_time": "2025-08-29T16:32:15",
"upload_time_iso_8601": "2025-08-29T16:32:15.014141Z",
"url": "https://files.pythonhosted.org/packages/cf/45/16e7194ca74b3892daf23fe8f8540c92da7421a97c98249233831c9a47f6/bids_validator_deno-2.0.11-py2.py3-none-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "38f322ee61829369336d337d6e60dd7a874bfd683f03912191b18299ac882a2b",
"md5": "07a7f5e25d4d35af106de2769fb1041c",
"sha256": "9ba1ccd30e396d1eb4855ec7b60e572b69d7afbc2ad10ead321242fcdd680fd7"
},
"downloads": -1,
"filename": "bids_validator_deno-2.0.11-py2.py3-none-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl",
"has_sig": false,
"md5_digest": "07a7f5e25d4d35af106de2769fb1041c",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 43898307,
"upload_time": "2025-08-29T16:32:19",
"upload_time_iso_8601": "2025-08-29T16:32:19.175117Z",
"url": "https://files.pythonhosted.org/packages/38/f3/22ee61829369336d337d6e60dd7a874bfd683f03912191b18299ac882a2b/bids_validator_deno-2.0.11-py2.py3-none-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "35c05318afd79b9361cf8dc4d4bcf8e347d891ee1649f52e0b41281e4251796c",
"md5": "c9902cd4773daf1761dcdb290fd1c3d1",
"sha256": "d041bc315b7754add02a556c96c9b6a9b4e5442ff30dd85c6742ff66d4aa69da"
},
"downloads": -1,
"filename": "bids_validator_deno-2.0.11-py2.py3-none-win_amd64.whl",
"has_sig": false,
"md5_digest": "c9902cd4773daf1761dcdb290fd1c3d1",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 43521110,
"upload_time": "2025-08-29T16:32:22",
"upload_time_iso_8601": "2025-08-29T16:32:22.767759Z",
"url": "https://files.pythonhosted.org/packages/35/c0/5318afd79b9361cf8dc4d4bcf8e347d891ee1649f52e0b41281e4251796c/bids_validator_deno-2.0.11-py2.py3-none-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "4f808ca6313ae4a077115275f748ddf5b52b86ec07ac4e1b422fb1fe53cc8065",
"md5": "6c96a6d2ac3d023db53451d4d90d0f83",
"sha256": "c6724949dae74f82964d0db4af6b3fe933a22717f6f32139ccd991acb6826e5b"
},
"downloads": -1,
"filename": "bids_validator_deno-2.0.11.tar.gz",
"has_sig": false,
"md5_digest": "6c96a6d2ac3d023db53451d4d90d0f83",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 67431,
"upload_time": "2025-08-29T16:32:25",
"upload_time_iso_8601": "2025-08-29T16:32:25.371513Z",
"url": "https://files.pythonhosted.org/packages/4f/80/8ca6313ae4a077115275f748ddf5b52b86ec07ac4e1b422fb1fe53cc8065/bids_validator_deno-2.0.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-29 16:32:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bids-standard",
"github_project": "bids-validator",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "bids-validator-deno"
}
JSON
