⬅️ Back to Table of Contents

📄 index.ts

📊 Analysis Summary

Metric	Count
📦 Imports	3
🔄 Re-exports	3
📐 Interfaces	2
📑 Type Aliases	2

📚 Table of Contents

• Imports
• Re-exports
• Interfaces
• Type Aliases

🛠️ File Location:

📂 packages/rule-tester/src/types/index.ts

📦 Imports

Name	Source
InvalidTestCase	./InvalidTestCase
RuleTesterConfig	./RuleTesterConfig
ValidTestCase	./ValidTestCase

---

Re-exports

Type	Source	Exported Names
named	./InvalidTestCase	InvalidTestCase, SuggestionOutput, TestCaseError
named	./RuleTesterConfig	RuleTesterConfig
named	./ValidTestCase	TestLanguageOptions, ValidTestCase

---

Interfaces

RunTests<MessageIds extends string, Options extends readonly unknown[]>

Interface Code

export interface RunTests<
  MessageIds extends string,
  Options extends readonly unknown[],
> {
  readonly invalid: readonly InvalidTestCase<MessageIds, Options>[];
  // RuleTester.run also accepts strings for valid cases
  readonly valid: readonly (string | ValidTestCase<Options>)[];
}

Properties

Name	Type	Optional	Description
invalid	readonly InvalidTestCase<MessageIds, Options>[]	✗
valid	readonly (string | ValidTestCase<Options>)[]	✗

NormalizedRunTests<MessageIds extends string, Options extends readonly unknown[]>

Interface Code

export interface NormalizedRunTests<
  MessageIds extends string,
  Options extends readonly unknown[],
> {
  readonly invalid: readonly InvalidTestCase<MessageIds, Options>[];
  readonly valid: readonly ValidTestCase<Options>[];
}

Properties

Name	Type	Optional	Description
invalid	readonly InvalidTestCase<MessageIds, Options>[]	✗
valid	readonly ValidTestCase<Options>[]	✗

---

Type Aliases

Mutable<T>

type Mutable<T> = {
  -readonly [P in keyof T]: T[P];
};

TesterConfigWithDefaults

type TesterConfigWithDefaults = Mutable<
  Required<
    Pick<RuleTesterConfig, 'defaultFilenames' | 'languageOptions' | 'rules'>
  > &
    RuleTesterConfig
>;

---