@openeo/processes-lint
v0.1.6
Published
Validates and lints openEO processes.
Downloads
15
Readme
Linter for openEO process specifications
- Install node and npm - should run with any recent version
- Place a config file into your working directory that looks like the
testConfig.json
. The options work as follows:folder
: Path to a folder with non-experimental process specifications in .json files.proposalsFolder
: Path to a folder with experimantal process specifications in .json files (optional)anyOfRequired
: Processes where any of the parameters is required (deprecated)ignoedWords
: A list of words the spell checker should ignore. Can also be a path to a file with a word on each line.subtypeSchemas
: Path or URL to a file that includes the subtype schemas, defaults tohttps://processes.openeo.org/meta/subtype-schemas.json
checkSubtypeSchemas
: Enable or disable running checks against the subtype schemas. Defaults tofalse
(disabled).forbidDeprecatedTypes
: Set totrue
to disallow deprecated subtypes such asraster-cube
andvector-cube
. Defaults tofalse
(disabled).checkProcessLinks
: Set totrue
to validate whether the links to processes in descriptions are valid (i.e. the files exist). Defaults tofalse
(disabled).verbose
: Verbose output for tests. Defaults tofalse
(disabled).
- Run
npx @openeo/processes-lint testConfig.json