@typescript-eslint/rule-tester 6.3.1-alpha.7 → 6.3.1-alpha.9

package/_ts4.2/dist/RuleTester.d.ts

@@ -0,0 +1,46 @@
+import type { AnyRuleCreateFunction, AnyRuleModule, RuleModule } from '@typescript-eslint/utils/ts-eslint';
+import { TestFramework } from './TestFramework';
+import type { InvalidTestCase, RuleTesterConfig, RunTests, ValidTestCase } from './types';
+export declare class RuleTester extends TestFramework {
+    #private;
+    /**
+     * Creates a new instance of RuleTester.
+     */
+    constructor(testerConfig?: RuleTesterConfig);
+    /**
+     * Set the configuration to use for all future tests
+     */
+    static setDefaultConfig(config: RuleTesterConfig): void;
+    /**
+     * Get the current configuration used for all tests
+     */
+    static getDefaultConfig(): Readonly<RuleTesterConfig>;
+    /**
+     * Reset the configuration to the initial configuration of the tester removing
+     * any changes made until now.
+     */
+    static resetDefaultConfig(): void;
+    /**
+     * Adds the `only` property to a test to run it in isolation.
+     */
+    static only<TOptions extends Readonly<unknown[]>>(item: ValidTestCase<TOptions> | string): ValidTestCase<TOptions>;
+    /**
+     * Adds the `only` property to a test to run it in isolation.
+     */
+    static only<TMessageIds extends string, TOptions extends Readonly<unknown[]>>(item: InvalidTestCase<TMessageIds, TOptions>): InvalidTestCase<TMessageIds, TOptions>;
+    /**
+     * Define a rule for one particular run of tests.
+     */
+    defineRule(name: string, rule: AnyRuleCreateFunction | AnyRuleModule): void;
+    /**
+     * Adds a new rule test to execute.
+     */
+    run<TMessageIds extends string, TOptions extends readonly unknown[]>(ruleName: string, rule: RuleModule<TMessageIds, TOptions>, test: RunTests<TMessageIds, TOptions>): void;
+    /**
+     * Run the rule for the given item
+     * @throws {Error} If an invalid schema.
+     * Use @private instead of #private to expose it for testing purposes
+     */
+    private runRuleForItem;
+}
+//# sourceMappingURL=RuleTester.d.ts.map

package/_ts4.2/dist/TestFramework.d.ts

@@ -0,0 +1,66 @@
+/**
+ * @param text a string describing the rule
+ * @param callback the test callback
+ */
+export type RuleTesterTestFrameworkFunctionBase = (text: string, callback: () => void) => void;
+export type RuleTesterTestFrameworkFunction = RuleTesterTestFrameworkFunctionBase & {
+    /**
+     * Skips running the tests inside this `describe` for the current file
+     */
+    skip?: RuleTesterTestFrameworkFunctionBase;
+};
+export type RuleTesterTestFrameworkItFunction = RuleTesterTestFrameworkFunctionBase & {
+    /**
+     * Only runs this test in the current file.
+     */
+    only?: RuleTesterTestFrameworkFunctionBase;
+    /**
+     * Skips running this test in the current file.
+     */
+    skip?: RuleTesterTestFrameworkFunctionBase;
+};
+type Maybe<T> = T | null | undefined;
+/**
+ * @param fn a callback called after all the tests are done
+ */
+type AfterAll = (fn: () => void) => void;
+/**
+ * Defines a test framework used by the rule tester
+ * This class defaults to using functions defined on the global scope, but also
+ * allows the user to manually supply functions in case they want to roll their
+ * own tooling
+ */
+export declare abstract class TestFramework {
+    /**
+     * Runs a function after all the tests in this file have completed.
+     */
+    static get afterAll(): AfterAll;
+    static set afterAll(value: Maybe<AfterAll>);
+    /**
+     * Creates a test grouping
+     */
+    static get describe(): RuleTesterTestFrameworkFunction;
+    static set describe(value: Maybe<RuleTesterTestFrameworkFunction>);
+    /**
+     * Skips running the tests inside this `describe` for the current file
+     */
+    static get describeSkip(): RuleTesterTestFrameworkFunctionBase;
+    static set describeSkip(value: Maybe<RuleTesterTestFrameworkFunctionBase>);
+    /**
+     * Creates a test closure
+     */
+    static get it(): RuleTesterTestFrameworkItFunction;
+    static set it(value: Maybe<RuleTesterTestFrameworkItFunction>);
+    /**
+     * Only runs this test in the current file.
+     */
+    static get itOnly(): RuleTesterTestFrameworkFunctionBase;
+    static set itOnly(value: Maybe<RuleTesterTestFrameworkFunctionBase>);
+    /**
+     * Skips running this test in the current file.
+     */
+    static get itSkip(): RuleTesterTestFrameworkFunctionBase;
+    static set itSkip(value: Maybe<RuleTesterTestFrameworkFunctionBase>);
+}
+export {};
+//# sourceMappingURL=TestFramework.d.ts.map

