https://github.com/wmfs/tymly-statelint

Validator for Amazon States Language with Tymly Extensions JSON
https://github.com/wmfs/tymly-statelint

package tymly

Last synced: 3 months ago
JSON representation

Validator for Amazon States Language with Tymly Extensions JSON

• Host: GitHub
• URL: https://github.com/wmfs/tymly-statelint
• Owner: wmfs
• License: mit
• Created: 2018-10-09T14:25:14.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-09-16T11:37:28.000Z (4 months ago)
• Last Synced: 2024-09-17T07:15:07.336Z (4 months ago)
• Topics: package, tymly
• Language: JavaScript
• Homepage:
• Size: 243 KB
• Stars: 2
• Watchers: 7
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# tymly-statelint

[![Tymly Package](https://img.shields.io/badge/tymly-package-blue.svg)](https://tymly.io/) [![npm (scoped)](https://img.shields.io/npm/v/@wmfs/tymly-statelint.svg)](https://www.npmjs.com/package/@wmfs/tymly-statelint) [![CircleCI](https://circleci.com/gh/wmfs/tymly-statelint.svg?style=svg)](https://circleci.com/gh/wmfs/tymly-statelint) [![codecov](https://codecov.io/gh/wmfs/tymly-statelint/branch/master/graph/badge.svg)](https://codecov.io/gh/wmfs/tymly-statelint) [![Dependabot badge](https://img.shields.io/badge/Dependabot-active-brightgreen.svg)](https://dependabot.com/) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com) [![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/wmfs/tymly/blob/master/packages/statelint/LICENSE)

An npm package providing a validator for [Amazon States Language](https://states-language.net/spec.html) JSON with [Tymly](https://tymly.io/) extensions. Usable from the command-line or as a library.

It builds on [`statelint`](https://npmjs.com/package/@wmfs/statelint), a package for validating unextended Amazon States Language JSON.

## From the Command-line 

### Installation

```sh

npm install --global @wmfs/tymly-statelint

```

### Usage

```javascript

tymly-statelint state-machine-spec [state-machine-spec...]

```

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

## As a library 

### Installation

```sh

npm install --save @wmfs/tymly-statelint

```

### Usage

```javascript

const tymlyStateLint = require('@wmfs/statelint')

const problems = tymlyStateLint.validate(json)

if (problems.length !== 0) {

  console.log('Oh dear!')

  problems.forEach(p => console.log(`ERROR: ${p}`)

}

```

* `json` is the state machine to validate. It can be a JSON object, a filename, or a file descriptor.

`tymlyStatelint.validate` returns an array or error strings. If the array is empty, the state machine is fine. If not, then there's a problem! The validator is exhaustive, so it will report every problem it finds, not simply bail at the first thing. The error messages have the general form ` `.

## Contributing

Bug reports and pull requests are welcome on GitHub. Please be aware of our [Code of Conduct](https://github.com/wmfs/tymly-statelint/blob/master/CODE_OF_CONDUCT.md)

## License

Licensed under the terms of the [MIT license](https://github.com/wmfs/tymly-statelint/blob/master/LICENSE). Copyright (c) 2018 West Midlands Fire Service