feat(utils): export template parser services (#1211)

angular-eslint · Nov 20, 2022 · 34a62d2 · 34a62d2
1 parent 0273649
commit 34a62d2
Show file tree

Hide file tree

Showing 30 changed files with 104 additions and 150 deletions.
diff --git a/packages/eslint-plugin-template/package.json b/packages/eslint-plugin-template/package.json
@@ -18,13 +18,13 @@
   ],
   "dependencies": {
     "@angular-eslint/bundled-angular-compiler": "14.3.1",
+    "@angular-eslint/utils": "14.3.1",
     "@typescript-eslint/type-utils": "5.43.0",
     "@typescript-eslint/utils": "5.43.0",
     "aria-query": "5.1.3",
     "axobject-query": "3.1.1"
   },
   "devDependencies": {
-    "@angular-eslint/utils": "14.3.1",
     "@types/aria-query": "5.0.1"
   },
   "peerDependencies": {

diff --git a/packages/eslint-plugin-template/src/rules/accessibility-alt-text.ts b/packages/eslint-plugin-template/src/rules/accessibility-alt-text.ts
@@ -2,10 +2,8 @@ import type {
   Node,
   TmplAstElement,
 } from '@angular-eslint/bundled-angular-compiler';
-import {
-  createESLintRule,
-  getTemplateParserServices,
-} from '../utils/create-eslint-rule';
+import { getTemplateParserServices } from '@angular-eslint/utils';
+import { createESLintRule } from '../utils/create-eslint-rule';
 import { getAttributeValue } from '../utils/get-attribute-value';
 
 type Options = [];

diff --git a/packages/eslint-plugin-template/src/rules/accessibility-elements-content.ts b/packages/eslint-plugin-template/src/rules/accessibility-elements-content.ts
@@ -1,8 +1,6 @@
 import type { TmplAstElement } from '@angular-eslint/bundled-angular-compiler';
-import {
-  createESLintRule,
-  getTemplateParserServices,
-} from '../utils/create-eslint-rule';
+import { getTemplateParserServices } from '@angular-eslint/utils';
+import { createESLintRule } from '../utils/create-eslint-rule';
 import { isHiddenFromScreenReader } from '../utils/is-hidden-from-screen-reader';
 
 type Options = [

diff --git a/packages/eslint-plugin-template/src/rules/accessibility-interactive-supports-focus.ts b/packages/eslint-plugin-template/src/rules/accessibility-interactive-supports-focus.ts
@@ -1,8 +1,6 @@
 import type { TmplAstElement } from '@angular-eslint/bundled-angular-compiler';
-import {
-  createESLintRule,
-  getTemplateParserServices,
-} from '../utils/create-eslint-rule';
+import { getTemplateParserServices } from '@angular-eslint/utils';
+import { createESLintRule } from '../utils/create-eslint-rule';
 import { getDomElements } from '../utils/get-dom-elements';
 import { isHiddenFromScreenReader } from '../utils/is-hidden-from-screen-reader';
 import {

diff --git a/packages/eslint-plugin-template/src/rules/accessibility-label-for.ts b/packages/eslint-plugin-template/src/rules/accessibility-label-for.ts
@@ -1,8 +1,6 @@
 import type { TmplAstElement } from '@angular-eslint/bundled-angular-compiler';
-import {
-  createESLintRule,
-  getTemplateParserServices,
-} from '../utils/create-eslint-rule';
+import { getTemplateParserServices } from '@angular-eslint/utils';
+import { createESLintRule } from '../utils/create-eslint-rule';
 import { isChildNodeOf } from '../utils/is-child-node-of';
 
 type Options = [

diff --git a/packages/eslint-plugin-template/src/rules/accessibility-label-has-associated-control.ts b/packages/eslint-plugin-template/src/rules/accessibility-label-has-associated-control.ts
@@ -1,8 +1,6 @@
 import type { TmplAstElement } from '@angular-eslint/bundled-angular-compiler';
-import {
-  createESLintRule,
-  getTemplateParserServices,
-} from '../utils/create-eslint-rule';
+import { getTemplateParserServices } from '@angular-eslint/utils';
+import { createESLintRule } from '../utils/create-eslint-rule';
 import { isChildNodeOf } from '../utils/is-child-node-of';
 
 type LabelComponent = {

diff --git a/packages/eslint-plugin-template/src/rules/accessibility-role-has-required-aria.ts b/packages/eslint-plugin-template/src/rules/accessibility-role-has-required-aria.ts
@@ -2,12 +2,10 @@ import type {
   TmplAstTextAttribute,
   TmplAstElement,
 } from '@angular-eslint/bundled-angular-compiler';
+import { getTemplateParserServices } from '@angular-eslint/utils';
 import type { ARIARoleDefinitionKey } from 'aria-query';
 import { roles } from 'aria-query';
-import {
-  createESLintRule,
-  getTemplateParserServices,
-} from '../utils/create-eslint-rule';
+import { createESLintRule } from '../utils/create-eslint-rule';
 import { getDomElements } from '../utils/get-dom-elements';
 import { toPattern } from '../utils/to-pattern';
 import { isSemanticRoleElement } from '../utils/is-semantic-role-element';

diff --git a/packages/eslint-plugin-template/src/rules/accessibility-table-scope.ts b/packages/eslint-plugin-template/src/rules/accessibility-table-scope.ts
@@ -2,10 +2,8 @@ import type {
   TmplAstBoundAttribute,
   TmplAstTextAttribute,
 } from '@angular-eslint/bundled-angular-compiler';
-import {
-  createESLintRule,
-  getTemplateParserServices,
-} from '../utils/create-eslint-rule';
+import { getTemplateParserServices } from '@angular-eslint/utils';
+import { createESLintRule } from '../utils/create-eslint-rule';
 import { getDomElements } from '../utils/get-dom-elements';
 import { toPattern } from '../utils/to-pattern';
 

diff --git a/packages/eslint-plugin-template/src/rules/accessibility-valid-aria.ts b/packages/eslint-plugin-template/src/rules/accessibility-valid-aria.ts
@@ -7,12 +7,10 @@ import {
   TmplAstBoundAttribute,
   TmplAstTextAttribute,
 } from '@angular-eslint/bundled-angular-compiler';
+import { getTemplateParserServices } from '@angular-eslint/utils';
 import type { ARIAProperty, ARIAPropertyDefinition } from 'aria-query';
 import { aria } from 'aria-query';
-import {
-  createESLintRule,
-  getTemplateParserServices,
-} from '../utils/create-eslint-rule';
+import { createESLintRule } from '../utils/create-eslint-rule';
 import { getDomElements } from '../utils/get-dom-elements';
 import { toPattern } from '../utils/to-pattern';
 

diff --git a/packages/eslint-plugin-template/src/rules/attributes-order.ts b/packages/eslint-plugin-template/src/rules/attributes-order.ts
@@ -7,11 +7,9 @@ import type {
   TmplAstNode,
 } from '@angular-eslint/bundled-angular-compiler';
 import { TmplAstTemplate } from '@angular-eslint/bundled-angular-compiler';
+import { getTemplateParserServices } from '@angular-eslint/utils';
 import type { TSESTree } from '@typescript-eslint/utils';
-import {
-  createESLintRule,
-  getTemplateParserServices,
-} from '../utils/create-eslint-rule';
+import { createESLintRule } from '../utils/create-eslint-rule';
 
 export const enum OrderType {
   TemplateReferenceVariable = 'TEMPLATE_REFERENCE',

diff --git a/packages/eslint-plugin-template/src/rules/banana-in-box.ts b/packages/eslint-plugin-template/src/rules/banana-in-box.ts
@@ -1,8 +1,6 @@
 import type { TmplAstBoundEvent } from '@angular-eslint/bundled-angular-compiler';
-import {
-  createESLintRule,
-  getTemplateParserServices,
-} from '../utils/create-eslint-rule';
+import { getTemplateParserServices } from '@angular-eslint/utils';
+import { createESLintRule } from '../utils/create-eslint-rule';
 
 type Options = [];
 export type MessageIds = 'bananaInBox';

diff --git a/packages/eslint-plugin-template/src/rules/button-has-type.ts b/packages/eslint-plugin-template/src/rules/button-has-type.ts
@@ -6,10 +6,8 @@ import {
   ASTWithSource,
   LiteralPrimitive,
 } from '@angular-eslint/bundled-angular-compiler';
-import {
-  createESLintRule,
-  getTemplateParserServices,
-} from '../utils/create-eslint-rule';
+import { getTemplateParserServices } from '@angular-eslint/utils';
+import { createESLintRule } from '../utils/create-eslint-rule';
 
 export const RULE_NAME = 'button-has-type';
 export const INVALID_TYPE_DATA_KEY = 'type';

diff --git a/packages/eslint-plugin-template/src/rules/click-events-have-key-events.ts b/packages/eslint-plugin-template/src/rules/click-events-have-key-events.ts
@@ -1,8 +1,6 @@
 import type { TmplAstElement } from '@angular-eslint/bundled-angular-compiler';
-import {
-  createESLintRule,
-  getTemplateParserServices,
-} from '../utils/create-eslint-rule';
+import { getTemplateParserServices } from '@angular-eslint/utils';
+import { createESLintRule } from '../utils/create-eslint-rule';
 import { getDomElements } from '../utils/get-dom-elements';
 import { isHiddenFromScreenReader } from '../utils/is-hidden-from-screen-reader';
 import { isInteractiveElement } from '../utils/is-interactive-element';

diff --git a/packages/eslint-plugin-template/src/rules/conditional-complexity.ts b/packages/eslint-plugin-template/src/rules/conditional-complexity.ts
@@ -11,10 +11,8 @@ import {
   Lexer,
   Parser,
 } from '@angular-eslint/bundled-angular-compiler';
-import {
-  createESLintRule,
-  ensureTemplateParser,
-} from '../utils/create-eslint-rule';
+import { ensureTemplateParser } from '@angular-eslint/utils';
+import { createESLintRule } from '../utils/create-eslint-rule';
 
 type Options = [{ maxComplexity: number }];
 export type MessageIds = 'conditionalComplexity';

diff --git a/packages/eslint-plugin-template/src/rules/cyclomatic-complexity.ts b/packages/eslint-plugin-template/src/rules/cyclomatic-complexity.ts
@@ -2,10 +2,8 @@ import type {
   TmplAstBoundAttribute,
   TmplAstTextAttribute,
 } from '@angular-eslint/bundled-angular-compiler';
-import {
-  createESLintRule,
-  getTemplateParserServices,
-} from '../utils/create-eslint-rule';
+import { getTemplateParserServices } from '@angular-eslint/utils';
+import { createESLintRule } from '../utils/create-eslint-rule';
 
 type Options = [{ maxComplexity: number }];
 export type MessageIds = 'cyclomaticComplexity';

diff --git a/packages/eslint-plugin-template/src/rules/eqeqeq.ts b/packages/eslint-plugin-template/src/rules/eqeqeq.ts
@@ -3,11 +3,9 @@ import {
   ASTWithSource,
   LiteralPrimitive,
 } from '@angular-eslint/bundled-angular-compiler';
+import { ensureTemplateParser } from '@angular-eslint/utils';
 import type { TSESLint } from '@typescript-eslint/utils';
-import {
-  createESLintRule,
-  ensureTemplateParser,
-} from '../utils/create-eslint-rule';
+import { createESLintRule } from '../utils/create-eslint-rule';
 import { getNearestNodeFrom } from '../utils/get-nearest-node-from';
 
 type Options = [{ readonly allowNullOrUndefined?: boolean }];

diff --git a/packages/eslint-plugin-template/src/rules/i18n.ts b/packages/eslint-plugin-template/src/rules/i18n.ts
@@ -12,11 +12,9 @@ import {
   TmplAstElement,
 } from '@angular-eslint/bundled-angular-compiler';
 import type { Message } from '@angular-eslint/bundled-angular-compiler';
+import { getTemplateParserServices } from '@angular-eslint/utils';
 import type { TSESLint, TSESTree } from '@typescript-eslint/utils';
-import {
-  createESLintRule,
-  getTemplateParserServices,
-} from '../utils/create-eslint-rule';
+import { createESLintRule } from '../utils/create-eslint-rule';
 import { getNearestNodeFrom } from '../utils/get-nearest-node-from';
 
 // source: https://github.com/yury-dymov/js-regex-pl/blob/ff10757b2a98ad0bf0f62acebad085bab3748fc4/src/index.js#L7

diff --git a/packages/eslint-plugin-template/src/rules/mouse-events-have-key-events.ts b/packages/eslint-plugin-template/src/rules/mouse-events-have-key-events.ts
@@ -1,9 +1,7 @@
 import type { TmplAstElement } from '@angular-eslint/bundled-angular-compiler';
+import { getTemplateParserServices } from '@angular-eslint/utils';
 import type { TSESLint } from '@typescript-eslint/utils';
-import {
-  createESLintRule,
-  getTemplateParserServices,
-} from '../utils/create-eslint-rule';
+import { createESLintRule } from '../utils/create-eslint-rule';
 import { getDomElements } from '../utils/get-dom-elements';
 import { toPattern } from '../utils/to-pattern';
 

diff --git a/packages/eslint-plugin-template/src/rules/no-any.ts b/packages/eslint-plugin-template/src/rules/no-any.ts
@@ -4,10 +4,8 @@ import {
   PropertyRead,
   ThisReceiver,
 } from '@angular-eslint/bundled-angular-compiler';
-import {
-  createESLintRule,
-  ensureTemplateParser,
-} from '../utils/create-eslint-rule';
+import { ensureTemplateParser } from '@angular-eslint/utils';
+import { createESLintRule } from '../utils/create-eslint-rule';
 
 type Options = [];
 export type MessageIds = 'noAny' | 'suggestRemoveAny';

diff --git a/packages/eslint-plugin-template/src/rules/no-autofocus.ts b/packages/eslint-plugin-template/src/rules/no-autofocus.ts
@@ -2,10 +2,8 @@ import type {
   TmplAstBoundAttribute,
   TmplAstTextAttribute,
 } from '@angular-eslint/bundled-angular-compiler';
-import {
-  createESLintRule,
-  getTemplateParserServices,
-} from '../utils/create-eslint-rule';
+import { getTemplateParserServices } from '@angular-eslint/utils';
+import { createESLintRule } from '../utils/create-eslint-rule';
 import { getDomElements } from '../utils/get-dom-elements';
 import { toPattern } from '../utils/to-pattern';
 

diff --git a/packages/eslint-plugin-template/src/rules/no-call-expression.ts b/packages/eslint-plugin-template/src/rules/no-call-expression.ts
@@ -1,9 +1,7 @@
 import type { Call } from '@angular-eslint/bundled-angular-compiler';
 import { TmplAstBoundEvent } from '@angular-eslint/bundled-angular-compiler';
-import {
-  createESLintRule,
-  ensureTemplateParser,
-} from '../utils/create-eslint-rule';
+import { ensureTemplateParser } from '@angular-eslint/utils';
+import { createESLintRule } from '../utils/create-eslint-rule';
 import { getNearestNodeFrom } from '../utils/get-nearest-node-from';
 
 type Options = [];

diff --git a/packages/eslint-plugin-template/src/rules/no-distracting-elements.ts b/packages/eslint-plugin-template/src/rules/no-distracting-elements.ts
@@ -1,8 +1,6 @@
 import type { TmplAstElement } from '@angular-eslint/bundled-angular-compiler';
-import {
-  createESLintRule,
-  getTemplateParserServices,
-} from '../utils/create-eslint-rule';
+import { getTemplateParserServices } from '@angular-eslint/utils';
+import { createESLintRule } from '../utils/create-eslint-rule';
 
 type Options = [];
 export type MessageIds = 'noDistractingElements';

diff --git a/packages/eslint-plugin-template/src/rules/no-duplicate-attributes.ts b/packages/eslint-plugin-template/src/rules/no-duplicate-attributes.ts
@@ -4,10 +4,8 @@ import type {
   TmplAstElement,
   TmplAstTextAttribute,
 } from '@angular-eslint/bundled-angular-compiler';
-import {
-  createESLintRule,
-  getTemplateParserServices,
-} from '../utils/create-eslint-rule';
+import { getTemplateParserServices } from '@angular-eslint/utils';
+import { createESLintRule } from '../utils/create-eslint-rule';
 import { getOriginalAttributeName } from '../utils/get-original-attribute-name';
 
 type Options = [

diff --git a/packages/eslint-plugin-template/src/rules/no-inline-styles.ts b/packages/eslint-plugin-template/src/rules/no-inline-styles.ts
@@ -2,10 +2,8 @@ import type {
   ParseSourceSpan,
   TmplAstElement,
 } from '@angular-eslint/bundled-angular-compiler';
-import {
-  createESLintRule,
-  getTemplateParserServices,
-} from '../utils/create-eslint-rule';
+import { getTemplateParserServices } from '@angular-eslint/utils';
+import { createESLintRule } from '../utils/create-eslint-rule';
 
 type Options = [
   {

diff --git a/packages/eslint-plugin-template/src/rules/no-negated-async.ts b/packages/eslint-plugin-template/src/rules/no-negated-async.ts
@@ -2,10 +2,8 @@ import type {
   BindingPipe,
   PrefixNot,
 } from '@angular-eslint/bundled-angular-compiler';
-import {
-  createESLintRule,
-  ensureTemplateParser,
-} from '../utils/create-eslint-rule';
+import { ensureTemplateParser } from '@angular-eslint/utils';
+import { createESLintRule } from '../utils/create-eslint-rule';
 
 type Options = [];
 export type MessageIds =

diff --git a/packages/eslint-plugin-template/src/rules/no-positive-tabindex.ts b/packages/eslint-plugin-template/src/rules/no-positive-tabindex.ts
@@ -3,10 +3,8 @@ import type {
   TmplAstBoundAttribute,
   TmplAstTextAttribute,
 } from '@angular-eslint/bundled-angular-compiler';
-import {
-  createESLintRule,
-  getTemplateParserServices,
-} from '../utils/create-eslint-rule';
+import { getTemplateParserServices } from '@angular-eslint/utils';
+import { createESLintRule } from '../utils/create-eslint-rule';
 import { getDomElements } from '../utils/get-dom-elements';
 import { toPattern } from '../utils/to-pattern';
 

diff --git a/packages/eslint-plugin-template/src/rules/use-track-by-function.ts b/packages/eslint-plugin-template/src/rules/use-track-by-function.ts
@@ -3,10 +3,8 @@ import type {
   TmplAstTextAttribute,
 } from '@angular-eslint/bundled-angular-compiler';
 import { TmplAstBoundAttribute } from '@angular-eslint/bundled-angular-compiler';
-import {
-  createESLintRule,
-  getTemplateParserServices,
-} from '../utils/create-eslint-rule';
+import { getTemplateParserServices } from '@angular-eslint/utils';
+import { createESLintRule } from '../utils/create-eslint-rule';
 
 type Options = [];
 export type MessageIds = 'useTrackByFunction';

diff --git a/packages/eslint-plugin-template/src/utils/create-eslint-rule.ts b/packages/eslint-plugin-template/src/utils/create-eslint-rule.ts
@@ -1,8 +1,3 @@
-import type {
-  ParseSourceSpan,
-  TmplAstElement,
-} from '@angular-eslint/bundled-angular-compiler';
-import type { TSESLint, TSESTree } from '@typescript-eslint/utils';
 import { ESLintUtils } from '@typescript-eslint/utils';
 
 /**
@@ -35,43 +30,3 @@ export const createESLintRule = patchedRuleCreator(
   (ruleName) =>
     `https://github.com/angular-eslint/angular-eslint/blob/main/packages/eslint-plugin-template/docs/rules/${ruleName}.md`,
 );
-
-interface ParserServices {
-  convertNodeSourceSpanToLoc: (
-    sourceSpan: ParseSourceSpan,
-  ) => TSESTree.SourceLocation;
-  convertElementSourceSpanToLoc: (
-    context: Readonly<TSESLint.RuleContext<string, readonly unknown[]>>,
-    node: TmplAstElement,
-  ) => TSESTree.SourceLocation;
-}
-
-export function getTemplateParserServices(
-  context: Readonly<TSESLint.RuleContext<string, readonly unknown[]>>,
-): ParserServices {
-  ensureTemplateParser(context);
-  return context.parserServices as unknown as ParserServices;
-}
-
-/**
- * Utility for rule authors to ensure that their rule is correctly being used with @angular-eslint/template-parser
- * If @angular-eslint/template-parser is not the configured parser when the function is invoked it will throw
- */
-export function ensureTemplateParser(
-  context: Readonly<TSESLint.RuleContext<string, readonly unknown[]>>,
-): void {
-  if (
-    !(context.parserServices as unknown as ParserServices)
-      ?.convertNodeSourceSpanToLoc ||
-    !(context.parserServices as unknown as ParserServices)
-      ?.convertElementSourceSpanToLoc
-  ) {
-    /**
-     * The user needs to have configured "parser" in their eslint config and set it
-     * to @angular-eslint/template-parser
-     */
-    throw new Error(
-      "You have used a rule which requires '@angular-eslint/template-parser' to be used as the 'parser' in your ESLint config.",
-    );
-  }
-}