@angular-eslint/schematics

What is @angular-eslint/schematics?

@angular-eslint/schematics is a package that provides a set of schematics for integrating ESLint into Angular projects. It helps in setting up and managing linting configurations, converting TSLint configurations to ESLint, and generating new Angular components with ESLint configurations.

What are @angular-eslint/schematics's main functionalities?

Converting TSLint to ESLint

This schematic converts an existing Angular project that uses TSLint to use ESLint instead. It updates the configuration files and installs the necessary dependencies.

ng g @angular-eslint/schematics:convert-tslint-to-eslint

Generating new Angular components with ESLint

This schematic generates a new Angular component with ESLint configurations applied. It ensures that the new component adheres to the linting rules defined in the project.

ng g @angular-eslint/schematics:component my-component

Setting up ESLint in a new Angular project

This schematic sets up ESLint in a new Angular project. It configures the necessary files and installs the required dependencies to start using ESLint for linting the project.

ng add @angular-eslint/schematics

Other packages similar to @angular-eslint/schematics

eslint

ESLint is a popular linting tool for JavaScript and TypeScript. While it does not provide Angular-specific schematics, it can be configured to work with Angular projects by using plugins and custom configurations.

tslint

TSLint is a linting tool for TypeScript. It was commonly used in Angular projects before the community started migrating to ESLint. TSLint is now deprecated in favor of ESLint.

angular-cli

Angular CLI is a command-line interface for Angular. It provides various commands for generating and managing Angular projects, including setting up linting configurations. However, it does not specifically focus on ESLint integration like @angular-eslint/schematics.

README

@angular-eslint/schematics

Please see https://github.com/angular-eslint/angular-eslint for full usage instructions and guidance.

The @angular-eslint/schematics package is a set of custom Angular CLI Schematics which are used to add and update dependencies and configuration files which are relevant for running ESLint on an Angular workspace.