Skip to content

fix: use .bids-validator-config.json by default if available. #329

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rwblair wants to merge 9 commits into
base: main
Choose a base branch
from
Open

fix: use .bids-validator-config.json by default if available. #329

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
13d9c33
Have cli and web validator attempt to load '.bids-validator-config.js…
rwblair Dec 18, 2025
be5b560
add changelog file
rwblair Dec 18, 2025
314c5cd
Merge branch 'main' of github.com:bids-standard/bids-validator into f…
rwblair Feb 11, 2026
0c4797f
Update src/main.ts
rwblair Feb 11, 2026
215c7b5
Update web/src/App.tsx
rwblair Feb 11, 2026
5076341
Merge branch 'main' into fix/use_default_config_file
rwblair Feb 11, 2026
a245c3d
Merge branch 'fix/use_default_config_file' of github.com:bids-standar…
rwblair Feb 11, 2026
cdc611c
log error instead of crashing on invalid config file.
rwblair Feb 11, 2026
53e9074
Remove unused variable, add period to config error message
rwblair Feb 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions changelog.d/20251218_163750_rosswilsonblair_use_default_config_file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
<!--
A new scriv changelog fragment.

Uncomment the section that is right (remove the HTML comment wrapper).
For top level release notes, leave all the headers commented out.
-->

<!--
### Added

- A bullet item for the Added category.

-->
<!--
### Changed

- A bullet item for the Changed category.

-->
### Fixed

- CLI and web validator now default to loading '.bids-validator-config.json'. Validator only attempts this if no other config file was passed in.

<!--
### Deprecated

- A bullet item for the Deprecated category.

-->
<!--
### Removed

- A bullet item for the Removed category.

-->
<!--
### Security

- A bullet item for the Security category.

-->
<!--
### Infrastructure

- A bullet item for the Infrastructure category.

-->
19 changes: 17 additions & 2 deletions src/main.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ import * as colors from '@std/fmt/colors'
import { readFileTree } from './files/deno.ts'
import { fileListToTree } from './files/browser.ts'
import { FileIgnoreRules } from './files/ignore.ts'
import { resolve } from '@std/path'
import { join, resolve } from '@std/path'
import { exists } from "jsr:@std/fs/exists";
import { validate } from './validators/bids.ts'
import { consoleFormat, resultToJSONStr } from './utils/output.ts'
import { setupLogging } from './utils/logger.ts'
Expand All @@ -28,7 +29,21 @@ export async function main(): Promise<ValidationResult> {
: undefined
const tree = await readFileTree(absolutePath, prune, options.preferredRemote)

const config = options.config ? JSON.parse(Deno.readTextFileSync(options.config)) as Config : {}
let config = {}
if (options.config) {
config = JSON.parse(Deno.readTextFileSync(options.config))
} else {
const defaultConfig = join(absolutePath, '.bids-validator-config.json')
try {
await Deno.lstat(defaultConfig)
config = JSON.parse(Deno.readTextFileSync(defaultConfig))
options.config = defaultConfig
} catch {
if (!(err instanceof Deno.errors.NotFound)) {
throw err;
}
}

@effigies effigies Jan 16, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What if we did what we do for .bidsignore and pull it out of the tree? We don't need a filesystem hit to check if it's there.

Suggested change
const defaultConfig = join(absolutePath, '.bids-validator-config.json')
try {
await Deno.lstat(defaultConfig)
config = JSON.parse(Deno.readTextFileSync(defaultConfig))
options.config = defaultConfig
} catch {
if (!(err instanceof Deno.errors.NotFound)) {
throw err;
}
}
const configFile = tree.get('.bids-validator-config.json') as BIDSFile
if (configFile) {
config = await configFile.text().then((text) => JSON.parse(text))
}

We could also use our JSON loader and create an issue. Probably better not to crash...

@rwblair rwblair Feb 11, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using loadJSON for the default config and std functions for the cli specified config cause the error objects produced to be different.

The crash from either error is uninformative as currently implemented. Injecting these caught errors as issues into the dataset issues feels wrong for two reasons. It isn't an issue with validity with respect to the specification and its likely to get lost the sea of errors/issues. Treating them as issues instead of console output is good for people who consume the json validation results. Should we be outputting logger messages in the json output object?

We could treat them as a separate class of issue that gets special treatment with their own section in validation results. For standard output these could be printed immediately before or after the summary output to highlight them since we are changing the behavior of the validation from what was likely intended by the user as opposed to reporting a normal validation issue. The failure to load a user specified schema would fall under this new class of issue. Currently we log some output saying that we are falling back to the default schema but this output is at the beginning of validation and is hard to notice, its something that I've been bit by before.

@rwblair rwblair Feb 11, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cdc611c Wraps the both json loads in a try catch that calls logger.error, this is at least closer to the behavior of the web validator as is. I'm still open to making them issues.

Example output with config file specified:

ERROR 
      Failed to load /home/rwblair/projects/bids/bids-examples/ds001/.bids-validator-config.json using empty configuration object.
      SyntaxError: Unexpected end of JSON input
    at JSON.parse (<anonymous>)
    at main (file:///home/rwblair/projects/bids/bids-validator/src/main.ts:37:21)
    at eventLoopTick (ext:core/01_core.js:179:7)
    at async file:///home/rwblair/projects/bids/bids-validator/src/bids-validator.ts:4:16

For an empty implicit config file:

      Failed to load .bids-validator-config.json using empty configuration object.
      {"code":"JSON_INVALID"}

@rwblair rwblair Feb 11, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here's an implementation that doesn't use stat, has both types of config files produce errors of the same type, and catches the error:

  let config = {}
  const configFile = options.config ?? join(absolutePath, '.bids-validator-config.json')
  config = await Deno.readTextFile(configFile).then((configText) => JSON.parse(configText)).catch(
    (error) => {
      if (options.config || !(error instanceof Deno.errors.NotFound)) {
        logger.error(`
          Failed to load ${configFile son'}. Using empty configuration object.
          ${error.stack || JSON.stringify(error)}
        `)
      }
    },
  )

}

// Run the schema based validator
const schemaResult = await validate(tree, options, config)
Expand Down
12 changes: 10 additions & 2 deletions web/src/App.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import React, { useState } from "react"
import "./App.css"
import { directoryOpen } from "https://esm.sh/browser-fs-access@0.35.0"
import { directoryOpen, fileOpen } from "https://esm.sh/browser-fs-access@0.35.0"
import confetti from 'https://cdn.jsdelivr.net/npm/canvas-confetti@1.9.3/dist/confetti.module.mjs';
import { fileListToTree, validate, getVersion } from "../dist/validator/main.js"
import type { ValidationResult } from "../../src/types/validation-result.ts"
Expand Down Expand Up @@ -50,11 +50,19 @@ function App() {
const [validation, setValidation] = useState<ValidationResult>()

async function validateDir() {

const dirHandle = await directoryOpen({
recursive: true,
})
let config = {}
const configFile = dirHandle.find(file => file.name ==='.bids-validator-config.json')
if (configFile) {
config = configFile.text().then(text => JSON.parse(text)).catch((err) => {
alert(`Failed to load ".bids-validator-config.json". \n\nUsing empty configuration object:\n\n${err}`)
})
}
const fileTree = await fileListToTree(dirHandle)
Comment thread
rwblair marked this conversation as resolved.
Outdated
setValidation(await validate(fileTree, {}))
setValidation(await validate(fileTree, config))
}

const [version, setVersion] = useState<string>()
Expand Down
Loading