feat(eslint-plugin-template): export template parser services

[reduckted]

Fixes #888

This exports the TemplateParserServices type (previously called ParserServices in the eslint-plugin-template package), and the getTemplateParserServices and ensureTemplateParser functions.

You should now be able to create a template-based rule like this:

import type { TemplateParserServices } from '@angular-eslint/utils';
import { getTemplateParserServices } from '@angular-eslint/utils';
import type { TmplAstBoundAttribute } from '@angular/compiler';
import { ESLintUtils } from '@typescript-eslint/utils';

const rule = ESLintUtils.RuleCreator.withoutDocs({
  meta: {
    type: 'problem',
    messages: { foo: 'bar' },
    schema: {},
  },
  defaultOptions: [],
  create: (context) => {
    const parser: TemplateParserServices = getTemplateParserServices(context);

    return {
      BoundProperty: (node: TmplAstBoundAttribute) => {
        context.report({
          messageId: 'foo',
          loc: parser.convertNodeSourceSpanToLoc(node.sourceSpan),
        });
      },
    };
  },
});

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit f147361. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

---

✅ Successfully ran 7 targets

• Node v16.18.1 - nx run-many --target=integration-test --all --withRegistry
• Node v16.18.1 - nx run-many --target=test --all --parallel --codeCoverage
• Node v16.18.1 - nx run-many --target=typecheck --all --parallel
• Node v16.18.1 - nx run-many --target=build --all --parallel
• Node v14.21.1 - nx run-many --target=test --all --parallel
• Node v16.18.1 - nx run-many --target=check-rule-docs --all --parallel
• Node v14.21.1 - nx run-many --target=build --all --parallel

---

Sent with 💌 from NxCloud.

[JamesHenry]

Thanks a lot @reduckted!

Please regorganize things so that anything which is exported to end users comes from the utils package, as that is more of a natural fit.

Until now the convention has been that anything within the utils folder within a plugin is private to that plugin, anything within @angular-eslint/utils could potentially be exported

[reduckted]

No problem. That makes perfect sense. 👍

[JamesHenry]

@reduckted Do you think you can update it today? If so we can merge it and release it as a final v14, otherwise I'm afraid it will be in the first minor of v15

[reduckted]

Yes, I've actually just pushed up the changes (hopefully everything is in the correct place now).

I've reverted the change to export the createESLintRule function, because I don't believe that function needed to be exported to create template rules (the @angular-eslint/eslint-plugin has a similar function that is private).

[JamesHenry]

@reduckted please update your example to match the new expectations (for posterity)

[JamesHenry]

@reduckted just FYI I decided to go for TemplateParserServices for maximum clarity (I also updated it in your example).

Many thanks again!

[codecov]

Codecov Report

Merging #1211 (f147361) into main (0273649) will increase coverage by 0.16%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main    #1211      +/-   ##
==========================================
+ Coverage   88.16%   88.33%   +0.16%     
==========================================
  Files         161      161              
  Lines        3093     3112      +19     
  Branches      500      498       -2     
==========================================
+ Hits         2727     2749      +22     
+ Misses        253      252       -1     
+ Partials      113      111       -2     

Flag	Coverage Δ
unittest	88.33% <100.00%> (+0.16%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
...lint-plugin-template/src/rules/attributes-order.ts	100.00% <ø> (ø)
...lugin-template/src/rules/conditional-complexity.ts	100.00% <ø> (ø)
packages/eslint-plugin-template/src/rules/i18n.ts	94.00% <ø> (+0.06%)	⬆️
...nt-plugin-template/src/utils/create-eslint-rule.ts	100.00% <ø> (+17.64%)	⬆️
...lugin-template/src/rules/accessibility-alt-text.ts	92.30% <100.00%> (+0.15%)	⬆️
...mplate/src/rules/accessibility-elements-content.ts	95.65% <100.00%> (+0.19%)	⬆️
.../rules/accessibility-interactive-supports-focus.ts	92.00% <100.00%> (+0.33%)	⬆️
...ugin-template/src/rules/accessibility-label-for.ts	88.88% <100.00%> (+0.42%)	⬆️
...ules/accessibility-label-has-associated-control.ts	82.75% <100.00%> (+0.61%)	⬆️
.../src/rules/accessibility-role-has-required-aria.ts	90.00% <100.00%> (+0.34%)	⬆️
... and 44 more