Options
All
  • Public
  • Public/Protected
  • All
Menu

Package acceptance-tests

Type aliases

ExecResult

ExecResult: object | ExecException & object

PackageEntry

PackageEntry: Map<string, object>

PackageRegistry

PackageRegistry: Map<string, PackageEntry>

PackageRunDriver

PackageRunDriver: function

Type declaration

RunFunction

RunFunction: function

Type declaration

    • (__namedParameters: object): void
    • Parameters

      • __namedParameters: object
        • path: string & object
        • run: function
            • Parameters

              • Rest ...args: Array<any>

              Returns Promise<ExecResult>

        • source: function
            • (script: string, callDefinition?: Record<string, any>): Promise<Record<string, any>>
            • Parameters

              • script: string
              • Optional callDefinition: Record<string, any>

              Returns Promise<Record<string, any>>

      Returns void

Variables

Const FAKE_FIRST_SCOPE

FAKE_FIRST_SCOPE: "first" = `first`

Const FAKE_PUBLISH_REGISTRY_URL

FAKE_PUBLISH_REGISTRY_URL: "https://npm.pkg.github.com" = `https://npm.pkg.github.com`

Const FAKE_REGISTRY_URL

FAKE_REGISTRY_URL: "http://yarn.test.registry" = `http://yarn.test.registry`

Const FAKE_SECOND_SCOPE

FAKE_SECOND_SCOPE: "second" = `second`

Const FAKE_THIRD_REGISTRY_URL

FAKE_THIRD_REGISTRY_URL: "https://third.yarn.test.registry" = `https://third.yarn.test.registry`

Const FAKE_THIRD_SCOPE

FAKE_THIRD_SCOPE: "third" = `third`

Const IS_WIN32

IS_WIN32: boolean = process.platform === `win32`

Const SPEC_RC_FILENAME

SPEC_RC_FILENAME: string & object = `.spec-yarnrc` as Filename

createTemporaryFolder

createTemporaryFolder: createTemporaryFolder

Const deepResolve

deepResolve: any = require(`super-resolve`)

Const deepResolve

deepResolve: any = require(`super-resolve`)

execFile

execFile: execFile

fs

fs: object

Type declaration

  • readJson: any
  • writeFile: any
  • writeJson: any

generatePkgDriver

generatePkgDriver: generatePkgDriver

getPackageRegistry

getPackageRegistry: getPackageRegistry

Const mte

