Skip to content

Cookiecutter: JSON Validation #352

@natalialuzuriaga

Description

@natalialuzuriaga

Is your feature request related to a problem? Please describe.
Currently, after the user runs the code.json cookiecutter CLI, we do not validate the code.json generated against the CMS code.json schema.

Describe the solution you'd like
We would like to add JSON validation to ensure data quality! We would like to embed this into the CLI itself - open to usage of any tools/python libraries. This would live in the post-gen-project.py script

Describe alternatives you've considered

  • Users can copy and paste their code.json to a JSON validator like this https://jsonlint.com/ but this only checks if the JSON is valid. We want to specifically check this against our CMS code.json schema.
  • Users can run a JSON validation CLI tools separately after the code.json is produced but this is extra overhead. It would be nice if we can embed this into the CLI itself.

Additional context
gov-codejson uses jsonschema for JSON validation. Review the tests here: https://github.com/DSACMS/gov-codejson/tree/main/tests

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions