@angular-eslint/test-utils 18.1.1-alpha.5 → 18.1.1-alpha.7

package/dist/convert-annotated-source-to-failure-case.d.ts

@@ -1,4 +1,4 @@
-import type { TSESLint } from '@typescript-eslint/utils';
+import type { InvalidTestCase, SuggestionOutput } from '@typescript-eslint/rule-tester';
 /**
  * When leveraging the convertAnnotatedSourceToFailureCase() utility, the
  * following characters are eligible to be used in the source code of expected
@@ -9,15 +9,15 @@ import type { TSESLint } from '@typescript-eslint/utils';
  * See the convertAnnotatedSourceToFailureCase() utility itself for more details.
  */
 export declare const SPECIAL_UNDERLINE_CHARS: readonly ["~", "^", "#", "%", "¶", "*", "¨", "@"];
-type MultipleErrorOptions<TMessageIds extends string> = BaseErrorOptions & {
+type MultipleErrorOptions<TMessageIds extends string, Options extends readonly unknown[]> = BaseErrorOptions<Options> & {
     readonly messages: readonly (Message<TMessageIds> & {
         readonly char: (typeof SPECIAL_UNDERLINE_CHARS)[number];
     })[];
 };
-type BaseErrorOptions = {
+type BaseErrorOptions<Options> = {
     readonly description: string;
     readonly annotatedSource: string;
-    readonly options?: readonly unknown[];
+    readonly options?: Options;
     readonly annotatedOutput?: string;
     readonly annotatedOutputs?: readonly string[];
     readonly filename?: string;
@@ -26,9 +26,9 @@ type BaseErrorOptions = {
 type Message<TMessageIds extends string> = {
     readonly messageId: TMessageIds;
     readonly data?: Record<string, unknown>;
-    readonly suggestions?: TSESLint.SuggestionOutput<TMessageIds>[];
+    readonly suggestions?: SuggestionOutput<TMessageIds>[];
 };
-type SingleErrorOptions<TMessageIds extends string> = BaseErrorOptions & Message<TMessageIds>;
+type SingleErrorOptions<TMessageIds extends string, Options extends readonly unknown[]> = BaseErrorOptions<Options> & Message<TMessageIds>;
 /**
  * convertAnnotatedSourceToFailureCase() provides an ergonomic way to easily write
  * expected failure cases for ESLint rules by allowing you to directly annotate the
@@ -56,7 +56,7 @@ type SingleErrorOptions<TMessageIds extends string> = BaseErrorOptions & Message
  *  }),
  * ```
  */
-export declare function convertAnnotatedSourceToFailureCase<TMessageIds extends string>(errorOptions: SingleErrorOptions<TMessageIds>): TSESLint.InvalidTestCase<TMessageIds, readonly unknown[]>;
-export declare function convertAnnotatedSourceToFailureCase<TMessageIds extends string>(errorOptions: MultipleErrorOptions<TMessageIds>): TSESLint.InvalidTestCase<TMessageIds, readonly unknown[]>;
+export declare function convertAnnotatedSourceToFailureCase<TMessageIds extends string, Options extends readonly unknown[]>(errorOptions: SingleErrorOptions<TMessageIds, Options>): InvalidTestCase<TMessageIds, Options>;
+export declare function convertAnnotatedSourceToFailureCase<TMessageIds extends string, Options extends readonly unknown[]>(errorOptions: MultipleErrorOptions<TMessageIds, Options>): InvalidTestCase<TMessageIds, Options>;
 export {};
 //# sourceMappingURL=convert-annotated-source-to-failure-case.d.ts.map

package/dist/convert-annotated-source-to-failure-case.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"convert-annotated-source-to-failure-case.d.ts","sourceRoot":"","sources":["../src/convert-annotated-source-to-failure-case.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAEzD;;;;;;;;GAQG;AACH,eAAO,MAAM,uBAAuB,mDAS1B,CAAC;AAEX,KAAK,oBAAoB,CAAC,WAAW,SAAS,MAAM,IAAI,gBAAgB,GAAG;IACzE,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG;QAClD,QAAQ,CAAC,IAAI,EAAE,CAAC,OAAO,uBAAuB,CAAC,CAAC,MAAM,CAAC,CAAC;KACzD,CAAC,EAAE,CAAC;CACN,CAAC;AAEF,KAAK,gBAAgB,GAAG;IACtB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,OAAO,EAAE,CAAC;IACtC,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;IAClC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC9C,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;CACzB,CAAC;AAEF,KAAK,OAAO,CAAC,WAAW,SAAS,MAAM,IAAI;IACzC,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC;IAChC,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACxC,QAAQ,CAAC,WAAW,CAAC,EAAE,QAAQ,CAAC,gBAAgB,CAAC,WAAW,CAAC,EAAE,CAAC;CACjE,CAAC;AAEF,KAAK,kBAAkB,CAAC,WAAW,SAAS,MAAM,IAAI,gBAAgB,GACpE,OAAO,CAAC,WAAW,CAAC,CAAC;AAEvB;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,mCAAmC,CAAC,WAAW,SAAS,MAAM,EAC5E,YAAY,EAAE,kBAAkB,CAAC,WAAW,CAAC,GAC5C,QAAQ,CAAC,eAAe,CAAC,WAAW,EAAE,SAAS,OAAO,EAAE,CAAC,CAAC;AAC7D,wBAAgB,mCAAmC,CAAC,WAAW,SAAS,MAAM,EAC5E,YAAY,EAAE,oBAAoB,CAAC,WAAW,CAAC,GAC9C,QAAQ,CAAC,eAAe,CAAC,WAAW,EAAE,SAAS,OAAO,EAAE,CAAC,CAAC"}
+{"version":3,"file":"convert-annotated-source-to-failure-case.d.ts","sourceRoot":"","sources":["../src/convert-annotated-source-to-failure-case.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,eAAe,EACf,gBAAgB,EAEjB,MAAM,gCAAgC,CAAC;AAExC;;;;;;;;GAQG;AACH,eAAO,MAAM,uBAAuB,mDAS1B,CAAC;AAEX,KAAK,oBAAoB,CACvB,WAAW,SAAS,MAAM,EAC1B,OAAO,SAAS,SAAS,OAAO,EAAE,IAChC,gBAAgB,CAAC,OAAO,CAAC,GAAG;IAC9B,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG;QAClD,QAAQ,CAAC,IAAI,EAAE,CAAC,OAAO,uBAAuB,CAAC,CAAC,MAAM,CAAC,CAAC;KACzD,CAAC,EAAE,CAAC;CACN,CAAC;AAEF,KAAK,gBAAgB,CAAC,OAAO,IAAI;IAC/B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;IAClC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC9C,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;CACzB,CAAC;AAEF,KAAK,OAAO,CAAC,WAAW,SAAS,MAAM,IAAI;IACzC,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC;IAChC,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACxC,QAAQ,CAAC,WAAW,CAAC,EAAE,gBAAgB,CAAC,WAAW,CAAC,EAAE,CAAC;CACxD,CAAC;AAEF,KAAK,kBAAkB,CACrB,WAAW,SAAS,MAAM,EAC1B,OAAO,SAAS,SAAS,OAAO,EAAE,IAChC,gBAAgB,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;AAErD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,mCAAmC,CACjD,WAAW,SAAS,MAAM,EAC1B,OAAO,SAAS,SAAS,OAAO,EAAE,EAElC,YAAY,EAAE,kBAAkB,CAAC,WAAW,EAAE,OAAO,CAAC,GACrD,eAAe,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;AACzC,wBAAgB,mCAAmC,CACjD,WAAW,SAAS,MAAM,EAC1B,OAAO,SAAS,SAAS,OAAO,EAAE,EAElC,YAAY,EAAE,oBAAoB,CAAC,WAAW,EAAE,OAAO,CAAC,GACvD,eAAe,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC"}

package/dist/rule-tester.d.ts

@@ -1,13 +1,9 @@
+import type { RunTests, RuleTesterConfig } from '@typescript-eslint/rule-tester';
 import { RuleTester as TSESLintRuleTester } from '@typescript-eslint/rule-tester';
 import type { TSESLint } from '@typescript-eslint/utils';
-declare const VALID_PARSERS: readonly ["@angular-eslint/template-parser", "@typescript-eslint/parser"];
-type RuleTesterConfig = Omit<TSESLint.RuleTesterConfig, 'parser'> & {
-    parser: (typeof VALID_PARSERS)[number];
-};
 export declare class RuleTester extends TSESLintRuleTester {
     private filename?;
-    constructor(options: RuleTesterConfig);
-    run<TMessageIds extends string, TOptions extends readonly unknown[]>(name: string, rule: TSESLint.RuleModule<TMessageIds, TOptions>, { valid, invalid }: TSESLint.RunTests<TMessageIds, TOptions>): void;
+    constructor(options?: RuleTesterConfig);
+    run<MessageIds extends string, Options extends readonly unknown[]>(ruleName: string, rule: TSESLint.RuleModule<MessageIds, Options>, { valid, invalid }: RunTests<MessageIds, Options>): void;
 }
-export {};
 //# sourceMappingURL=rule-tester.d.ts.map

package/dist/rule-tester.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rule-tester.d.ts","sourceRoot":"","sources":["../src/rule-tester.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,IAAI,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAClF,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAGzD,QAAA,MAAM,aAAa,2EAGT,CAAC;AAEX,KAAK,gBAAgB,GAAG,IAAI,CAAC,QAAQ,CAAC,gBAAgB,EAAE,QAAQ,CAAC,GAAG;IAClE,MAAM,EAAE,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC;CACxC,CAAC;AAYF,qBAAa,UAAW,SAAQ,kBAAkB;IAChD,OAAO,CAAC,QAAQ,CAAC,CAAc;gBAKnB,OAAO,EAAE,gBAAgB;IA+B5B,GAAG,CAAC,WAAW,SAAS,MAAM,EAAE,QAAQ,SAAS,SAAS,OAAO,EAAE,EAC1E,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,QAAQ,CAAC,UAAU,CAAC,WAAW,EAAE,QAAQ,CAAC,EAChD,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,QAAQ,CAAC,QAAQ,CAAC,WAAW,EAAE,QAAQ,CAAC,GAC3D,IAAI;CA0BR"}
+{"version":3,"file":"rule-tester.d.ts","sourceRoot":"","sources":["../src/rule-tester.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,QAAQ,EACR,gBAAgB,EACjB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,UAAU,IAAI,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAClF,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAwBzD,qBAAa,UAAW,SAAQ,kBAAkB;IAChD,OAAO,CAAC,QAAQ,CAAC,CAAc;gBAEnB,OAAO,CAAC,EAAE,gBAAgB;IAY7B,GAAG,CAAC,UAAU,SAAS,MAAM,EAAE,OAAO,SAAS,SAAS,OAAO,EAAE,EACxE,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,QAAQ,CAAC,UAAU,CAAC,UAAU,EAAE,OAAO,CAAC,EAC9C,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC,GAChD,IAAI;CAiCR"}

package/dist/rule-tester.js

@@ -34,44 +34,30 @@ function getFixturesRootDir() {
     return path.join(process.cwd(), 'tests/fixtures/');
 }
 function isValidParser(parser) {
-    return VALID_PARSERS.includes(parser);
+    if (parser === require('@angular-eslint/template-parser')) {
+        return true;
+    }
+    if (parser === require('@typescript-eslint/parser')) {
+        return true;
+    }
+    return false;
 }
 class RuleTester extends rule_tester_1.RuleTester {
     filename = '';
-    // as of eslint 6 you have to provide an absolute path to the parser
-    // but that's not as clean to type, this saves us trying to manually enforce
-    // that contributors require.resolve everything
     constructor(options) {
-        super({
-            ...options,
-            parser: require.resolve(options.parser),
-        });
-        if (options.parserOptions?.project) {
-            this.filename = path.join(options.parserOptions?.tsconfigRootDir ?? getFixturesRootDir(), 'file.ts');
+        super(options);
+        if (options?.languageOptions?.parserOptions?.project) {
+            this.filename = path.join(options?.languageOptions.parserOptions.tsconfigRootDir ??
+                getFixturesRootDir(), 'file.ts');
         }
-        // make sure that the parser doesn't hold onto file handles between tests
-        // on linux (i.e. our CI env), there can be very a limited number of watch handles available
-        const afterAll = RuleTester.afterAll ?? globalThis.afterAll;
-        afterAll(() => {
-            try {
-                // instead of creating a hard dependency, just use a soft require
-                // a bit weird, but if they're using this tooling, it'll be installed
-                // eslint-disable-next-line @typescript-eslint/no-var-requires
-                require(options.parser).clearCaches();
-            }
-            catch {
-                // ignored
-            }
-        });
     }
-    // as of eslint 6 you have to provide an absolute path to the parser
-    // If you don't do that at the test level, the test will fail somewhat cryptically...
-    // This is a lot more explicit
-    run(name, rule, { valid, invalid }) {
+    run(ruleName, rule, { valid, invalid }) {
         const errorMessage = `Do not set the parser at the test level unless you want to use a parser other than ${VALID_PARSERS.join(', ')}`;
         const parsedTests = {
             valid: valid.map((test) => {
-                if (typeof test !== 'string' && isValidParser(test.parser)) {
+                if (typeof test !== 'string' &&
+                    test.languageOptions?.parser &&
+                    !isValidParser(test.languageOptions.parser)) {
                     throw Error(errorMessage);
                 }
                 return typeof test === 'string'
@@ -79,7 +65,8 @@ class RuleTester extends rule_tester_1.RuleTester {
                     : { ...test, filename: test.filename ?? this.filename };
             }),
             invalid: invalid.map((test) => {
-                if (isValidParser(test.parser)) {
+                if (test.languageOptions?.parser &&
+                    !isValidParser(test.languageOptions.parser)) {
                     throw Error(errorMessage);
                 }
                 return {
@@ -88,7 +75,7 @@ class RuleTester extends rule_tester_1.RuleTester {
                 };
             }),
         };
-        super.run(name, rule, parsedTests);
+        super.run(ruleName, rule, parsedTests);
     }
 }
 exports.RuleTester = RuleTester;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@angular-eslint/test-utils",
-  "version": "18.1.1-alpha.5",
+  "version": "18.1.1-alpha.7",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -17,8 +17,8 @@
     "LICENSE"
   ],
   "peerDependencies": {
-    "@typescript-eslint/rule-tester": "^7.11.0 || ^8.0.0-alpha.37",
-    "@typescript-eslint/utils": "^7.11.0 || ^8.0.0-alpha.37",
+    "@typescript-eslint/rule-tester": "^7.11.0 || ^8.0.0",
+    "@typescript-eslint/utils": "^7.11.0 || ^8.0.0",
     "eslint": "^8.57.0 || ^9.0.0",
     "typescript": "*"
   },