mte: PackageDriver = generatePkgDriver({getName() {return `yarn`;},async runDriver(path,[command, ...args],{cwd, projectFolder, registryUrl, env, ...config},) {const rcEnv: Record<string, any> = {};for (const [key, value] of Object.entries(config))rcEnv[`YARN_${key.replace(/([A-Z])/g, `_$1`).toUpperCase()}`] = Array.isArray(value) ? value.join(`;`) : value;const nativePath = npath.fromPortablePath(path);const tempHomeFolder = npath.fromPortablePath(await createTemporaryFolder());const cwdArgs = typeof projectFolder !== `undefined`? [projectFolder]: [];const yarnBinary = require.resolve(`${__dirname}/../../../../yarnpkg-cli/bundles/yarn.js`);const res = await execFile(process.execPath, [yarnBinary, ...cwdArgs, command, ...args], {cwd: cwd || path,env: {[`HOME`]: tempHomeFolder,[`USERPROFILE`]: tempHomeFolder,[`PATH`]: `${nativePath}/bin${delimiter}${process.env.PATH}`,[`TEST_ENV`]: `true`,[`YARN_GLOBAL_FOLDER`]: `${nativePath}/.yarn/global`,[`YARN_NPM_REGISTRY_SERVER`]: registryUrl,[`YARN_UNSAFE_HTTP_WHITELIST`]: new URL(registryUrl).hostname,// Otherwise we'd send telemetry event when running tests[`YARN_ENABLE_TELEMETRY`]: `0`,// Otherwise snapshots relying on this would break each time it's bumped[`YARN_CACHE_KEY_OVERRIDE`]: `0`,// Otherwise the tests would break when C:\tmp is on a different drive than the repo[`YARN_ENABLE_ABSOLUTE_VIRTUALS`]: `true`,// Otherwise the output isn't stable between runs[`YARN_ENABLE_TIMERS`]: `false`,[`YARN_ENABLE_PROGRESS_BARS`]: `false`,// Otherwise the output wouldn't be the same on CI vs non-CI[`YARN_ENABLE_INLINE_BUILDS`]: `false`,// Otherwise we would more often test the fallback rather than the real logic[`YARN_PNP_FALLBACK_MODE`]: `none`,// Otherwise tests fail on systems where this is globally set to true[`YARN_ENABLE_GLOBAL_CACHE`]: `false`,...rcEnv,...env,},});if (process.env.JEST_LOG_SPAWNS) {console.log(`===== stdout:`);console.log(res.stdout);console.log(`===== stderr:`);console.log(res.stderr);}return res;},})

Let packageRegistryPromise

packageRegistryPromise: Promise<PackageRegistry> | null = null

Let packageServerUrl

packageServerUrl: string | null = null

readFile

readFile: readFile

readJson

readJson: any

readManifest

readManifest: readManifest

readManifest

readManifest: readManifest

readManifest

readManifest: readManifest

setPackageWhitelist

setPackageWhitelist: setPackageWhitelist

startPackageServer

startPackageServer: startPackageServer

Const staticServer

staticServer: Handler = serveStatic(npath.fromPortablePath(require(`pkg-tests-fixtures`)))

testIf

testIf: any

tests

tests: object

Type declaration

  • testIf: any

unpackToDirectory

unpackToDirectory: unpackToDirectory

Let whitelist

whitelist: Map<any, any> = new Map()

writeConfiguration

writeConfiguration: writeConfiguration

writeFile

writeFile: any

writeFile

writeFile: writeFile

writeJson

writeJson: writeJson

writeJson

writeJson: writeJson

writeJson

writeJson: any

Functions

Const chmod

computeCacheSize

Const createTemporaryFile

Const createTemporaryFolder

Const execFile

Const filePatternMatch

  • filePatternMatch(filePath: string, patterns: Array<string>, __namedParameters?: object): boolean

Const generatePkgDriver

Const getPackageArchiveHash

  • getPackageArchiveHash(name: string, version: string): Promise<string | Buffer>

Const getPackageArchivePath

  • getPackageArchivePath(name: string, version: string): Promise<string>

Const getPackageArchiveStream

  • getPackageArchiveStream(name: string, version: string): Promise<Gzip>

Const getPackageDirectoryPath

  • getPackageDirectoryPath(name: string, version: string): Promise<string>

Const getPackageEntry

  • getPackageEntry(name: string): Promise<PackageEntry | undefined>

Const getPackageHttpArchivePath

  • getPackageHttpArchivePath(name: string, version: string): Promise<string>

Const getPackageRegistry

getPluginPath

  • getPluginPath(dir: PortablePath, name: string): string & object

Const getWorkspaces

  • getWorkspaces(run: function): Promise<string[]>

Const makeFakeBinary

  • makeFakeBinary(target: PortablePath, __namedParameters?: object): Promise<void>

Const mkdirp

Const mtme

  • mtme(packageJson: Record<string, any>, workspaces: Record<string, Record<string, any>>, subDefinition: Record<string, any> | RunFunction, fn?: RunFunction | undefined): any

Const packToFile

Const packToStream

  • packToStream(source: PortablePath, __namedParameters?: object): Gzip

Const parseJsonStream

  • parseJsonStream(stream: string, key?: undefined | string): any

readConfiguration

  • readConfiguration(dir: PortablePath, __namedParameters?: object): Promise<any>

Const readFile

  • readFile(source: PortablePath, encoding?: undefined | string): Promise<any>

Const readJson

readManifest

  • readManifest(dir: PortablePath, __namedParameters?: object): Promise<any>
  • Parameters

    • dir: PortablePath
    • Default value __namedParameters: object = {}
      • filename: string & object
      • key: undefined | "name" | "version" | "dependencies" | "peerDependencies" | "dependenciesMeta" | "peerDependenciesMeta" | "devDependencies" | "type" | "indent" | "os" | "cpu" | "private" | "license" | "main" | "module" | "browser" | "languageName" | "bin" | "scripts" | "workspaceDefinitions" | "resolutions" | "files" | "publishConfig" | "installConfig" | "preferUnplugged" | "raw" | "errors" | "loadFromText" | "loadFile" | "load" | "getForScope" | "hasConsumerDependency" | "hasHardDependency" | "hasSoftDependency" | "hasDependency" | "isCompatibleWithOS" | "isCompatibleWithCPU" | "ensureDependencyMeta" | "ensurePeerDependencyMeta" | "setRawField" | "exportTo"

    Returns Promise<any>

Const readSyml

Const realpath

Const setPackageWhitelist

  • setPackageWhitelist(packages: Map<string, Set<string>>, fn: function): Promise<void>

Const startPackageServer

  • startPackageServer(): Promise<string>

Const stringPatternMatch

  • stringPatternMatch(string: string, patterns: Array<string>, __namedParameters?: object): boolean

Const testIf

  • testIf(condition: function, name: string, execute?: jest.ProvidesCallback | undefined, timeout?: number | undefined): void

Const unpackToDirectory

Const walk

writeConfiguration

  • writeConfiguration(dir: PortablePath, value: object, __namedParameters?: object): Promise<void>

Const writeFile

  • writeFile(target: PortablePath, body: string | Buffer): Promise<void>

Const writeJson

  • writeJson(target: PortablePath, object: any): Promise<void>

Const writeSyml

  • writeSyml(target: PortablePath, object: any): Promise<void>

Object literals

Const CLASSIC_SCOPE_SETTINGS

CLASSIC_SCOPE_SETTINGS: object

npmAlwaysAuth

npmAlwaysAuth: string = `true`

Const FAKE_REGISTRY_CREDENTIALS

FAKE_REGISTRY_CREDENTIALS: object

npmAuthIdent

npmAuthIdent: string = `username:password`

npmAuthToken

npmAuthToken: string = `ffffffff-ffff-ffff-ffff-ffffffffffff`

Const unplugged

unplugged: object

unplugged

unplugged: boolean = true

Generated using TypeDoc