Files
pnpm/engine/pm/commands/test/setup/setup.test.ts
Zoltan Kochan 187049055f chore: upgrade @typescript/native-preview to 7.0.0-dev.20260421.2 (#11332)
* chore: upgrade @typescript/native-preview to 7.0.0-dev.20260421.2

- Add explicit `types: ["node"]` to the shared tsconfig because tsgo
  20260421 no longer auto-acquires `@types/*` from `node_modules`.
- Refactor test files to explicitly import jest globals (`describe`,
  `it`, `test`, `expect`, `beforeEach`, etc.) from `@jest/globals`
  instead of relying on `@types/jest` ambient declarations. Under the
  new tsgo build, `import { jest } from '@jest/globals'` shadows the
  ambient `jest` namespace, breaking `@types/jest`'s `declare var
  describe: jest.Describe;` globals.
- Add `@jest/globals` to each package's devDependencies where tests
  now import from it, and add `@types/node` to packages that need it
  but were relying on hoisted resolution.
- Replace `fail()` calls with `throw new Error(...)` since `fail` is
  no longer globally available.

* chore: fix remaining tsgo type-strictness errors

- Strip `as <PnpmType>` casts on objects passed to toMatchObject /
  toStrictEqual / toEqual; @jest/globals rejects the typed objects
  (which include AsymmetricMatchers) vs. the repo-specific type.
- Type `jest.fn<...>()` explicitly where the mock's signature matters
  for toHaveBeenCalledWith.
- Replace `beforeEach(() => X)` with `beforeEach(() => { X })` so the
  return value is void, as the stricter jest typing requires.
- Use `expect.objectContaining({...})` in one place where the full
  expected object triggered stricter type resolution.
- Cast `prompt.mock.calls` arg through `as unknown as Record<...>[]`
  for patch.test.ts's nested-array matchers.
- Fix off-by-one `<reference path>` in pnpm/test/getConfig.test.ts
  that only surfaced now.
- Move `@jest/globals` from devDependencies to dependencies in the
  two `__utils__` packages that import it from `src/`.
- Clean up unused imports from the @jest/globals migration.

* chore: address Copilot review on #11332

- Move misplaced `@jest/globals` imports to the top import block in
  checkEngine, run.ts, and workspace/root-finder tests where the
  script dropped them below executable code.
- Replace `try { await x(); throw new Error('should have thrown') } catch`
  in bins/linker, lockfile/fs, and resolving/local-resolver tests with
  `await expect(x()).rejects.toMatchObject({...})`. The old pattern
  swallowed an unrelated `throw` if the under-test call silently
  succeeded, which would fail on the catch-block assertion with a
  misleading message.
2026-04-21 22:50:40 +02:00

86 lines
2.7 KiB
TypeScript

import { expect, jest, test } from '@jest/globals'
import { PnpmError } from '@pnpm/error'
import type { PathExtenderReport } from '@pnpm/os.env.path-extender'
jest.unstable_mockModule('@pnpm/os.env.path-extender', () => ({
addDirToEnvPath: jest.fn(),
}))
const actualFs = await import('node:fs')
jest.unstable_mockModule('fs', () => {
return {
...actualFs,
promises: {
...actualFs.promises,
readFile: jest.fn(),
writeFile: jest.fn(),
},
}
})
const { addDirToEnvPath } = await import('@pnpm/os.env.path-extender')
const { setup } = await import('@pnpm/engine.pm.commands')
test('setup makes no changes', async () => {
jest.mocked(addDirToEnvPath).mockReturnValue(Promise.resolve<PathExtenderReport>({
oldSettings: 'PNPM_HOME=dir',
newSettings: 'PNPM_HOME=dir',
}))
const output = await setup.handler({ pnpmHomeDir: '' })
expect(output).toBe('No changes to the environment were made. Everything is already up to date.')
})
test('setup makes changes on POSIX', async () => {
jest.mocked(addDirToEnvPath).mockReturnValue(Promise.resolve<PathExtenderReport>({
configFile: {
changeType: 'created',
path: '~/.bashrc',
},
oldSettings: 'export PNPM_HOME=dir1',
newSettings: 'export PNPM_HOME=dir2',
}))
const output = await setup.handler({ pnpmHomeDir: '' })
expect(output).toBe(`Created ~/.bashrc
Next configuration changes were made:
export PNPM_HOME=dir2
To start using pnpm, run:
source ~/.bashrc
`)
})
test('setup makes changes on Windows', async () => {
jest.mocked(addDirToEnvPath).mockReturnValue(Promise.resolve<PathExtenderReport>({
oldSettings: 'export PNPM_HOME=dir1',
newSettings: 'export PNPM_HOME=dir2',
}))
const output = await setup.handler({ pnpmHomeDir: '' })
expect(output).toBe(`Next configuration changes were made:
export PNPM_HOME=dir2
Setup complete. Open a new terminal to start using pnpm.`)
})
test('hint is added to ERR_PNPM_BAD_ENV_FOUND error object', async () => {
jest.mocked(addDirToEnvPath).mockReturnValue(Promise.reject(new PnpmError('BAD_ENV_FOUND', '')))
let err!: PnpmError
try {
await setup.handler({ pnpmHomeDir: '' })
} catch (_err: any) { // eslint-disable-line
err = _err
}
expect(err?.hint).toBe('If you want to override the existing env variable, use the --force option')
})
test('hint is added to ERR_PNPM_BAD_SHELL_SECTION error object', async () => {
jest.mocked(addDirToEnvPath).mockReturnValue(Promise.reject(new PnpmError('BAD_SHELL_SECTION', '')))
let err!: PnpmError
try {
await setup.handler({ pnpmHomeDir: '' })
} catch (_err: any) { // eslint-disable-line
err = _err
}
expect(err?.hint).toBe('If you want to override the existing configuration section, use the --force option')
})