You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A simple Amazon States Language validator based on JSON schemas. It also validates JSON paths syntax in InputPath, OutputPath and ResultPath.
When writing your state machine (for AWS step functions), you can't locally validate you state machine definition without creating it. asl-validator makes it possible.
Install
# Use via the CLI
npm install -g asl-validator
# Use in your code
npm install asl-validator
CLI
$ asl-validator --help
Usage: asl-validator [options]
Amazon States Language validator
Options:
-V, --version output the version number
--json-definition <jsonDefinition> JSON definition (default: [])
--json-path <jsonPath> JSON path (default: [])
--yaml-definition <yamlDefinition> YAML definition (default: [])
--yaml-path <yamlPath> YAML path (default: [])
--silent silent mode
--no-path-check skips checking path expressions
--no-arn-check skips the arn check for Resource values
-h, --help display helpforcommand
You can validate multiple state machines at once by passing multiple --json-definition, --json-path, --yaml-definition and --yaml-path arguments.
Return status:
0 if state machine definitions are valid
1 if at least one state machine definition is invalid
2 if an exception occurs
In your code
constaslValidator=require("asl-validator");constdefinition=require("./path/to/my/state/machine/json/definition");const{ isValid, errors, errorsText }=aslValidator(definition);if(isValid){console.log("✓ State machine definition is valid");}else{// Either go through the errors objectconsole.error("✕ State machine definition is invalid:",errors.map(({ message })=>message).join("\n"));// Or display the preformatted errors textconsole.error("✕ State machine definition is invalid:",errorsText("\n"));}
Blog post from the creator of ASL explaining the pros and cons of a JSON schema based validator. An RFC based looks really interesting, but still the JSON schema approach seems more flexible and evolutive.
