Why Gemfury? Push, build, and install  RubyGems npm packages Python packages Maven artifacts PHP packages Go Modules Debian packages RPM packages NuGet packages

Repository URL to install this package:

Details    
@skava/tests / src / declarations / JestConfig.ts
Size: Mime:
/**
 * Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 * @flow
 */

export type Path = string
export type Glob = string
export type TestEnvironment = 'jsdom' | 'node' | string

export type FileExt =
  | 'mjs'
  | 'web.ts'
  | 'ts'
  | 'web.tsx'
  | 'tsx'
  | 'web.js'
  | 'js'
  | 'web.jsx'
  | 'jsx'
  | 'json'
  | 'node'
  | 'txt'
  | 'mp3'
  | 'mp4'
  | 'wav'
  | 'ogg'
  | 'zip'
  | 'qt'
  | 'mid'
  | 'midi'
  | 'html'
  | 'gif'
  | 'exe'
  | 'apk'
  | 'dmg'
  | 'doc'
  | 'css'
  | 'scss'
  | 'sass'
  | 'ddd'
  | 'md'
  | 'json'
  | 'pug'
  | 'avi'
  | 'mpg'
  | 'mpeg'
  | 'mov'
  | 'pdf'
  | 'raw'
  | 'png'
  | 'jpeg'
  | 'jpg'

export interface TestEnvironmentOptions {
  [key: string]: string
}

export type HasteConfig = {
  defaultPlatform?: string // ??
  hasteImplModulePath?: string
  platforms?: Array<string>
  providesModuleNodeModules: Array<string>
}

export type ReporterConfig = [string, Object]

export interface ConfigGlobals {
  [key: string]: any
}

export interface DefaultOptions {
  automock?: boolean
  bail?: boolean
  browser?: boolean
  cache?: boolean
  cacheDirectory?: Path
  changedFilesWithAncestor?: boolean
  clearMocks?: boolean
  collectCoverage?: boolean
  collectCoverageFrom?: Array<string>
  coverageDirectory?: string
  coveragePathIgnorePatterns?: Array<string>
  coverageReporters?: Array<string>
  coverageThreshold?: { global: { [key: string]: number } }
  errorOnDeprecated?: boolean
  expand?: boolean
  filter?: Path
  forceCoverageMatch?: Array<Glob>
  globals?: ConfigGlobals
  globalSetup?: string
  globalTeardown?: string
  haste?: HasteConfig
  detectLeaks?: boolean
  detectOpenHandles?: boolean
  moduleDirectories?: Array<string>
  moduleFileExtensions?: Array<FileExt>
  moduleNameMapper?: { [key: string]: string } | Array<string>
  modulePathIgnorePatterns?: Array<string>
  noStackTrace?: boolean
  notify?: boolean
  notifyMode?: string
  preset?: string
  prettierPath?: string
  projects?: Array<string | ProjectConfig>
  resetMocks?: boolean
  resetModules?: boolean
  resolver?: Path
  restoreMocks?: boolean
  rootDir?: Path
  roots?: Array<Path>
  runner?: string
  runTestsByPath?: boolean
  setupFiles?: Array<Path>
  setupTestFrameworkScriptFile?: Path
  skipFilter?: boolean
  snapshotSerializers?: Array<Path>
  testEnvironment?: TestEnvironment
  testEnvironmentOptions?: TestEnvironmentOptions
  testFailureExitCode?: string | number
  testLocationInResults?: boolean
  testMatch?: Array<Glob>
  testPathIgnorePatterns?: Array<string>
  testRegex?: string
  testResultsProcessor?: string
  testRunner?: string
  testURL?: string
  timers?: 'real' | 'fake'
  transform?: { [key: string]: string }
  transformIgnorePatterns?: Array<Glob>
  watchPathIgnorePatterns?: Array<string>
  useStderr?: boolean
  verbose?: boolean
  watch?: boolean
  watchman?: boolean
}

export interface InitialOptions {
  automock?: boolean
  bail?: boolean
  browser?: boolean
  cache?: boolean
  cacheDirectory?: Path
  clearMocks?: boolean
  changedFilesWithAncestor?: boolean
  changedSince?: string
  collectCoverage?: boolean
  collectCoverageFrom?: Array<Glob>
  collectCoverageOnlyFrom?: { [key: string]: boolean }
  coverageDirectory?: string
  coveragePathIgnorePatterns?: Array<string>
  coverageReporters?: Array<string>
  coverageThreshold?: { global: { [key: string]: number } }
  detectLeaks?: boolean
  detectOpenHandles?: boolean
  displayName?: string
  expand?: boolean
  filter?: Path
  findRelatedTests?: boolean
  forceCoverageMatch?: Array<Glob>
  forceExit?: boolean
  json?: boolean
  globals?: ConfigGlobals
  globalSetup?: string // ??
  globalTeardown?: string // ??
  haste?: HasteConfig