package/_ts4.2/dist/index.d.ts

@@ -0,0 +1,5 @@
+export { RuleTester } from './RuleTester';
+export { noFormat } from './noFormat';
+export type { InvalidTestCase, RuleTesterConfig, RunTests, SuggestionOutput, TestCaseError, ValidTestCase, } from './types';
+export type { AtLeastVersionConstraint, DependencyConstraint, SemverVersionConstraint, VersionConstraint, } from './types/DependencyConstraint';
+//# sourceMappingURL=index.d.ts.map

package/_ts4.2/dist/noFormat.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Simple no-op tag to mark code samples as "should not format with prettier"
+ *   for the plugin-test-formatting lint rule
+ */
+export declare function noFormat(raw: TemplateStringsArray, ...keys: string[]): string;
+//# sourceMappingURL=noFormat.d.ts.map

package/_ts4.2/dist/types/DependencyConstraint.d.ts

@@ -0,0 +1,12 @@
+import type { RangeOptions } from 'semver';
+export interface SemverVersionConstraint {
+    readonly range: string;
+    readonly options?: RangeOptions | boolean;
+}
+export type AtLeastVersionConstraint = `${number}.${number}.${number}-${string}` | `${number}.${number}.${number}` | `${number}.${number}` | `${number}`;
+export type VersionConstraint = AtLeastVersionConstraint | SemverVersionConstraint;
+/**
+ * Passing a string for the value is shorthand for a '>=' constraint
+ */
+export type DependencyConstraint = Readonly<Record<string, VersionConstraint>>;
+//# sourceMappingURL=DependencyConstraint.d.ts.map

package/_ts4.2/dist/types/InvalidTestCase.d.ts

@@ -0,0 +1,68 @@
+import type { AST_NODE_TYPES, AST_TOKEN_TYPES } from '@typescript-eslint/utils';
+import type { ReportDescriptorMessageData } from '@typescript-eslint/utils/ts-eslint';
+import type { DependencyConstraint } from './DependencyConstraint';
+import type { ValidTestCase } from './ValidTestCase';
+export interface SuggestionOutput<TMessageIds extends string> {
+    /**
+     * Reported message ID.
+     */
+    readonly messageId: TMessageIds;
+    /**
+     * The data used to fill the message template.
+     */
+    readonly data?: ReportDescriptorMessageData;
+    /**
+     * NOTE: Suggestions will be applied as a stand-alone change, without triggering multi-pass fixes.
+     * Each individual error has its own suggestion, so you have to show the correct, _isolated_ output for each suggestion.
+     */
+    readonly output: string;
+}
+export interface TestCaseError<TMessageIds extends string> {
+    /**
+     * The 1-based column number of the reported start location.
+     */
+    readonly column?: number;
+    /**
+     * The data used to fill the message template.
+     */
+    readonly data?: ReportDescriptorMessageData;
+    /**
+     * The 1-based column number of the reported end location.
+     */
+    readonly endColumn?: number;
+    /**
+     * The 1-based line number of the reported end location.
+     */
+    readonly endLine?: number;
+    /**
+     * The 1-based line number of the reported start location.
+     */
+    readonly line?: number;
+    /**
+     * Reported message ID.
+     */
+    readonly messageId: TMessageIds;
+    /**
+     * Reported suggestions.
+     */
+    readonly suggestions?: readonly SuggestionOutput<TMessageIds>[] | null;
+    /**
+     * The type of the reported AST node.
+     */
+    readonly type?: AST_NODE_TYPES | AST_TOKEN_TYPES;
+}
+export interface InvalidTestCase<TMessageIds extends string, TOptions extends Readonly<unknown[]>> extends ValidTestCase<TOptions> {
+    /**
+     * Expected errors.
+     */
+    readonly errors: readonly TestCaseError<TMessageIds>[];
+    /**
+     * The expected code after autofixes are applied. If set to `null`, the test runner will assert that no autofix is suggested.
+     */
+    readonly output?: string | null;
+    /**
+     * Constraints that must pass in the current environment for the test to run
+     */
+    readonly dependencyConstraints?: DependencyConstraint;
+}
+//# sourceMappingURL=InvalidTestCase.d.ts.map

