barnard59-pipeline-validation

    0.2.0 • Public • Published

    barnard59-pipeline-validation

    CI status Coverage Status npm version

    Pipeline validation

    Pipeline validation enables you to verify the consistency of your RDF pipelines. It ensures that all pipeline steps are consistent, and can be executed one after another. It is a programmatic reflection of principles behind barnard59

    This script will help you understand what is wrong with your pipeline. Documentation behind barnard59 will guide you how to build a valid one.

    Usage

    Install globally: npm install -g barnard59-pipeline-validation

    CLI help: barnard59-validate -h

    Validating a pipeline definition: barnard59-validate ./sample-pipelines/fetch-json-to-ntriples.ttl

    Available Options

    • Validating a single pipeline by its IRI:
      barnard59-validate your-pipeline-file -p your-pipeline-iri
      For an example, try:
      barnard59-validate ./sample-pipelines/fetch-json-to-ntriples.json -p http://example.org/pipeline/utc
    • Exclude warnings from output:
      barnard59-validate your-pipeline-file --quiet
      For an example, try:
      barnard59-validate ./sample-pipelines/fetch-json-to-ntriples.json -q
    • Show successful validation checks:
      barnard59-validate your-pipeline-file --verbose
      For an example, try:
      barnard59-validate ./sample-pipelines/fetch-json-to-ntriples.json -v
    • Produce an error exit status on warnings (you might want the warnings to show in CI without failing the CI or vice versa):
      barnard59-validate your-pipeline-file --strict
      For an example, try:
      barnard59-validate ./sample-pipelines/fetch-json-to-ntriples.json -s
    • To return error messages in JSON, don't output to a TTY:
      barnard59-validate your-pipeline-file | jq

    Rules

    A JSON summary of all rules is written to ./rules.json whenever the tests are run, it can also be generated by running npm run generate-rules.

    Keywords

    none

    Install

    npm i barnard59-pipeline-validation

    DownloadsWeekly Downloads

    6

    Version

    0.2.0

    License

    MIT

    Unpacked Size

    111 kB

    Total Files

    56

    Last publish

    Collaborators

    • ktk
    • vhf
    • ludovicm67