https://github.com/awslabs/statelint

A Ruby gem that provides a command-line validator for Amazon States Language JSON files.
https://github.com/awslabs/statelint

Last synced: about 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/awslabs/statelint
• Owner: awslabs
• License: apache-2.0
• Created: 2016-11-02T18:00:33.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-07-02T16:04:37.000Z (3 months ago)
• Last Synced: 2024-07-23T12:39:56.144Z (about 2 months ago)
• Language: Ruby
• Size: 56.6 KB
• Stars: 328
• Watchers: 17
• Forks: 46
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

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

```ruby

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

```