nx/docs/angular/api-angular/generators/convert-tslint-to-eslint.md
James Henry bff5d431c9
feat(core): add --ignoreExistingTsLintConfig option to lint conversion generators (#5127)
* feat(core): add --discardExistingLintConfig option to lint conversion generators

* fixup! feat(core): add --discardExistingLintConfig option to lint conversion generators

* chore(core): address PR feedback

* fix(linter): properly store defualts for converting tslint to eslint

* fix(linter): fix tests for set defaults

Co-authored-by: Jason Jean <jasonjean1993@gmail.com>
2021-04-12 15:40:48 -04:00

56 lines
1.2 KiB
Markdown

# convert-tslint-to-eslint
Convert a project from TSLint to ESLint
## Usage
```bash
nx generate convert-tslint-to-eslint ...
```
By default, Nx will search for `convert-tslint-to-eslint` in the default collection provisioned in `angular.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/angular:convert-tslint-to-eslint ...
```
Show what will be generated without writing to disk:
```bash
nx g convert-tslint-to-eslint ... --dry-run
```
### Examples
Convert the Angular project `myapp` from TSLint to ESLint:
```bash
nx g convert-tslint-to-eslint myapp
```
## Options
### ignoreExistingTslintConfig
Default: `false`
Type: `boolean`
If true we will not use existing TSLint config as a reference, we will just reset the project with the latest recommended ESLint config
### project
Type: `string`
The name of the Angular project to convert. Please note, if the project is an Angular app with an associated Cypress e2e project, we will also attempt to convert that.
### removeTSLintIfNoMoreTSLintTargets
Default: `true`
Type: `boolean`
If this conversion leaves no more TSLint usage in the workspace, it will remove TSLint and related dependencies and configuration