Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ChristopheBougere/asl-validator
A simple Amazon States Language validator based on JSON schemas.
https://github.com/ChristopheBougere/asl-validator
amazon-states-language aws-step-functions state-machine
Last synced: 3 months ago
JSON representation
A simple Amazon States Language validator based on JSON schemas.
- Host: GitHub
- URL: https://github.com/ChristopheBougere/asl-validator
- Owner: ChristopheBougere
- License: apache-2.0
- Created: 2017-11-13T12:13:02.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2023-11-06T19:33:38.000Z (about 1 year ago)
- Last Synced: 2024-04-16T11:12:26.890Z (7 months ago)
- Topics: amazon-states-language, aws-step-functions, state-machine
- Language: TypeScript
- Homepage:
- Size: 1.01 MB
- Stars: 106
- Watchers: 9
- Forks: 28
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# asl-validator
[](https://github.com/ChristopheBougere/asl-validator/blob/main/LICENSE)
[](https://badge.fury.io/js/asl-validator)
[](https://www.npmjs.com/package/asl-validator)
A simple [**Amazon States Language**](https://states-language.net/spec.html) 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
```bash
# Use via the CLI
npm install -g asl-validator
# Use in your code
npm install asl-validator
```
## CLI
```bash
$ asl-validator --help
Usage: asl-validator [options]
Amazon States Language validator
Options:
-V, --version output the version number
--json-definition JSON definition (default: [])
--json-path JSON path (default: [])
--yaml-definition YAML definition (default: [])
--yaml-path 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 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 valid
- `1` if at least one state machine definition is invalid
- `2` if an exception occurs
## In your code
```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"));
}
```
## Test
```bash
npm run test
```
## Lint
```bash
npm run lint
```
## See also
- [ASL specifications](https://states-language.net/spec.html)
- [ASL documentation on AWS website](http://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html)
- [Blog post](https://www.tbray.org/ongoing/When/201x/2016/12/01/J2119-Validator) 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.
## License
See [LICENSE](./LICENSE).