package/_ts4.2/dist/types/RuleTesterConfig.d.ts

@@ -0,0 +1,26 @@
+import type { Linter, ParserOptions } from '@typescript-eslint/utils/ts-eslint';
+import type { DependencyConstraint } from './DependencyConstraint';
+export interface RuleTesterConfig extends Linter.Config {
+    /**
+     * The default parser to use for tests.
+     * @default '@typescript-eslint/parser'
+     */
+    readonly parser: string;
+    /**
+     * The default parser options to use for tests.
+     */
+    readonly parserOptions?: Readonly<ParserOptions>;
+    /**
+     * Constraints that must pass in the current environment for any tests to run.
+     */
+    readonly dependencyConstraints?: DependencyConstraint;
+    /**
+     * The default filenames to use for type-aware tests.
+     * @default { ts: 'file.ts', tsx: 'react.tsx' }
+     */
+    readonly defaultFilenames?: Readonly<{
+        ts: string;
+        tsx: string;
+    }>;
+}
+//# sourceMappingURL=RuleTesterConfig.d.ts.map

package/_ts4.2/dist/types/ValidTestCase.d.ts

@@ -0,0 +1,53 @@
+import type { ParserOptions, SharedConfigurationSettings } from '@typescript-eslint/utils/ts-eslint';
+import type { DependencyConstraint } from './DependencyConstraint';
+export interface ValidTestCase<TOptions extends Readonly<unknown[]>> {
+    /**
+     * Name for the test case.
+     */
+    readonly name?: string;
+    /**
+     * Code for the test case.
+     */
+    readonly code: string;
+    /**
+     * Environments for the test case.
+     */
+    readonly env?: Readonly<Record<string, boolean>>;
+    /**
+     * The fake filename for the test case. Useful for rules that make assertion about filenames.
+     */
+    readonly filename?: string;
+    /**
+     * The additional global variables.
+     */
+    readonly globals?: Record<string, 'off' | 'readonly' | 'writable' | true>;
+    /**
+     * Options for the test case.
+     */
+    readonly options?: Readonly<TOptions>;
+    /**
+     * The absolute path for the parser.
+     */
+    readonly parser?: string;
+    /**
+     * Options for the parser.
+     */
+    readonly parserOptions?: Readonly<ParserOptions>;
+    /**
+     * Settings for the test case.
+     */
+    readonly settings?: Readonly<SharedConfigurationSettings>;
+    /**
+     * Run this case exclusively for debugging in supported test frameworks.
+     */
+    readonly only?: boolean;
+    /**
+     * Skip this case in supported test frameworks.
+     */
+    readonly skip?: boolean;
+    /**
+     * Constraints that must pass in the current environment for the test to run
+     */
+    readonly dependencyConstraints?: DependencyConstraint;
+}
+//# sourceMappingURL=ValidTestCase.d.ts.map

package/_ts4.2/dist/types/index.d.ts

@@ -0,0 +1,19 @@
+import type { InvalidTestCase } from './InvalidTestCase';
+import type { RuleTesterConfig } from './RuleTesterConfig';
+import type { ValidTestCase } from './ValidTestCase';
+type Mutable<T> = {
+    -readonly [P in keyof T]: T[P];
+};
+export type TesterConfigWithDefaults = Mutable<Required<Pick<RuleTesterConfig, 'defaultFilenames' | 'parser' | 'rules'>> & RuleTesterConfig>;
+export interface RunTests<TMessageIds extends string, TOptions extends Readonly<unknown[]>> {
+    readonly valid: readonly (ValidTestCase<TOptions> | string)[];
+    readonly invalid: readonly InvalidTestCase<TMessageIds, TOptions>[];
+}
+export interface NormalizedRunTests<TMessageIds extends string, TOptions extends Readonly<unknown[]>> {
+    readonly valid: readonly ValidTestCase<TOptions>[];
+    readonly invalid: readonly InvalidTestCase<TMessageIds, TOptions>[];
+}
+export type { ValidTestCase } from './ValidTestCase';
+export type { InvalidTestCase, SuggestionOutput, TestCaseError, } from './InvalidTestCase';
+export type { RuleTesterConfig } from './RuleTesterConfig';
+//# sourceMappingURL=index.d.ts.map

package/_ts4.2/dist/utils/SourceCodeFixer.d.ts

