# eslint-plugin-step-functions

> lints aws step functions state machine json

Latest version **0.0.1** (published 2017-01-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install eslint-plugin-step-functions
pnpm add eslint-plugin-step-functions
yarn add eslint-plugin-step-functions
bun add eslint-plugin-step-functions
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2017-01-30 |
| First published | 2017-01-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Bryan Gamble |
| Maintainers | bdgamble |
| Keywords | eslint, eslintplugin, eslint-plugin |

## Links

- npm: https://www.npmjs.com/package/eslint-plugin-step-functions
- Repository: https://github.com/bdgamble/eslint-plugin-step-functions
- Homepage: https://github.com/bdgamble/eslint-plugin-step-functions#readme
- Issues: https://github.com/bdgamble/eslint-plugin-step-functions/issues
- npm.io page: https://npm.io/package/eslint-plugin-step-functions

## Dependencies (3)

- [joi](https://npm.io/package/joi.md) 10.2.0
- [jshint](https://npm.io/package/jshint.md) 2.9.4
- [json-path-position-info](https://npm.io/package/json-path-position-info.md) 0.0.2

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads

## Recent versions

- 0.0.1 (latest) — 2017-01-30

## README

# eslint-plugin-step-functions

lints aws step functions state machine json

## Installation

You'll first need to install [ESLint](http://eslint.org):

```
$ npm i eslint --save-dev
```

Next, install `eslint-plugin-step-functions`:

```
$ npm install eslint-plugin-step-functions --save-dev
```

**Note:** If you installed ESLint globally (using the `-g` flag) then you must also install `eslint-plugin-step-functions` globally.

## Usage

Add `step-functions` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:

```json
{
    "plugins": [
        "step-functions"
    ]
}
```


Then configure the rules you want to use under the rules section.

```json
{
    "rules": {
        "step-functions/rule-name": 2
    }
}
```

## Supported Rules

* Fill in provided rules here

---
_Source: https://npm.io/package/eslint-plugin-step-functions · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._