mirror of
https://github.com/pnpm/pnpm.git
synced 2026-03-28 03:51:40 -04:00
2b14c742eb
* chore: create empty new `@pnpm/yaml.document-sync` package
* feat: implement @pnpm/yaml.document-sync
* feat: preserve comments when updating `pnpm-workspace.yaml`
* fix: add missing rootProjectManifestDir field to fix test
This was causing a test to fail due to the rootProjectManifestDir being
an empty string.
The main branch doesn't have this problem because `write-yaml-file`
internally does a `path.dirname(...)` call that ends up resolving the
empty string to `.`.
● logger warns about peer dependencies when linking
ENOENT: no such file or directory, mkdir ''
25 | singleQuote: true, // Prefer single quotes over double quotes
26 | })
> 27 | await fs.promises.mkdir(dir, { recursive: true })
| ^
28 | await writeFileAtomic(path.join(dir, fileName), manifestStr)
29 | }
30 |
at writeManifestFile (../../workspace/manifest-writer/src/index.ts:27:3)
at updateWorkspaceManifest (../../workspace/manifest-writer/src/index.ts:83:3)
at writeSettings (../../config/config-writer/src/index.ts:38:3)
at addLinkToManifest (src/link.ts:182:3)
at src/link.ts:161:7
at async Promise.all (index 0)
at Module.handler (src/link.ts:159:3)
at Object.<anonymous> (test/link.ts:300:3)%
* Update workspace/manifest-writer/src/index.ts
427 lines
12 KiB
TypeScript
427 lines
12 KiB
TypeScript
import fs from 'fs'
|
|
import path from 'path'
|
|
import { prepare, preparePackages, prepareEmpty } from '@pnpm/prepare'
|
|
import { isExecutable, assertProject } from '@pnpm/assert-project'
|
|
import { fixtures } from '@pnpm/test-fixtures'
|
|
import { loadJsonFileSync } from 'load-json-file'
|
|
import PATH from 'path-name'
|
|
import { sync as readYamlFile } from 'read-yaml-file'
|
|
import { writePackageSync } from 'write-package'
|
|
import { type PnpmError } from '@pnpm/error'
|
|
import { jest } from '@jest/globals'
|
|
import { sync as writeYamlFile } from 'write-yaml-file'
|
|
import { DEFAULT_OPTS } from './utils/index.js'
|
|
|
|
const original = await import('@pnpm/logger')
|
|
jest.unstable_mockModule('@pnpm/logger', () => {
|
|
const logger = {
|
|
...original.logger,
|
|
warn: jest.fn(),
|
|
}
|
|
return {
|
|
...original,
|
|
logger: Object.assign(() => logger, logger),
|
|
}
|
|
})
|
|
|
|
const { logger } = await import('@pnpm/logger')
|
|
const { install, link } = await import('@pnpm/plugin-commands-installation')
|
|
|
|
const f = fixtures(import.meta.dirname)
|
|
|
|
test('linking multiple packages', async () => {
|
|
const project = prepare()
|
|
|
|
process.chdir('..')
|
|
const globalDir = path.resolve('global')
|
|
|
|
writePackageSync('linked-foo', { name: 'linked-foo', version: '1.0.0' })
|
|
writePackageSync('linked-bar', { name: 'linked-bar', version: '1.0.0', dependencies: { 'is-positive': '1.0.0' } })
|
|
fs.writeFileSync('linked-bar/.npmrc', 'shamefully-hoist = true')
|
|
|
|
process.chdir('linked-foo')
|
|
|
|
// linking linked-foo to global package
|
|
await link.handler({
|
|
...DEFAULT_OPTS,
|
|
bin: path.join(globalDir, 'bin'),
|
|
dir: globalDir,
|
|
globalPkgDir: globalDir,
|
|
rootProjectManifestDir: globalDir,
|
|
})
|
|
|
|
process.chdir('..')
|
|
process.chdir('project')
|
|
|
|
await link.handler({
|
|
...DEFAULT_OPTS,
|
|
dir: process.cwd(),
|
|
globalPkgDir: globalDir,
|
|
rootProjectManifestDir: process.cwd(),
|
|
}, ['linked-foo', '../linked-bar'])
|
|
|
|
project.has('linked-foo')
|
|
project.has('linked-bar')
|
|
})
|
|
|
|
test('link global bin', async function () {
|
|
prepare()
|
|
process.chdir('..')
|
|
|
|
const globalDir = path.resolve('global')
|
|
const globalBin = path.join(globalDir, 'bin')
|
|
const oldPath = process.env[PATH]
|
|
process.env[PATH] = `${globalBin}${path.delimiter}${oldPath ?? ''}`
|
|
fs.mkdirSync(globalBin, { recursive: true })
|
|
|
|
writePackageSync('package-with-bin', { name: 'package-with-bin', version: '1.0.0', bin: 'bin.js' })
|
|
fs.writeFileSync('package-with-bin/bin.js', '#!/usr/bin/env node\nconsole.log(/hi/)\n', 'utf8')
|
|
|
|
process.chdir('package-with-bin')
|
|
|
|
await link.handler({
|
|
...DEFAULT_OPTS,
|
|
bin: globalBin,
|
|
dir: globalDir,
|
|
globalPkgDir: globalDir,
|
|
rootProjectManifestDir: globalDir,
|
|
})
|
|
process.env[PATH] = oldPath
|
|
|
|
isExecutable((value) => {
|
|
expect(value).toBeTruthy()
|
|
}, path.join(globalBin, 'package-with-bin'))
|
|
})
|
|
|
|
test('link a global package to the specified directory', async function () {
|
|
const project = prepare({ dependencies: { 'global-package-with-bin': '0.0.0' } })
|
|
process.chdir('..')
|
|
|
|
const globalDir = path.resolve('global')
|
|
const globalBin = path.join(globalDir, 'bin')
|
|
const oldPath = process.env[PATH]
|
|
process.env[PATH] = `${globalBin}${path.delimiter}${oldPath ?? ''}`
|
|
fs.mkdirSync(globalBin, { recursive: true })
|
|
|
|
writePackageSync('global-package-with-bin', { name: 'global-package-with-bin', version: '1.0.0', bin: 'bin.js' })
|
|
fs.writeFileSync('global-package-with-bin/bin.js', '#!/usr/bin/env node\nconsole.log(/hi/)\n', 'utf8')
|
|
|
|
process.chdir('global-package-with-bin')
|
|
|
|
// link to global
|
|
await link.handler({
|
|
...DEFAULT_OPTS,
|
|
bin: globalBin,
|
|
dir: globalDir,
|
|
globalPkgDir: globalDir,
|
|
rootProjectManifestDir: globalDir,
|
|
})
|
|
|
|
process.chdir('..')
|
|
const projectDir = path.resolve('./project')
|
|
|
|
// link from global
|
|
await link.handler({
|
|
...DEFAULT_OPTS,
|
|
// bin: globalBin,
|
|
dir: projectDir,
|
|
saveProd: true, // @pnpm/config sets this setting to true when global is true. This should probably be changed.
|
|
globalPkgDir: globalDir,
|
|
rootProjectManifest: { dependencies: { 'global-package-with-bin': '0.0.0' } },
|
|
rootProjectManifestDir: projectDir,
|
|
}, ['global-package-with-bin'])
|
|
|
|
process.env[PATH] = oldPath
|
|
|
|
const manifest = loadJsonFileSync<any>(path.join(projectDir, 'package.json')) // eslint-disable-line @typescript-eslint/no-explicit-any
|
|
expect(manifest.dependencies).toStrictEqual({ 'global-package-with-bin': '0.0.0' })
|
|
project.has('global-package-with-bin')
|
|
})
|
|
|
|
test('relative link', async () => {
|
|
const project = prepare({
|
|
dependencies: {
|
|
'@pnpm.e2e/hello-world-js-bin': '*',
|
|
},
|
|
})
|
|
|
|
const linkedPkgName = 'hello-world-js-bin'
|
|
const linkedPkgPath = path.resolve('..', linkedPkgName)
|
|
|
|
f.copy(linkedPkgName, linkedPkgPath)
|
|
await link.handler({
|
|
...DEFAULT_OPTS,
|
|
dir: process.cwd(),
|
|
globalPkgDir: '',
|
|
rootProjectManifest: {
|
|
dependencies: {
|
|
'@pnpm.e2e/hello-world-js-bin': '*',
|
|
},
|
|
},
|
|
rootProjectManifestDir: process.cwd(),
|
|
}, [`../${linkedPkgName}`])
|
|
|
|
project.isExecutable('.bin/hello-world-js-bin')
|
|
|
|
const manifest = readYamlFile<{ overrides?: Record<string, string> }>('pnpm-workspace.yaml')
|
|
expect(manifest.overrides?.['@pnpm.e2e/hello-world-js-bin']).toBe('link:../hello-world-js-bin')
|
|
|
|
const wantedLockfile = project.readLockfile()
|
|
expect(wantedLockfile.importers['.'].dependencies?.['@pnpm.e2e/hello-world-js-bin']).toStrictEqual({
|
|
specifier: 'link:../hello-world-js-bin',
|
|
version: 'link:../hello-world-js-bin',
|
|
})
|
|
|
|
const currentLockfile = project.readCurrentLockfile()
|
|
expect(currentLockfile.importers['.'].dependencies?.['@pnpm.e2e/hello-world-js-bin'].version).toBe('link:../hello-world-js-bin') // link added to wanted lockfile
|
|
})
|
|
|
|
test('absolute link', async () => {
|
|
const project = prepare({
|
|
dependencies: {
|
|
'@pnpm.e2e/hello-world-js-bin': '*',
|
|
},
|
|
})
|
|
|
|
const linkedPkgName = 'hello-world-js-bin'
|
|
const linkedPkgPath = path.resolve('..', linkedPkgName)
|
|
|
|
f.copy(linkedPkgName, linkedPkgPath)
|
|
await link.handler({
|
|
...DEFAULT_OPTS,
|
|
dir: process.cwd(),
|
|
globalPkgDir: '',
|
|
rootProjectManifestDir: process.cwd(),
|
|
rootProjectManifest: {
|
|
dependencies: {
|
|
'@pnpm.e2e/hello-world-js-bin': '*',
|
|
},
|
|
},
|
|
}, [linkedPkgPath])
|
|
|
|
project.isExecutable('.bin/hello-world-js-bin')
|
|
|
|
const wantedLockfile = project.readLockfile()
|
|
expect(wantedLockfile.importers['.'].dependencies?.['@pnpm.e2e/hello-world-js-bin']).toStrictEqual({
|
|
specifier: 'link:../hello-world-js-bin', // specifier of linked dependency added to ${WANTED_LOCKFILE}
|
|
version: 'link:../hello-world-js-bin', // link added to wanted lockfile
|
|
})
|
|
|
|
const currentLockfile = project.readCurrentLockfile()
|
|
expect(currentLockfile.importers['.'].dependencies?.['@pnpm.e2e/hello-world-js-bin'].version).toBe('link:../hello-world-js-bin') // link added to wanted lockfile
|
|
})
|
|
|
|
test('link --production', async () => {
|
|
const targetManifest = {
|
|
name: 'target',
|
|
version: '1.0.0',
|
|
|
|
dependencies: {
|
|
'is-positive': '1.0.0',
|
|
},
|
|
devDependencies: {
|
|
'is-negative': '1.0.0',
|
|
},
|
|
}
|
|
const projects = preparePackages([
|
|
targetManifest,
|
|
{
|
|
name: 'source',
|
|
version: '1.0.0',
|
|
|
|
dependencies: {
|
|
'is-positive': '1.0.0',
|
|
},
|
|
devDependencies: {
|
|
'is-negative': '1.0.0',
|
|
},
|
|
},
|
|
])
|
|
|
|
process.chdir('target')
|
|
|
|
await install.handler({
|
|
...DEFAULT_OPTS,
|
|
dir: process.cwd(),
|
|
})
|
|
await link.handler({
|
|
...DEFAULT_OPTS,
|
|
cliOptions: { production: true },
|
|
dir: process.cwd(),
|
|
globalPkgDir: '',
|
|
rootProjectManifestDir: process.cwd(),
|
|
rootProjectManifest: targetManifest,
|
|
}, ['../source'])
|
|
|
|
// --production should not have effect on the target
|
|
projects['target'].has('is-positive')
|
|
projects['target'].has('is-negative')
|
|
})
|
|
|
|
test('link fails if nothing is linked', async () => {
|
|
prepare()
|
|
|
|
await expect(
|
|
link.handler({
|
|
...DEFAULT_OPTS,
|
|
dir: '',
|
|
globalPkgDir: '',
|
|
}, [])
|
|
).rejects.toThrow(/You must provide a parameter/)
|
|
})
|
|
|
|
test('logger warns about peer dependencies when linking', async () => {
|
|
prepare()
|
|
|
|
process.chdir('..')
|
|
const globalDir = path.resolve('global')
|
|
|
|
writePackageSync('linked-with-peer-deps', {
|
|
name: 'linked-with-peer-deps',
|
|
version: '1.0.0',
|
|
peerDependencies: {
|
|
'some-peer-dependency': '1.0.0',
|
|
},
|
|
})
|
|
|
|
process.chdir('linked-with-peer-deps')
|
|
|
|
await link.handler({
|
|
...DEFAULT_OPTS,
|
|
bin: path.join(globalDir, 'bin'),
|
|
dir: globalDir,
|
|
globalPkgDir: globalDir,
|
|
rootProjectManifestDir: globalDir,
|
|
})
|
|
|
|
process.chdir('..')
|
|
process.chdir('project')
|
|
|
|
await link.handler({
|
|
...DEFAULT_OPTS,
|
|
dir: process.cwd(),
|
|
globalPkgDir: globalDir,
|
|
rootProjectManifestDir: globalDir,
|
|
}, ['linked-with-peer-deps'])
|
|
|
|
expect(logger.warn).toHaveBeenCalledWith(expect.objectContaining({
|
|
message: expect.stringContaining('has the following peerDependencies specified in its package.json'),
|
|
}))
|
|
|
|
jest.mocked(logger.warn).mockRestore()
|
|
})
|
|
|
|
test('logger should not warn about peer dependencies when it is an empty object', async () => {
|
|
prepare()
|
|
|
|
process.chdir('..')
|
|
const globalDir = path.resolve('global')
|
|
|
|
writePackageSync('linked-with-empty-peer-deps', {
|
|
name: 'linked-with-empty-peer-deps',
|
|
version: '1.0.0',
|
|
peerDependencies: {},
|
|
})
|
|
|
|
process.chdir('linked-with-empty-peer-deps')
|
|
|
|
await link.handler({
|
|
...DEFAULT_OPTS,
|
|
globalPkgDir: '',
|
|
bin: path.join(globalDir, 'bin'),
|
|
dir: globalDir,
|
|
rootProjectManifestDir: globalDir,
|
|
})
|
|
|
|
process.chdir('..')
|
|
process.chdir('project')
|
|
|
|
await link.handler({
|
|
...DEFAULT_OPTS,
|
|
globalPkgDir: globalDir,
|
|
dir: process.cwd(),
|
|
rootProjectManifestDir: process.cwd(),
|
|
}, ['linked-with-empty-peer-deps'])
|
|
|
|
expect(logger.warn).not.toHaveBeenCalledWith(expect.objectContaining({
|
|
message: expect.stringContaining('has the following peerDependencies specified in its package.json'),
|
|
}))
|
|
|
|
jest.mocked(logger.warn).mockRestore()
|
|
})
|
|
|
|
test('link: fail when global bin directory is not found', async () => {
|
|
prepare()
|
|
|
|
const globalDir = path.resolve('global')
|
|
|
|
let err!: PnpmError
|
|
try {
|
|
await link.handler({
|
|
...DEFAULT_OPTS,
|
|
bin: undefined as any, // eslint-disable-line @typescript-eslint/no-explicit-any
|
|
dir: globalDir,
|
|
globalPkgDir: globalDir,
|
|
cliOptions: {
|
|
global: true,
|
|
},
|
|
})
|
|
} catch (_err: any) { // eslint-disable-line @typescript-eslint/no-explicit-any
|
|
err = _err
|
|
}
|
|
expect(err.code).toBe('ERR_PNPM_NO_GLOBAL_BIN_DIR')
|
|
})
|
|
|
|
test('relative link from workspace package', async () => {
|
|
prepareEmpty()
|
|
|
|
const rootProjectManifest = {
|
|
name: 'project',
|
|
version: '1.0.0',
|
|
dependencies: {
|
|
'@pnpm.e2e/hello-world-js-bin': '*',
|
|
},
|
|
}
|
|
writePackageSync('workspace/packages/project', rootProjectManifest)
|
|
const workspaceDir = path.resolve('workspace')
|
|
writeYamlFile(path.join(workspaceDir, 'pnpm-workspace.yaml'), { packages: ['packages/*'] })
|
|
|
|
f.copy('hello-world-js-bin', 'hello-world-js-bin')
|
|
|
|
const projectDir = path.resolve('workspace/packages/project')
|
|
const helloWorldJsBinDir = path.resolve('hello-world-js-bin')
|
|
|
|
process.chdir(projectDir)
|
|
|
|
await link.handler({
|
|
...DEFAULT_OPTS,
|
|
dedupeDirectDeps: false,
|
|
dir: process.cwd(),
|
|
globalPkgDir: '',
|
|
lockfileDir: workspaceDir,
|
|
rootProjectManifest,
|
|
rootProjectManifestDir: workspaceDir,
|
|
workspaceDir,
|
|
workspacePackagePatterns: ['packages/*'],
|
|
}, ['../../../hello-world-js-bin'])
|
|
|
|
const manifest = readYamlFile<{ overrides?: Record<string, string> }>(path.join(workspaceDir, 'pnpm-workspace.yaml'))
|
|
expect(manifest.overrides?.['@pnpm.e2e/hello-world-js-bin']).toBe('link:../hello-world-js-bin')
|
|
|
|
const workspace = assertProject(workspaceDir)
|
|
;[workspace.readLockfile(), workspace.readCurrentLockfile()].forEach(lockfile => {
|
|
expect(lockfile.importers['.'].dependencies?.['@pnpm.e2e/hello-world-js-bin'].version)
|
|
.toBe('link:../hello-world-js-bin')
|
|
expect(lockfile.importers['packages/project'].dependencies?.['@pnpm.e2e/hello-world-js-bin'].version)
|
|
.toBe('link:../../../hello-world-js-bin')
|
|
})
|
|
|
|
const validateSymlink = (basePath: string) => {
|
|
process.chdir(path.join(basePath, 'node_modules', '@pnpm.e2e'))
|
|
expect(path.resolve(fs.readlinkSync('hello-world-js-bin'))).toBe(helloWorldJsBinDir)
|
|
}
|
|
|
|
validateSymlink(workspaceDir)
|
|
validateSymlink(projectDir)
|
|
})
|