Amazon States Language validator
npm install asl-validator
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.
``bash`Use via the CLI
npm install -g asl-validatorUse in your code
npm install asl-validator
`bash
$ asl-validator --help
Usage: asl-validator [options]
Amazon States Language validator
Options:
-V, --version output the version number
--json-definition
--json-path
--yaml-definition
--yaml-path
--silent silent mode
--no-path-check skips checking path expressions
--no-arn-check skips the arn check for Resource values
-h, --help display help for command
`
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 valid1
- if at least one state machine definition is invalid2
- if an exception occurs
`javascript`
const aslValidator = require("asl-validator");
const definition = 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 object
console.error(
"✕ State machine definition is invalid:",
errors.map(({ message }) => message).join("\n")
);
// Or display the preformatted errors text
console.error("✕ State machine definition is invalid:", errorsText("\n"));
}
`bash`
npm run test
`bash``
npm run lint
- ASL specifications
- ASL documentation on AWS website
- 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.
See LICENSE.