Skip to content

Latest commit

 

History

History

spectral

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

Spectral validation rules for CALM implementations

These rules perform simple structural checks on CALM implementation files to verify that they make sense semantically. For example, if a relationship references a node, then that node should exist in the file.

Installing spectral

Prerequisites: You need npm on your machine. Tested on Node v20.11.1.

npm install -g @stoplight/spectral-cli

This will install the spectral command globally. Note that you may need to add sudo if you're on a machine that lets you do this.

If you can't run things as root, remove -g; you'll then need to use npx spectral to reference the executable in node_modules.

Running checks

Run checks against a file with the following command:

spectral lint --ruleset aac.yaml implementation.json

For example, to run the rulesets against the sample spec, which should produce several errors:

spectral lint --ruleset ./instantiation/validation-rules.yaml ./examples/bad-rest-api.json

Learn more

See the Spectral documentation for more information on how to configure the Spectral rules.