@@ -0,0 +1,16 @@
+import type { Linter } from '@typescript-eslint/utils/ts-eslint';
+type LintMessage = Linter.LintMessage | Linter.LintSuggestion;
+/**
+ * Applies the fixes specified by the messages to the given text. Tries to be
+ * smart about the fixes and won't apply fixes over the same area in the text.
+ * @param sourceText The text to apply the changes to.
+ * @param  messages The array of messages reported by ESLint.
+ * @returns {Object} An object containing the fixed text and any unfixed messages.
+ */
+export declare function applyFixes(sourceText: string, messages: readonly LintMessage[]): {
+    fixed: boolean;
+    messages: readonly LintMessage[];
+    output: string;
+};
+export {};
+//# sourceMappingURL=SourceCodeFixer.d.ts.map

package/_ts4.2/dist/utils/ajv.d.ts

@@ -0,0 +1,3 @@
+import Ajv from 'ajv';
+export declare function ajvBuilder(additionalOptions?: {}): Ajv.Ajv;
+//# sourceMappingURL=ajv.d.ts.map

package/_ts4.2/dist/utils/cloneDeeplyExcludesParent.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Clones a given value deeply.
+ * Note: This ignores `parent` property.
+ */
+export declare function cloneDeeplyExcludesParent<T>(x: T): T;
+//# sourceMappingURL=cloneDeeplyExcludesParent.d.ts.map

package/_ts4.2/dist/utils/config-schema.d.ts

@@ -0,0 +1,3 @@
+import type { JSONSchema4 } from '@typescript-eslint/utils/json-schema';
+export declare const configSchema: JSONSchema4;
+//# sourceMappingURL=config-schema.d.ts.map

package/_ts4.2/dist/utils/config-validator.d.ts

@@ -0,0 +1,12 @@
+import type { AnyRuleModule } from '@typescript-eslint/utils/ts-eslint';
+import type { TesterConfigWithDefaults } from '../types';
+type GetAdditionalRule = (ruleId: string) => AnyRuleModule | null;
+/**
+ * Validates an entire config object.
+ * @param config The config object to validate.
+ * @param source The name of the configuration source to report in any errors.
+ * @param getAdditionalRule A map from strings to loaded rules.
+ */
+export declare function validate(config: TesterConfigWithDefaults, source: string, getAdditionalRule: GetAdditionalRule): void;
+export {};
+//# sourceMappingURL=config-validator.d.ts.map

package/_ts4.2/dist/utils/dependencyConstraints.d.ts

@@ -0,0 +1,3 @@
+import type { DependencyConstraint } from '../types/DependencyConstraint';
+export declare function satisfiesAllDependencyConstraints(dependencyConstraints: DependencyConstraint | undefined): boolean;
+//# sourceMappingURL=dependencyConstraints.d.ts.map

package/_ts4.2/dist/utils/deprecation-warnings.d.ts

@@ -0,0 +1,13 @@
+declare const deprecationWarningMessages: {
+    readonly ESLINT_LEGACY_ECMAFEATURES: "The 'ecmaFeatures' config file property is deprecated and has no effect.";
+};
+/**
+ * Emits a deprecation warning containing a given filepath. A new deprecation warning is emitted
+ * for each unique file path, but repeated invocations with the same file path have no effect.
+ * No warnings are emitted if the `--no-deprecation` or `--no-warnings` Node runtime flags are active.
+ * @param source The name of the configuration source to report the warning for.
+ * @param errorCode The warning message to show.
+ */
+export declare function emitDeprecationWarning(source: string, errorCode: keyof typeof deprecationWarningMessages): void;
+export {};
+//# sourceMappingURL=deprecation-warnings.d.ts.map

package/_ts4.2/dist/utils/freezeDeeply.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Freezes a given value deeply.
+ */
+export declare function freezeDeeply(x: unknown): void;
+//# sourceMappingURL=freezeDeeply.d.ts.map

package/_ts4.2/dist/utils/getRuleOptionsSchema.d.ts

@@ -0,0 +1,9 @@
+import type { JSONSchema4 } from '@typescript-eslint/utils/json-schema';
+import type { AnyRuleModule } from '@typescript-eslint/utils/ts-eslint';
+/**
+ * Gets a complete options schema for a rule.
+ * @param rule A new-style rule object
+ * @returns JSON Schema for the rule's options.
+ */
+export declare function getRuleOptionsSchema(rule: AnyRuleModule): JSONSchema4 | null;
+//# sourceMappingURL=getRuleOptionsSchema.d.ts.map

package/_ts4.2/dist/utils/hasOwnProperty.d.ts

