Nutritious Pomegranate Muffins
    Wondering what’s next for npm?Check out our public roadmap! »

    @wmfs/tymly-statelint

    1.42.0 • Public • Published

    tymly-statelint

    Tymly Package npm (scoped) CircleCI codecov Dependabot badge Commitizen friendly JavaScript Style Guide license

    An npm package providing a validator for Amazon States Language JSON with Tymly extensions. Usable from the command-line or as a library.

    It builds on statelint, a package for validating unextended Amazon States Language JSON.

    From the Command-line

    Installation

    npm install --global @wmfs/tymly-statelint

    Usage

    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

    npm install --save @wmfs/tymly-statelint

    Usage

    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 <json-path to error> <description of error>.

    Contributing

    Bug reports and pull requests are welcome on GitHub. Please be aware of our Code of Conduct

    License

    Licensed under the terms of the MIT license. Copyright (c) 2018 West Midlands Fire Service

    Install

    npm i @wmfs/tymly-statelint

    DownloadsWeekly Downloads

    87

    Version

    1.42.0

    License

    MIT

    Unpacked Size

    68.1 kB

    Total Files

    24

    Last publish

    Collaborators

    • avatar