Skip to content

Commit b0a76e0

Browse files
author
Josh Goldberg
authored
Added mini table of contents for CLI flags in README.md (#77)
* Added mini table of contents for CLI flags in README.md Fixes #76. * Removed not yet available config entry
1 parent ac65280 commit b0a76e0

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

README.md

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

3737
Each of these flags is optional.
3838

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

4146
```shell
42-
npx tslint-to-eslint-config --eslint ./path/to/seslintrc.json
47+
npx tslint-to-eslint-config --eslint ./path/to/eslintrc.json
4348
```
4449

4550
_Default: `.eslintrc.js`_
@@ -77,7 +82,7 @@ npx tslint-to-eslint-config --typescript ./path/to/tsconfig.json
7782

7883
_Default: `tsconfig.json`_
7984

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

8388
## Development

0 commit comments

Comments
 (0)