@@ -0,0 +1,4 @@
+export declare const hasOwnProperty: <TObj extends object, TK extends keyof TObj>(obj: TObj, key: TK) => obj is TObj & {
+    [key in TK]-?: TObj[key];
+};
+//# sourceMappingURL=hasOwnProperty.d.ts.map

package/_ts4.2/dist/utils/interpolate.d.ts

@@ -0,0 +1,3 @@
+import type { ReportDescriptorMessageData } from '@typescript-eslint/utils/ts-eslint';
+export declare function interpolate(text: string, data: ReportDescriptorMessageData): string;
+//# sourceMappingURL=interpolate.d.ts.map

package/_ts4.2/dist/utils/isReadonlyArray.d.ts

@@ -0,0 +1,2 @@
+export declare function isReadonlyArray(arg: unknown): arg is readonly unknown[];
+//# sourceMappingURL=isReadonlyArray.d.ts.map

package/_ts4.2/dist/utils/validationHelpers.d.ts

@@ -0,0 +1,43 @@
+import type { Linter } from '@typescript-eslint/utils/ts-eslint';
+export declare const RULE_TESTER_PARAMETERS: readonly [
+    "code",
+    "defaultFilenames",
+    "dependencyConstraints",
+    "errors",
+    "filename",
+    "name",
+    "only",
+    "options",
+    "output",
+    "skip"
+];
+export declare const ERROR_OBJECT_PARAMETERS: ReadonlySet<string>;
+export declare const FRIENDLY_ERROR_OBJECT_PARAMETER_LIST: string;
+export declare const SUGGESTION_OBJECT_PARAMETERS: ReadonlySet<string>;
+export declare const FRIENDLY_SUGGESTION_OBJECT_PARAMETER_LIST: string;
+/**
+ * Replace control characters by `\u00xx` form.
+ */
+export declare function sanitize(text: string): string;
+/**
+ * Wraps the given parser in order to intercept and modify return values from the `parse` and `parseForESLint` methods, for test purposes.
+ * In particular, to modify ast nodes, tokens and comments to throw on access to their `start` and `end` properties.
+ */
+export declare function wrapParser(parser: Linter.ParserModule): Linter.ParserModule;
+/**
+ * Function to replace `SourceCode.prototype.getComments`.
+ */
+export declare function getCommentsDeprecation(): never;
+/**
+ * Emit a deprecation warning if function-style format is being used.
+ */
+export declare function emitLegacyRuleAPIWarning(ruleName: string): void;
+/**
+ * Emit a deprecation warning if rule has options but is missing the "meta.schema" property
+ */
+export declare function emitMissingSchemaWarning(ruleName: string): void;
+export declare const REQUIRED_SCENARIOS: readonly [
+    "valid",
+    "invalid"
+];
+//# sourceMappingURL=validationHelpers.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typescript-eslint/rule-tester",
-  "version": "6.3.1-alpha.7+d25c5b436",
+  "version": "6.3.1-alpha.9+60df0bbaf",
   "description": "Tooling to test ESLint rules",
   "files": [
     "dist",
@@ -47,8 +47,8 @@
   },
   "//": "NOTE - AJV is out-of-date, but it's intentionally synced with ESLint - https://github.com/eslint/eslint/blob/ad9dd6a933fd098a0d99c6a9aa059850535c23ee/package.json#L70",
   "dependencies": {
-    "@typescript-eslint/typescript-estree": "6.3.1-alpha.7+d25c5b436",
-    "@typescript-eslint/utils": "6.3.1-alpha.7+d25c5b436",
+    "@typescript-eslint/typescript-estree": "6.3.1-alpha.9+60df0bbaf",
+    "@typescript-eslint/utils": "6.3.1-alpha.9+60df0bbaf",
     "ajv": "^6.10.0",
     "lodash.merge": "4.6.2",
     "semver": "^7.5.4"
@@ -59,7 +59,7 @@
   },
   "devDependencies": {
     "@types/lodash.merge": "4.6.7",
-    "@typescript-eslint/parser": "6.3.1-alpha.7+d25c5b436",
+    "@typescript-eslint/parser": "6.3.1-alpha.9+60df0bbaf",
     "chai": "^4.3.7",
     "mocha": "^8.3.2",
     "sinon": "^11.0.0",
@@ -79,5 +79,5 @@
       ]
     }
   },
-  "gitHead": "d25c5b436b012b18728f15460815ea2606534185"
+  "gitHead": "60df0bbafb6247341784dfbdf932585eac88b637"
 }