{"_id":"@ben-wormald/statelint","_rev":"1-57693f2bb36f75bfac7538ba093ff2a3","name":"@ben-wormald/statelint","dist-tags":{"latest":"1.25.1"},"versions":{"1.25.0":{"name":"@ben-wormald/statelint","version":"1.25.0","keywords":["tymly","package","state machines","aws"],"author":{"name":"West Midlands Fire Service"},"license":"MIT","_id":"@ben-wormald/statelint@1.25.0","maintainers":[{"name":"ben-wormald","email":"benwormald95@gmail.com"}],"homepage":"https://github.com/wmfs/statelint#readme","bugs":{"url":"https://github.com/wmfs/statelint/issues"},"bin":{"statelint":"bin/statelint.js"},"dist":{"shasum":"4aa5f36f8b1e499db0d0df10d3bc03fd341f7bd7","tarball":"https://registry.npmjs.org/@ben-wormald/statelint/-/statelint-1.25.0.tgz","fileCount":41,"integrity":"sha512-vaYGC+1URiuzcyqIUEZasw2KkhzcVpN4y0MQop2R9GUsWfI6GofbpV/9121VI/9jdFXcHoU+nvCSIzy/Zh0sTw==","signatures":[{"sig":"MEYCIQCR54I5h5mICjWjpAOwug42ydESyN+CO/G3HievNvg3TAIhAKTRmZ7RKAcxm+AGXuaWVphYnGHjWIaigJbI2FDEF8NF","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":76955},"main":"lib/index.js","config":{"commitizen":{"path":"cz-conventional-changelog"}},"gitHead":"cfacbf3c98da246dd1328847f3258df04b33c7ec","scripts":{"lint":"standard","test":"nyc mocha","coverage":"nyc report --reporter=text-lcov > coverage.lcov && codecov","statelint":"./bin/statelint.js","semantic-release":"semantic-release"},"_npmUser":{"name":"ben-wormald","email":"benwormald95@gmail.com"},"repository":{"url":"git+https://github.com/wmfs/statelint.git","type":"git"},"_npmVersion":"10.5.0","description":"Validator for Amazon States Language JSON files.","directories":{},"_nodeVersion":"20.12.2","dependencies":{"cli":"1.0.1","@wmfs/j2119":"1.25.0","n-readlines":"1.0.1"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"nyc":"15.1.0","tmp":"0.2.3","chai":"4.4.1","mocha":"10.4.0","codecov":"3.8.3","standard":"17.1.0","dirty-chai":"2.0.1","semantic-release":"24.0.0","@semantic-release/git":"10.0.1","cz-conventional-changelog":"3.3.0","@semantic-release/changelog":"6.0.3","conventional-changelog-metahub":"4.0.1"},"_npmOperationalInternal":{"tmp":"tmp/statelint_1.25.0_1722595429991_0.2639370869633557","host":"s3://npm-registry-packages"}},"1.25.1":{"name":"@ben-wormald/statelint","version":"1.25.1","description":"Validator for Amazon States Language JSON files.","author":{"name":"West Midlands Fire Service"},"homepage":"https://github.com/wmfs/statelint#readme","keywords":["tymly","package","state machines","aws"],"license":"MIT","repository":{"type":"git","url":"git+https://github.com/wmfs/statelint.git"},"bugs":{"url":"https://github.com/wmfs/statelint/issues"},"main":"lib/index.js","bin":{"statelint":"bin/statelint.js"},"dependencies":{"@wmfs/j2119":"1.25.0","cli":"1.0.1","n-readlines":"1.0.1"},"devDependencies":{"@semantic-release/changelog":"6.0.3","@semantic-release/git":"10.0.1","chai":"4.4.1","codecov":"3.8.3","conventional-changelog-metahub":"4.0.1","cz-conventional-changelog":"3.3.0","dirty-chai":"2.0.1","mocha":"10.4.0","nyc":"15.1.0","semantic-release":"24.0.0","standard":"17.1.0","tmp":"0.2.3"},"scripts":{"statelint":"./bin/statelint.js","lint":"standard","test":"nyc mocha","coverage":"nyc report --reporter=text-lcov > coverage.lcov && codecov","semantic-release":"semantic-release"},"config":{"commitizen":{"path":"cz-conventional-changelog"}},"publishConfig":{"access":"public"},"_id":"@ben-wormald/statelint@1.25.1","gitHead":"cfacbf3c98da246dd1328847f3258df04b33c7ec","_nodeVersion":"20.12.2","_npmVersion":"10.5.0","dist":{"integrity":"sha512-+Lccgdl73XMEXugDpjt9viVYr9bIrbEJDHxvkWzqBxJznzQjwMzCgyws9WMpWwjaX7pxor+393Yy24ibIc58WA==","shasum":"b44c1f04148b3c64839b5c5b065fc7f53a789c98","tarball":"https://registry.npmjs.org/@ben-wormald/statelint/-/statelint-1.25.1.tgz","fileCount":41,"unpackedSize":79475,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCICNNcBHMjEax8AbA2Ecs0in1KG8UxOBxzbJuSmjRiG0OAiEAry+8YmhBxoAM94Am1wc96jHyio2ApJU68NPKuTbASJc="}]},"_npmUser":{"name":"ben-wormald","email":"benwormald95@gmail.com"},"directories":{},"maintainers":[{"name":"ben-wormald","email":"benwormald95@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/statelint_1.25.1_1722595716284_0.18816237041421924"},"_hasShrinkwrap":false}},"time":{"created":"2024-08-02T10:43:49.877Z","modified":"2024-08-02T10:48:36.651Z","1.25.0":"2024-08-02T10:43:50.196Z","1.25.1":"2024-08-02T10:48:36.488Z"},"bugs":{"url":"https://github.com/wmfs/statelint/issues"},"author":{"name":"West Midlands Fire Service"},"license":"MIT","homepage":"https://github.com/wmfs/statelint#readme","keywords":["tymly","package","state machines","aws"],"repository":{"type":"git","url":"git+https://github.com/wmfs/statelint.git"},"description":"Validator for Amazon States Language JSON files.","maintainers":[{"name":"ben-wormald","email":"benwormald95@gmail.com"}],"readme":"# statelint\n[![Tymly Package](https://img.shields.io/badge/tymly-package-blue.svg)](https://tymly.io/) [![npm (scoped)](https://img.shields.io/npm/v/@wmfs/statelint.svg)](https://www.npmjs.com/package/@wmfs/statelint) [![CircleCI](https://circleci.com/gh/wmfs/statelint.svg?style=svg)](https://circleci.com/gh/wmfs/statelint) [![codecov](https://codecov.io/gh/wmfs/statelint/branch/master/graph/badge.svg)](https://codecov.io/gh/wmfs/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/)\n[![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)\n\nAn npm package providing a validator for [Amazon States Language](https://states-language.net/spec.html) JSON files. Usable from the command-line or as a library.\n\nThis package is derived from Amazon Web Services Labs' [awslabs/statelint](https://github.com/awslabs/statelint) and is up to date with the [changes announced on 29 November 2018](https://aws.amazon.com/blogs/aws/new-compute-database-messaging-analytics-and-machine-learning-integration-for-aws-step-functions/).\n\n## From the Command-line \n\n### Installation\n```sh\nnpm install --global @wmfs/statelint\n```\n\n### Usage\n```javascript\nstatelint state-machine-spec [state-machine-spec...]\n```\n\nThere are no options. If you see no output, your state machine is fine.\n\n## As a library \n\n### Installation\n```sh\nnpm install --save @wmfs/statelint\n```\n\n### Usage\n```javascript\nconst stateLint = require('@wmfs/statelint')\n\nconst problems = stateLint.validate(json)\nif (problems.length !== 0) {\n  console.log('Oh dear!')\n  problems.forEach(p => console.log(`ERROR: ${p}`)\n}\n```\n\n* `json` is the state machine to validate as a JSON object.\n\n`stateLint.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>`.\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub. Please be aware of our [Code of Conduct](https://github.com/wmfs/statelint/blob/master/CODE_OF_CONDUCT.md)\n\n## <a name=\"license\"></a>License\nLicensed under the terms of the [MIT license](https://github.com/wmfs/statelint/blob/master/LICENSE). Copyright (c) 2018 West Midlands Fire Service\n\n","readmeFilename":"README.md"}