diff --git a/.codeclimate.yml b/.codeclimate.yml deleted file mode 100644 index 0b46e4f0c..000000000 --- a/.codeclimate.yml +++ /dev/null @@ -1,17 +0,0 @@ ---- -version: '2' -checks: - similar-code: - config: - threshold: 50 - identical-code: - config: - threshold: 50 -plugins: - duplication: - enabled: true - config: - count_threshold: 3 -exclude_patterns: - - bids-validator/versioneer.py - - bids-validator/bids_validator/_version.py diff --git a/bids-validator/README.md b/bids-validator/README.md index 3ae513938..e47d5b914 100644 --- a/bids-validator/README.md +++ b/bids-validator/README.md @@ -1,12 +1,27 @@ -[![Node Tests](https://github.com/bids-standard/bids-validator/actions/workflows/node_tests.yml/badge.svg)](https://github.com/bids-standard/bids-validator/actions/workflows/node_tests.yml) -[![bids-examples tests](https://github.com/bids-standard/bids-validator/actions/workflows/test-bids-examples.yml/badge.svg)](https://github.com/bids-standard/bids-validator/actions/workflows/test-bids-examples.yml) -[![CircleCI](https://circleci.com/gh/bids-standard/bids-validator.svg?style=shield&circle-token=:circle-token)](https://circleci.com/gh/bids-standard/bids-validator) -[![Codecov](https://codecov.io/gh/bids-standard/bids-validator/branch/master/graph/badge.svg)](https://codecov.io/gh/bids-standard/bids-validator) +[![Node Tests](https://github.com/bids-standard/legacy-validator/actions/workflows/node_tests.yml/badge.svg)](https://github.com/bids-standard/legacy-validator/actions/workflows/node_tests.yml) +[![test-bids-examples](https://github.com/bids-standard/legacy-validator/actions/workflows/test-bids-examples.yml/badge.svg)](https://github.com/bids-standard/legacy-validator/actions/workflows/test-bids-examples.yml) +[![CircleCI](https://dl.circleci.com/status-badge/img/gh/bids-standard/legacy-validator/tree/master.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/bids-standard/legacy-validator/tree/master) +[![codecov](https://codecov.io/gh/bids-standard/legacy-validator/graph/badge.svg?token=Cfx4OcfK5P)](https://codecov.io/gh/bids-standard/legacy-validator) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3688707.svg)](https://doi.org/10.5281/zenodo.3688707) -# BIDS-Validator +--- -- [BIDS-Validator](#bids-validator) +# Warning: legacy validator + +This is the repository of the **legacy BIDS validator**: +this version of the validator is not updated anymore. + +If you are looking for the maintained version BIDS validator, +please follow the links below: + +- repository: https://github.com/bids-standard/bids-validator +- website: https://bids-standard.github.io/bids-validator/ + +--- + +# legacy-validator + +- [legacy-Validator](#legacy-validator) - [Quickstart](#quickstart) - [Support](#support) - [Maintainers and Contributors](#maintainers-and-contributors) @@ -30,10 +45,10 @@ 1. Open [Google Chrome](https://www.google.com/chrome/) or [Mozilla Firefox](https://mozilla.org/firefox) (currently the only supported browsers) - 1. Go to https://bids-standard.github.io/bids-validator/ and select a folder + 1. Go to https://bids-standard.github.io/legacy-validator/ and select a folder with your BIDS dataset. If the validator seems to be working longer than couple of minutes please open [developer tools ](https://developer.chrome.com/devtools) - and report the error at [https://github.com/bids-standard/bids-validator/issues](https://github.com/bids-standard/bids-validator/issues). + and report the error at [https://github.com/bids-standard/legacy-validator/issues](https://github.com/bids-standard/legacy-validator/issues). 1. Command line version: 1. Install [Node.js](https://nodejs.org) (at least version 18.0.0) 1. Update `npm` to be at least version 7 (`npm install --global npm@^7`) @@ -51,7 +66,7 @@ target support for the latest long term stable (LTS) release of Node.js and the latest version of Chrome. Please report any issues you experience while using these support targets via -the [GitHub issue tracker](https://github.com/bids-standard/bids-validator/issues). +the [GitHub issue tracker](https://github.com/bids-standard/legacy-validator/issues). If you experience issues outside of these supported environments and believe we should extend our targeted support feel free to open a new issue describing the issue, your support target and why you require extended support and we will @@ -78,61 +93,61 @@ Please also see [Acknowledgments](#acknowledgments). - - - + + + - - - + + + - - + + - - - + + + - - - - - - - + + + + + + + - - - - - - - + + + + + + + - - - - - - - + + + + + + + - - - - - - - + + + + + + + - +

Adam Li

πŸ’» ⚠️ πŸ““ πŸ›

Adam Thomas

πŸ“–

Alexander Jones

πŸ’» ⚠️ πŸ€”

Adam Li

πŸ’» ⚠️ πŸ““ πŸ›

Adam Thomas

πŸ“–

Alexander Jones

πŸ’» ⚠️ πŸ€”

Ben Beasley

πŸ“¦

Chris Gorgolewski

πŸ› πŸ’» πŸ”£ πŸ“– πŸ’‘ πŸ€” πŸš‡ 🚧 πŸ§‘β€πŸ« πŸ’¬ πŸ‘€ ⚠️ βœ… πŸ“’ πŸ““

Chris Holdgraf

πŸ’»

Chris Markiewicz

πŸ’» ⚠️ πŸ€” πŸ› πŸ’¬ πŸ”§ 🚧

Chris Gorgolewski

πŸ› πŸ’» πŸ”£ πŸ“– πŸ’‘ πŸ€” πŸš‡ 🚧 πŸ§‘β€πŸ« πŸ’¬ πŸ‘€ ⚠️ βœ… πŸ“’ πŸ““

Chris Holdgraf

πŸ’»

Chris Markiewicz

πŸ’» ⚠️ πŸ€” πŸ› πŸ’¬ πŸ”§ 🚧

David Nishikawa

πŸ’» ⚠️

Dimitri Papadopoulos Orfanos

πŸ’»

David Nishikawa

πŸ’» ⚠️

Dimitri Papadopoulos Orfanos

πŸ’»

Duncan Macleod

πŸš‡

Franklin Feingold

πŸ“–

Gregory noack

πŸ’» ⚠️

Horea Christian

πŸ’»

Franklin Feingold

πŸ“–

Gregory noack

πŸ’» ⚠️

Horea Christian

πŸ’»

Jakub Kaczmarzyk

πŸš‡

Joke Durnez

πŸ’»

Mainak Jas

πŸ’» ⚠️ πŸ€” πŸ‘€ πŸ““

Marco Castellaro

πŸ’» ⚠️

Max

πŸ’» πŸ›

Michael Hanke

πŸ“–

Mikael Naveau

πŸ’»

Nell Hardcastle

πŸ’» πŸ€” πŸš‡ πŸ’¬ πŸ‘€

Joke Durnez

πŸ’»

Mainak Jas

πŸ’» ⚠️ πŸ€” πŸ‘€ πŸ““

Marco Castellaro

πŸ’» ⚠️

Max

πŸ’» πŸ›

Michael Hanke

πŸ“–

Mikael Naveau

πŸ’»

Nell Hardcastle

πŸ’» πŸ€” πŸš‡ πŸ’¬ πŸ‘€

Nicolas Traut

πŸ’»

Parul Sethi

πŸ’» ⚠️

Patricia Clement

πŸ’»

Remi Gau

πŸ’» πŸ“– πŸ““

Richard HΓΆchenberger

πŸ’» πŸ““ ⚠️ πŸ›

Robert Oostenveld

πŸ’» πŸ€” πŸ› ⚠️

Rohan Goyal

πŸ’»

Nicolas Traut

πŸ’»

Parul Sethi

πŸ’» ⚠️

Patricia Clement

πŸ’»

Remi Gau

πŸ’» πŸ“– πŸ““

Richard HΓΆchenberger

πŸ’» πŸ““ ⚠️ πŸ›

Robert Oostenveld

πŸ’» πŸ€” πŸ› ⚠️

Rohan Goyal

πŸ’»

Ross Blair

🚧 πŸ€” πŸ’» πŸ› πŸš‡ πŸ“† πŸ’¬ πŸ‘€ πŸ”§ ⚠️

Russ Poldrack

πŸ’» πŸ’΅ πŸ”

Soichi Hayashi

πŸ›

Stefan Appelhoff

πŸ› πŸ’» πŸ”£ πŸ“– πŸ’‘ πŸ€” πŸš‡ 🚧 πŸ§‘β€πŸ« πŸ’¬ πŸ‘€ ⚠️ βœ… πŸ“’ πŸ““

Suyash

πŸ’»

Taylor Salo

πŸ’»

Teal Hobson-Lowther

πŸ’» ⚠️

Ross Blair

🚧 πŸ€” πŸ’» πŸ› πŸš‡ πŸ“† πŸ’¬ πŸ‘€ πŸ”§ ⚠️

Russ Poldrack

πŸ’» πŸ’΅ πŸ”

Soichi Hayashi

πŸ›

Stefan Appelhoff

πŸ› πŸ’» πŸ”£ πŸ“– πŸ’‘ πŸ€” πŸš‡ 🚧 πŸ§‘β€πŸ« πŸ’¬ πŸ‘€ ⚠️ βœ… πŸ“’ πŸ““

Suyash

πŸ’»

Taylor Salo

πŸ’»

Teal Hobson-Lowther

πŸ’» ⚠️

Travis Riddle

πŸ›

VisLab

πŸ€” πŸ’»

Wazeer Zulfikar

πŸ“–

Yaroslav Halchenko

πŸ€” πŸ’» πŸ“– πŸ““

constellates

πŸ’» ⚠️

dewarrn1

πŸ’»

dkp

πŸ’»

Travis Riddle

πŸ›

VisLab

πŸ€” πŸ’»

Wazeer Zulfikar

πŸ“–

Yaroslav Halchenko

πŸ€” πŸ’» πŸ“– πŸ““

constellates

πŸ’» ⚠️

dewarrn1

πŸ’»

dkp

πŸ’»

goldmund

πŸ’» ⚠️

goldmund

πŸ’» ⚠️
@@ -216,7 +231,7 @@ sub-dir to be ignored. `ignore`, `warn`, and `error` take lists of issue codes or issue keys and change the severity of those issues so they are either ignored or reported as warnings or errors. You can find a list of all available issues at -[utils/issues/list](https://github.com/bids-standard/bids-validator/blob/master/bids-validator/utils/issues/list.js). +[utils/issues/list](https://github.com/bids-standard/legacy-validator/blob/master/bids-validator/utils/issues/list.js). Some issues may be ignored by default, but can be elevated to warnings or errors. These provide a way to check for common things that are more specific than BIDS @@ -335,6 +350,9 @@ see available options. ## Docker image + +**:rotating_light: at this time (November 2024) docker images of the bids-validator still use the legacy validator. But this should soon change.** + [![Docker Image Version (latest by date)](https://img.shields.io/docker/v/bids/validator?label=docker)](https://hub.docker.com/r/bids/validator) To use bids validator with [docker](https://www.docker.com/), you simply need to