https://github.com/open-eo/openeo-processes-lint

Validate and lint openEO processes definitions
https://github.com/open-eo/openeo-processes-lint

Last synced: about 1 year ago
JSON representation

Validate and lint openEO processes definitions

• Host: GitHub
• URL: https://github.com/open-eo/openeo-processes-lint
• Owner: Open-EO
• License: apache-2.0
• Created: 2023-01-23T12:12:22.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-03-13T16:28:06.000Z (about 3 years ago)
• Last Synced: 2024-04-25T09:23:06.518Z (about 2 years ago)
• Language: JavaScript
• Size: 413 KB
• Stars: 0
• Watchers: 5
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Linter for openEO process specifications

NPM: [@openeo/processes-lint](https://www.npmjs.com/package/@openeo/processes-lint)

1. Install [node and npm](https://nodejs.org) - should run with any recent version

2. Place a config file into your working directory that looks like the [`testConfig.json`](./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 to `https://processes.openeo.org/meta/subtype-schemas.json`

   * `checkSubtypeSchemas`: Enable or disable running checks against the subtype schemas. Defaults to `false` (disabled).

   * `forbidDeprecatedTypes`: Set to `true` to disallow deprecated subtypes such as `raster-cube` and `vector-cube`. Defaults to `false` (disabled).

   * `checkProcessLinks`: Set to `true` to validate whether the links to processes in descriptions are valid (i.e. the files exist). Defaults to `false` (disabled).

   * `verbose`: Verbose output for tests. Defaults to `false` (disabled).

2. Run `npx @openeo/processes-lint testConfig.json`