Skip to content

⬅️ Back to Table of Contents

📄 TestFramework

📊 Analysis Summary

Metric Count
🧱 Classes 1
📊 Variables & Constants 9
📑 Type Aliases 5

📚 Table of Contents

🛠️ File Location:

📂 packages/rule-tester/src/TestFramework.ts

Variables & Constants

Name Type Kind Value Exported
describe RuleTesterTestFrameworkFunction \| un... let/var *not shown* ✗
it RuleTesterTestFrameworkItFunction \| ... let/var *not shown* ✗
afterAll AfterAll \| undefined let/var *not shown* ✗
OVERRIDE_AFTER_ALL Maybe<AfterAll> let/var null ✗
OVERRIDE_DESCRIBE Maybe<RuleTesterTestFrameworkFunction> let/var null ✗
OVERRIDE_DESCRIBE_SKIP Maybe<RuleTesterTestFrameworkFunction... let/var null ✗
OVERRIDE_IT Maybe<RuleTesterTestFrameworkItFunction> let/var null ✗
OVERRIDE_IT_ONLY Maybe<RuleTesterTestFrameworkFunction... let/var null ✗
OVERRIDE_IT_SKIP Maybe<RuleTesterTestFrameworkFunction... let/var null ✗

Classes

TestFramework

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

Type Aliases

RuleTesterTestFrameworkFunctionBase

/* * @param text a string describing the rule /

type RuleTesterTestFrameworkFunctionBase = (
  text: string,
  callback: () => void,
) => void;

RuleTesterTestFrameworkFunction

type RuleTesterTestFrameworkFunction = {
  /**
   * Skips running the tests inside this `describe` for the current file
   */
  skip?: RuleTesterTestFrameworkFunctionBase;
} & RuleTesterTestFrameworkFunctionBase;

RuleTesterTestFrameworkItFunction

type RuleTesterTestFrameworkItFunction = {
  /**
   * Only runs this test in the current file.
   */
  only?: RuleTesterTestFrameworkFunctionBase;
  /**
   * Skips running this test in the current file.
   */
  skip?: RuleTesterTestFrameworkFunctionBase;
} & RuleTesterTestFrameworkFunctionBase;

Maybe<T>

type Maybe<T> = T | null | undefined;

AfterAll

/* * @param fn a callback called after all the tests are done /

type AfterAll = (fn: () => void) => void;

Generated by Syntax Scribe