@angular-eslint/utils
Advanced tools
Please see https://github.com/angular-eslint/angular-eslint for full usage instructions and guidance.
@angular-eslint/utils is a utility package designed to help developers integrate ESLint with Angular projects. It provides a set of tools and utilities to facilitate linting Angular code, ensuring code quality and consistency.
Rule Creation
This feature allows developers to create custom ESLint rules tailored to their Angular projects. The code sample demonstrates how to define a custom rule that disallows a specific pattern.
const { createESLintRule } = require('@angular-eslint/utils');
module.exports = createESLintRule({
name: 'my-custom-rule',
meta: {
type: 'problem',
docs: {
description: 'Disallow certain patterns',
category: 'Best Practices',
recommended: 'error'
},
schema: [],
messages: {
forbiddenPattern: 'This pattern is not allowed.'
}
},
defaultOptions: [],
create(context) {
return {
Identifier(node) {
if (node.name === 'forbiddenPattern') {
context.report({ node, messageId: 'forbiddenPattern' });
}
}
};
}
});AST Utilities
This feature provides utilities for working with Angular's Abstract Syntax Tree (AST). The code sample shows how to use `getTemplateParserServices` to suggest improvements for Angular templates.
const { getTemplateParserServices } = require('@angular-eslint/utils');
module.exports = {
meta: {
type: 'suggestion',
docs: {
description: 'Suggest improvements for Angular templates',
category: 'Best Practices',
recommended: 'warn'
},
schema: [],
messages: {
suggestImprovement: 'Consider improving this template.'
}
},
create(context) {
const parserServices = getTemplateParserServices(context);
return {
'Element$1'(node) {
const templateNode = parserServices.convertNodeSourceSpanToLoc(node.sourceSpan);
context.report({ node: templateNode, messageId: 'suggestImprovement' });
}
};
}
};eslint-plugin-angular is a plugin that provides a set of ESLint rules for AngularJS applications. It focuses on AngularJS (1.x) rather than Angular (2+), making it suitable for legacy projects. Compared to @angular-eslint/utils, it does not support modern Angular features.
eslint-plugin-angularjs is another plugin aimed at linting AngularJS (1.x) code. It offers a variety of rules to enforce best practices and code quality in AngularJS projects. Unlike @angular-eslint/utils, it is not designed for Angular (2+) applications.
eslint-plugin-typescript provides linting rules for TypeScript codebases. While it is not specific to Angular, it can be used in conjunction with other plugins to lint TypeScript code in Angular projects. It does not offer Angular-specific utilities like @angular-eslint/utils.
Please see https://github.com/angular-eslint/angular-eslint for full usage instructions and guidance.
The @angular-eslint/utils package is a set of utility functions and types which are used across the @angular-eslint packages and are helpful when writing your own custom ESLint rules for Angular workspaces.
19.0.1 (2024-12-06)
As always we recommend that you update your existing workspaces by using ng update as we provide some helpful schematics to help migrate your workspaces to the latest and greatest.
However, please note that the angular-eslint package itself now supports being referenced as the schematics collection, so...
IF YOU ARE ALREADY USING angular-eslint and ESLint v9 and flat config you can now do the following:
ng update @angular/core @angular/cli angular-eslint
(Note: If you encounter any issues with this, you may need to update to the latest v18 release of angular-eslint first)
IF YOU ARE STILL USING @angular-eslint/schematics and ESLint v8 and .eslintrc.json configs you can still do the following:
ng update @angular/core @angular/cli @angular-eslint/schematics
NOTE: There will not be any migration of your setup to ESLint v9 or flat configs for existing ESLint v8 workspaces while migrating to angular-eslint v19.
We will explore landing an opt in migration schematic in a minor release after 19.0.0.
FAQs
Please see https://github.com/angular-eslint/angular-eslint for full usage instructions and guidance.
We found that @angular-eslint/utils demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers found several malicious npm packages typosquatting Chalk and Chokidar, targeting Node.js developers with kill switches and data theft.
Security News
pnpm 10 blocks lifecycle scripts by default to improve security, addressing supply chain attack risks but sparking debate over compatibility and workflow changes.
Product
Socket now supports uv.lock files to ensure consistent, secure dependency resolution for Python projects and enhance supply chain security.