{"id":13676310,"url":"https://bids-standard.github.io/bids-validator/","last_synced_at":"2025-04-29T06:31:43.130Z","repository":{"id":261112315,"uuid":"878132326","full_name":"bids-standard/bids-validator","owner":"bids-standard","description":"Validator for the Brain Imaging Data Structure","archived":false,"fork":false,"pushed_at":"2025-04-17T19:13:39.000Z","size":24405,"stargazers_count":11,"open_issues_count":86,"forks_count":14,"subscribers_count":10,"default_branch":"main","last_synced_at":"2025-04-19T22:36:57.851Z","etag":null,"topics":["bids","data-standards","neuroimaging-data","validation"],"latest_commit_sha":null,"homepage":"https://bids-validator.readthedocs.io/en/stable/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bids-standard.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-10-24T20:48:31.000Z","updated_at":"2025-04-17T19:13:07.000Z","dependencies_parsed_at":"2025-01-12T21:35:17.422Z","dependency_job_id":"b6ac92f0-3ec2-4e5a-b2ed-f67f66ea8763","html_url":"https://github.com/bids-standard/bids-validator","commit_stats":{"total_commits":4086,"total_committers":75,"mean_commits":54.48,"dds":0.7961331375428291,"last_synced_commit":"da2c6e6ace106708c71124a76f6943679cdab80a"},"previous_names":["bids-standard/bids-validator-temp","bids-standard/bids-validator"],"tags_count":122,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bids-standard%2Fbids-validator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bids-standard%2Fbids-validator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bids-standard%2Fbids-validator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bids-standard%2Fbids-validator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bids-standard","download_url":"https://codeload.github.com/bids-standard/bids-validator/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251450656,"owners_count":21591407,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bids","data-standards","neuroimaging-data","validation"],"created_at":"2024-08-02T13:00:22.458Z","updated_at":"2025-04-29T06:31:38.111Z","avatar_url":"https://github.com/bids-standard.png","language":"TypeScript","funding_links":[],"categories":["Validation"],"sub_categories":["others"],"readme":"[![Deno build](https://github.com/bids-standard/bids-validator/actions/workflows/deno_tests.yml/badge.svg)](https://github.com/bids-standard/bids-validator/actions/workflows/deno_tests.yml)\n[![Web validator](https://github.com/bids-standard/bids-validator/actions/workflows/web_build.yml/badge.svg)](https://github.com/bids-standard/bids-validator/actions/workflows/web_build.yml)\n[![Documentation Status](https://readthedocs.org/projects/bids-validator/badge/?version=latest)](https://bids-validator.readthedocs.io/en/latest/?badge=latest)\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3688707.svg)](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] 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![The web interface to the BIDS Validator with the \"Select Dataset Files\" button highlighted.\n(Dark theme)](docs/_static/web_entrypoint_dark.png#gh-dark-mode-only)\n![The web interface to the BIDS Validator with the \"Select Dataset Files\" button highlighted.\n(Light theme)](docs/_static/web_entrypoint_light.png#gh-light-mode-only)\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 -ERN jsr:@bids/validator\n```\n\nDeno by default sandboxes applications like a web browser.\n`-E`, `-R` and `-N` allow the validator to read environment variables,\nlocal files, and network locations.\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 --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 \u003cpath to schema\u003e \u003cpath to dataset\u003e`\n\n\n## Documentation\n\nThe BIDS validator documentation is available on [Read the Docs](https://bids-validator.readthedocs.io/en/latest/).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/bids-standard.github.io%2Fbids-validator%2F","html_url":"https://awesome.ecosyste.ms/projects/bids-standard.github.io%2Fbids-validator%2F","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/bids-standard.github.io%2Fbids-validator%2F/lists"}