1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374 |
- import { JestCliRunner, JestPreprocessor, JestPresetConfig, JestPuppeteerEnvironmentConstructor, JestScreenshotRunner, JestTestRunnerConstructor } from './jest-apis';
- /**
- * Interface for Jest-version specific code implementations that interact with Stencil.
- *
- * It is expected that there exists a Jest version-specific implementation for this interface in each version-specific
- * directory Stencil supports.
- */
- export interface JestFacade {
- /**
- * Retrieve a function that invokes the Jest CLI.
- *
- * This function does not perform the invocation itself. Rather, it expects the caller to prepare a Stencil
- * configuration object and environment for tests to run and invoke the returned value itself.
- *
- * @returns A function that invokes the Jest CLI.
- */
- getJestCliRunner(): JestCliRunner;
- /**
- * Retrieve a function that invokes Stencil's Screenshot runner.
- *
- * This function does not start screenshot tests themselves. Rather, it expects the caller to prepare a Stencil
- * configuration object and environment for tests to run and invoke the screenshot runner itself.
- *
- * @returns A function that invokes the Screenshot runner.
- */
- getRunJestScreenshot(): JestScreenshotRunner;
- /**
- * Retrieve the default Jest runner name prescribed by Stencil.
- *
- * Examples of valid return values include 'jest-jasmine2' and 'jest-circus'.
- *
- * @returns the stringified name of the test runner, based on the currently detected version of Stencil
- */
- getDefaultJestRunner(): string;
- /**
- * Retrieve a function that builds an E2E (puppeteer) testing environment that uses Jest as its test runner.
- *
- * @returns A function that builds an E2E testing environment.
- */
- getCreateJestPuppeteerEnvironment(): () => JestPuppeteerEnvironmentConstructor;
- /**
- * Create an object used to transform files as a part of running Jest.
- *
- * The object returned by this function is expected to conform to the interface/guide laid out by Jest for
- * [writing custom transformers](https://jestjs.io/docs/code-transformation#writing-custom-transformers).
- *
- * @returns the object used to transform files at test time
- */
- getJestPreprocessor(): JestPreprocessor;
- /**
- * Retrieve a function that returns the custom Stencil-Jest test runner
- *
- * @returns a function that retrieves the test runner
- */
- getCreateJestTestRunner(): () => JestTestRunnerConstructor;
- /**
- * Retrieve a function that returns the setup configuration code to run between tests.
- *
- * The value returned by said function is expected to be used in a
- * [setupFilesAfterEnv](https://jestjs.io/docs/configuration#setupfilesafterenv-array) context.
- *
- * @returns a function that runs a setup configuration between tests.
- */
- getJestSetupTestFramework(): () => void;
- /**
- * Retrieve the Jest preset configuration object for configuring tests.
- *
- * The value returned by said function is expected to be used in a
- * [preset](https://jestjs.io/docs/configuration#preset-string) context.
- *
- * @returns the Jest preset object to be used for a particular version of Jest.
- */
- getJestPreset(): JestPresetConfig;
- }
|