@angular-eslint/utils

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' });
      }
    };
  }
};