Skip to content

Commit 1930afc

Browse files
author
Josh Goldberg
committed
Added mini table of contents for CLI flags in README.md
Fixes #76.
1 parent ac65280 commit 1930afc

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,16 @@ TSLint rules without ESLint equivalents will be wrapped with [eslint-plugin-tsli
3636

3737
Each of these flags is optional.
3838

39+
- **[`config`](#config)**: Path to print the generated ESLint configuration file to.
40+
- **[`eslint`](#eslint)**: Path to an ESLint configuration file to read settings from.
41+
- **[`package`](#package)**: Path to a package.json file to read dependencies from.
42+
- **[`tslint`](#tslint)**: Path to a TSLint configuration file to read settings from.
43+
- **[`typescript`](#typescript)**: Path to a TypeScript configuration file to read TypeScript compiler options from.
44+
3945
#### `eslint`
4046

4147
```shell
42-
npx tslint-to-eslint-config --eslint ./path/to/seslintrc.json
48+
npx tslint-to-eslint-config --eslint ./path/to/eslintrc.json
4349
```
4450

4551
_Default: `.eslintrc.js`_
@@ -77,7 +83,7 @@ npx tslint-to-eslint-config --typescript ./path/to/tsconfig.json
7783

7884
_Default: `tsconfig.json`_
7985

80-
Path to a `tsconfig.json` file to read TypeScript compiler options from.
86+
Path to a TypeScript configuration file to read TypeScript compiler options from.
8187
This will help inform the generated ESLint configuration file's [env](https://eslint.org/docs/user-guide/configuring#specifying-parser-options) settings.
8288

8389
## Development

0 commit comments

Comments
 (0)