tslint-to-eslint-config/docs/Creating a Rule Converter.md

Converts your TSLint configuration to the closest reasonable ESLint equivalent.

# Creating a Rule Converter

> If you're not familiar with this project's rule converters work, please read the [Architecture docs](./Architecture/README.md) first.

Adding a new rule converter to `tslint-to-eslint-config` is a relatively straightforward task.
For your convenience, a starter script is included that sets up the files:

```shell
node ./script/newConverter --eslint output-name --tslint input-name
```

If the lint rule includes arguments, add the `--sameArguments` flag above to have starter code generated for that as well.

```shell
node ./script/newConverter --eslint output-name --tslint input-name --sameArguments
```

If the original TSLint rule is obsolete and does not have an ESLint equivalent, you can omit `--eslint`:

```shell
node ./script/newConverter --tslint input-name
```