Skip to content
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.

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

validator should be able to output machine readable results #1179

Open
t-b opened this issue Feb 6, 2020 · 6 comments
Open

validator should be able to output machine readable results #1179

t-b opened this issue Feb 6, 2020 · 6 comments
Labels
category: enhancement improvements of code or code behavior topic: validator issues related to validation of files

Comments

@t-b
Copy link
Collaborator

t-b commented Feb 6, 2020

Could be JSON using --json in a format like

{
    "exitcode" : 0,
    "issues" : [ { "description": "", "location":"", "severity": 10}, ]
}
@t-b t-b added category: enhancement improvements of code or code behavior topic: validator issues related to validation of files labels Feb 6, 2020
@bendichter
Copy link
Contributor

Thanks @t-b , this sounds like a useful feature!

@anhknguyen96
Copy link

Hi, I would appreciate it if this feature is added. @pgleeson and I are working on a GSoC project and one of the goals is to test NWB files' compatibility with NWBExplorer, thus having the validator's logs will be useful for debugging purposes.

@bendichter
Copy link
Contributor

Check out NWB inspector. It calls validation and has this json output feature

@anhknguyen96
Copy link

NWB inspector calls validation via this method?

The NWB inspector documentation/README file says "This inspector is meant as a companion to the pynwb validator, which checks for strict schema compliance. In contrast, this tool attempts to apply some common sense to find components of the file that are technically compliant, but probably incorrect, or suboptimal, or deviate from best practices". If I understand correctly, users are recommended to use both pynwb validator and NWB inspector, as they serve different purposes?

@bendichter
Copy link
Contributor

nwb inspector has its own check and calls the validator and returns any errors, so you don't need to call both.

@anhknguyen96
Copy link

great, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category: enhancement improvements of code or code behavior topic: validator issues related to validation of files
Projects
None yet
Development

No branches or pull requests

3 participants