https://github.com/doximity/eslint-generate-todo
Tool for generating eslint todo files
https://github.com/doximity/eslint-generate-todo
keep
Last synced: 8 months ago
JSON representation
Tool for generating eslint todo files
- Host: GitHub
- URL: https://github.com/doximity/eslint-generate-todo
- Owner: doximity
- License: other
- Created: 2019-12-18T23:54:33.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-12-05T18:20:56.000Z (over 1 year ago)
- Last Synced: 2025-07-06T08:15:42.513Z (8 months ago)
- Topics: keep
- Language: TypeScript
- Homepage:
- Size: 530 KB
- Stars: 3
- Watchers: 71
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# eslint-generate-todo
Tool for generating eslint todo files
## Installation
```bash
yarn add --dev eslint-generate-todo
```
## Usage
Generate a `.eslintrc-todo` file using the `eslint-generate-todo` CLI:
```bash
eslint-generate-todo
```
You may then extend the resulting `.eslintrc-todo` file in your eslint config:
```yaml
extends:
- .eslintrc-todo.yml
```
## CLI
Run `eslint-generate-todo` through the CLI with this script. Run it with `--help` to see the options. Files use glob syntax and may be specified multiple times.
```bash
eslint-generate-todo [files...]
```
#### `--format`
If you want to specify the file format of the output `.eslintrc-todo` file, you can run `eslint-generate-todo` with the `--format` flag (or `-f`), followed by either `yaml` or `json`. By default `eslint-generate-todo` outputs to `yaml`.
```bash
eslint-generate-todo --format json
```
#### `--off`
To set rule overrides in the generated `.eslintrc-todo` file to `"off"` instead of `"warn"`, you can run `eslint-generate-todo` with the `--off` (or `-o`) flag.
```bash
eslint-generate-todo --off
```
#### `--path`
To change the output path of the generated `.eslintrc-todo` file, you can run `eslint-generate-todo` with the `--path` (or `p`) flag, followed by the project root-relative path.
```bash
eslint-generate-todo --path config/eslint-overrides.yml
```
## Developing
Please read the [CONTRIBUTING](CONTRIBUTING.md) doc before working on eslint-generate-todo.
To build `eslint-generate-todo`, you can run the `build` script:
```bash
yarn run build
```
While developing, you can run the `dev` script to automatically rebuild as files change:
```bash
yarn run dev
```
To lint code changes, you can run the `lint` script:
```bash
yarn run lint
```
To format code using Prettier, you can run the `format` script:
```bash
yarn run format
```
To run tests with Jest, you can run the `test` script:
```bash
yarn run test
```
## License
The `eslint-generate-todo` tool is offered under the [Apache v2](LICENSE) license.