# @wmfs/statelint

> Validator for Amazon States Language JSON files.

Latest version **1.30.1** (published 2026-08-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install @wmfs/statelint
pnpm add @wmfs/statelint
yarn add @wmfs/statelint
bun add @wmfs/statelint
```

Provides the command `statelint`.

## Health

**Score 55/100 (C)** — status: active.

Positive: no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads; no types; no esm support.

## Facts

| | |
|---|---|
| Version | 1.30.1 |
| Published | 2026-08-13 |
| First published | 2018-10-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 102.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9 |
| Author | West Midlands Fire Service |
| Maintainers | wmfsbot |
| Keywords | tymly, package, state machines, aws |

## Links

- npm: https://www.npmjs.com/package/@wmfs/statelint
- Repository: https://github.com/wmfs/statelint
- Homepage: https://github.com/wmfs/statelint#readme
- Issues: https://github.com/wmfs/statelint/issues
- npm.io page: https://npm.io/package/@wmfs/statelint

## Dependencies (3)

- [cli](https://npm.io/package/cli.md) 1.0.1
- [@wmfs/j2119](https://npm.io/package/@wmfs/j2119.md) 1.30.0
- [n-readlines](https://npm.io/package/n-readlines.md) 1.0.1

## Alternatives

- [monaco-yaml](https://npm.io/package/monaco-yaml.md) — 420.1K weekly downloads
- [@crewx/workflow](https://npm.io/package/@crewx/workflow.md) — 3.1K weekly downloads
- [yaml-cat](https://npm.io/package/yaml-cat.md) — 38 weekly downloads
- [nunjucks-in-yaml](https://npm.io/package/nunjucks-in-yaml.md) — 9 weekly downloads
- [shopify-symlinks](https://npm.io/package/shopify-symlinks.md) — 3 weekly downloads

## Recent versions

- 1.30.1 (latest) — 2026-08-13
- 1.30.0 — 2025-07-10
- 1.29.0 — 2025-04-07
- 1.28.0 — 2025-03-31
- 1.27.0 — 2025-02-25
- 1.26.0 — 2024-11-04
- 1.25.0 — 2024-09-18
- 1.24.0 — 2023-05-09
- 1.23.0 — 2023-03-13
- 1.22.0 — 2022-11-02
- 1.21.0 — 2022-11-02
- 1.20.0 — 2022-01-25
- 1.19.0 — 2021-02-24
- 1.18.0 — 2021-01-12
- 1.17.0 — 2021-01-06
- … 21 more at https://npm.io/package/@wmfs/statelint/versions

## README

# statelint
[![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/)
[![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 files. Usable from the command-line or as a library.

This package is derived from Amazon Web Services Labs' [awslabs/statelint](https://github.com/awslabs/statelint) and is up to date with [Amazon States Language](https://states-language.net/) as of [September 7, 2023](https://states-language.net/#september-7-2023).

## From the Command-line 

### Installation
```sh
npm install --global @wmfs/statelint
```

### Usage
```javascript
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/statelint
```

### Usage
```javascript
const stateLint = require('@wmfs/statelint')

const problems = stateLint.validate(json)
if (problems.length !== 0) {
  console.log('Oh dear!')
  problems.forEach(p => console.log(`ERROR: ${p}`)
}
```

* `json` is the state machine to validate as a JSON object.

`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>`.

## Contributing

Bug 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)

## <a name="license"></a>License
Licensed under the terms of the [MIT license](https://github.com/wmfs/statelint/blob/master/LICENSE). Copyright (c) 2018 West Midlands Fire Service

---
_Source: https://npm.io/package/@wmfs/statelint · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._