Skip to content

A Ruby gem that provides a command-line validator for Amazon States Language JSON files.

License

Notifications You must be signed in to change notification settings

awslabs/statelint

Folders and files

NameName
Last commit message
Last commit date

Latest commit

7b86a6c · Nov 21, 2024

History

55 Commits
Mar 19, 2024
Aug 9, 2017
Nov 21, 2024
Jul 18, 2023
Nov 21, 2024
Nov 21, 2024
Dec 14, 2023
Oct 31, 2019
Nov 2, 2016
Nov 17, 2016
Dec 14, 2023
Nov 17, 2016
Nov 21, 2024

statelint

A Ruby gem that provides a command-line validator for Amazon States Language JSON files.

Installation

Add this line to your application's Gemfile:

gem 'statelint'

And then execute:

$ bundle

Or install it yourself as:

$ gem install statelint

Usage

statelint state-machine-spec, state-machinespec...

There are no options. If you see no output, your state machine is fine.

To do

Currently covers most of the grammatical constraints for state-machine definitions. The checking of JsonPath syntax is hand-built and probably imperfect.

The Ruby JSON parser unfortunately does not detect duplicate keys in objects, so neither does statelint.

Contributing

Bug reports and pull requests are welcome on GitHub

Testing

All changes should be covered by unit tests in the spec directory. To run tests, execute the following from the package root:

bundle exec rspec

About

A Ruby gem that provides a command-line validator for Amazon States Language JSON files.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published