Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

asl-validator

Package Overview
Dependencies
Maintainers
2
Versions
67
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

asl-validator

Amazon States Language validator

  • 3.10.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
118K
decreased by-3.31%
Maintainers
2
Weekly downloads
 
Created
Source

asl-validator

license

npm version

NPM

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 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

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

npm run test

Lint

npm run lint

See also

License

See LICENSE.

Keywords

FAQs

Package last updated on 03 Dec 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc