Skip to content

Developer Information#

Format#

  • Simply use VSCode with the "Prettier - Code formatter"

Development Environment Setup#

This repo requires Prettier to be run on all files. Run npm install to install dev dependencies and Prettier will automatically run pre-commit.

Testing#

We have created npm scripts to perform various validations, such as validating the schemas themselves and our example ocf object instances:

  • To validate schemas in the repo, run npm run validate-ocf-file-schemas
  • To validate examples in the repo, run npm run validate-example-ocf-files

If you want to use the validator for your own files, you can run the following command from the repo root:

  • node ./utils/validate.mjs validate-ocf-director -p [path/to/ocf/files] -v

Feel free to omit the -v if you don't want full console logs of the validation process

We'll be releasing more complete documentation for validating and packaging in the future. NOTE: We are still refining our toolchain and everything here is subject to change