  // maybe was a pair?
  reporters?: Array<ReporterConfig | string>
  logHeapUsage?: boolean
  lastCommit?: boolean
  listTests?: boolean
  mapCoverage?: boolean
  moduleDirectories?: Array<string>
  moduleFileExtensions?: Array<FileExt>
  moduleLoader?: Path
  moduleNameMapper?: { [key: string]: string } | Array<string>
  modulePathIgnorePatterns?: Array<string>
  modulePaths?: Array<string>
  name?: string
  noStackTrace?: boolean
  notify?: boolean
  notifyMode?: string
  onlyChanged?: boolean
  outputFile?: Path
  passWithNoTests?: boolean
  preprocessorIgnorePatterns?: Array<Glob>
  preset?: string // ??
  prettierPath?: string // ??
  projects?: Array<Glob>
  replname?: string // ??
  resetMocks?: boolean
  resetModules?: boolean
  resolver?: Path // ??
  restoreMocks?: boolean
  rootDir?: Path
  roots?: Array<Path>
  runner?: string
  runTestsByPath?: boolean
  scriptPreprocessor?: string
  setupFiles?: Array<Path>
  setupTestFrameworkScriptFile?: Path
  silent?: boolean
  skipFilter?: boolean
  skipNodeResolution?: boolean
  snapshotSerializers?: Array<Path>
  errorOnDeprecated?: boolean
  testEnvironment?: TestEnvironment
  testEnvironmentOptions?: TestEnvironmentOptions
  testFailureExitCode?: string | number
  testLocationInResults?: boolean
  testMatch?: Array<Glob>
  testNamePattern?: string
  testPathDirs?: Array<Path>
  testPathIgnorePatterns?: Array<string>
  testRegex?: string
  testResultsProcessor?: string // ??
  testRunner?: string
  testURL?: string
  timers?: 'real' | 'fake'
  transform?: { [key: string]: string }
  transformIgnorePatterns?: Array<Glob>
  watchPathIgnorePatterns?: Array<string>
  unmockedModulePathPatterns?: Array<string>
  updateSnapshot?: boolean
  useStderr?: boolean
  verbose?: boolean // ??
  watch?: boolean
  watchAll?: boolean
  watchman?: boolean

  // pair?
  watchPlugins?: Array<string | [string, Object]>
}

export type SnapshotUpdateState = 'all' | 'new' | 'none'

export interface GlobalConfig {
  bail: boolean
  changedSince: string
  changedFilesWithAncestor: boolean
  collectCoverage: boolean
  collectCoverageFrom: Array<Glob>
  collectCoverageOnlyFrom?: { [key: string]: boolean }
  coverageDirectory: string
  coveragePathIgnorePatterns?: Array<string>
  coverageReporters: Array<string>
  coverageThreshold: { global: { [key: string]: number } }
  detectLeaks: boolean
  detectOpenHandles: boolean
  enabledTestsMap?: { [key: string]: { [key: string]: boolean } }
  expand: boolean
  filter?: Path
  findRelatedTests: boolean
  forceExit: boolean
  json: boolean
  globalSetup?: string
  globalTeardown?: string
  lastCommit: boolean
  logHeapUsage: boolean
  listTests: boolean
  maxWorkers: number
  noStackTrace: boolean
  nonFlagArgs: Array<string>
  noSCM?: boolean
  notify: boolean
  notifyMode: string
  outputFile?: Path
  onlyChanged: boolean
  onlyFailures: boolean
  passWithNoTests: boolean
  projects: Array<Glob>
  replname?: string
  reporters: Array<ReporterConfig>
  runTestsByPath: boolean
  rootDir: Path
  silent: boolean
  skipFilter: boolean
  errorOnDeprecated?: boolean
  testFailureExitCode: number
  testNamePattern: string
  testPathPattern: string
  testResultsProcessor?: string
  updateSnapshot: SnapshotUpdateState
  useStderr: boolean
  verbose?: boolean
  watch: boolean
  watchAll: boolean
  watchman: boolean

  // ?
  watchPlugins?: Array<{ path: string; config: Object }>
}

export interface ProjectConfig {
  automock?: boolean
  browser?: boolean
  cache?: boolean
  cacheDirectory?: Path
  clearMocks?: boolean
  coveragePathIgnorePatterns?: Array<string>
  cwd?: Path
  detectLeaks?: boolean
  detectOpenHandles?: boolean
  displayName?: string
  errorOnDeprecated?: boolean
  filter?: Path
  forceCoverageMatch?: Array<Glob>
  globals?: ConfigGlobals
  haste?: HasteConfig
  moduleDirectories?: Array<string>
  moduleFileExtensions?: Array<FileExt>
  moduleLoader?: Path
  // moduleNameMapper?: Array<string>
  modulePathIgnorePatterns?: Array<string>
  modulePaths?: Array<string>
  name?: string
  prettierPath?: string
  resetMocks?: boolean
  resetModules?: boolean
  resolver?: Path
  restoreMocks?: boolean
  rootDir?: Path
  roots?: Array<Path>
  runner?: string
  setupFiles?: Array<Path>
  setupTestFrameworkScriptFile?: Path
  skipFilter?: boolean
  skipNodeResolution?: boolean
  snapshotSerializers?: Array<Path>
  testEnvironment?: TestEnvironment
  testEnvironmentOptions?: TestEnvironmentOptions

  // *
  testMatch?: Array<Glob> | string[]

  testLocationInResults?: boolean
  testPathIgnorePatterns?: Array<string>

  // *
  testRegex?: string

  testRunner?: string
  testURL?: string

  timers?: 'real' | 'fake'
  // maybe this was a pair array?
  // transform?: Array<string, Path>
  transformIgnorePatterns?: Array<Glob>
  watchPathIgnorePatterns?: Array<string>
  unmockedModulePathPatterns?: Array<string>
}

// export type JestConfig = GlobalConfig | ProjectConfig
export type JestConfig<EnvOptions = any> = ProjectConfig & DefaultOptions