diff --git a/.changeset/flat-kids-jump.md b/.changeset/flat-kids-jump.md new file mode 100644 index 00000000000..ec15cc41c36 --- /dev/null +++ b/.changeset/flat-kids-jump.md @@ -0,0 +1,6 @@ +--- +"@pnpm/plugin-commands-deploy": minor +"@pnpm/directory-fetcher": minor +--- + +Apply `publishConfig` for workspace packages on directory fetch. Enables a publishable ("exportable") `package.json` on deployment [#6693](https://github.com/pnpm/pnpm/issues/6693). diff --git a/fetching/directory-fetcher/package.json b/fetching/directory-fetcher/package.json index ba9bbc456d7..a7706f2acf0 100644 --- a/fetching/directory-fetcher/package.json +++ b/fetching/directory-fetcher/package.json @@ -34,9 +34,13 @@ "@pnpm/logger": "^5.0.0" }, "dependencies": { + "@pnpm/exportable-manifest": "workspace:*", "@pnpm/fetcher-base": "workspace:*", "@pnpm/read-project-manifest": "workspace:*", "@pnpm/resolver-base": "workspace:*", + "@pnpm/types": "workspace:*", + "@pnpm/write-project-manifest": "workspace:*", + "fast-deep-equal": "^3.1.3", "npm-packlist": "^5.1.3" }, "devDependencies": { diff --git a/fetching/directory-fetcher/src/index.ts b/fetching/directory-fetcher/src/index.ts index 0edbb38af60..edf12162eb9 100644 --- a/fetching/directory-fetcher/src/index.ts +++ b/fetching/directory-fetcher/src/index.ts @@ -1,8 +1,12 @@ import { promises as fs, type Stats } from 'fs' import path from 'path' +import { createExportableManifest } from '@pnpm/exportable-manifest' import type { DirectoryFetcher, DirectoryFetcherOptions } from '@pnpm/fetcher-base' import { logger } from '@pnpm/logger' import { safeReadProjectManifestOnly } from '@pnpm/read-project-manifest' +import type { ProjectManifest } from '@pnpm/types' +import { writeProjectManifest } from '@pnpm/write-project-manifest' +import equal from 'fast-deep-equal' import packlist from 'npm-packlist' const directoryFetcherLogger = logger('directory-fetcher') @@ -47,11 +51,8 @@ async function fetchAllFilesFromDir ( opts: FetchFromDirOpts ) { const filesIndex = await _fetchAllFilesFromDir(readFileStat, dir) + const manifest = await safeReadProjectManifestAndMakeExportable(dir, filesIndex) ?? {} if (opts.manifest) { - // In a regular pnpm workspace it will probably never happen that a dependency has no package.json file. - // Safe read was added to support the Bit workspace in which the components have no package.json files. - // Related PR in Bit: https://github.com/teambit/bit/pull/5251 - const manifest = await safeReadProjectManifestOnly(dir) ?? {} opts.manifest.resolve(manifest as any) // eslint-disable-line @typescript-eslint/no-explicit-any } return { @@ -128,11 +129,8 @@ async function fetchPackageFilesFromDir ( ) { const files = await packlist({ path: dir }) const filesIndex: Record = Object.fromEntries(files.map((file) => [file, path.join(dir, file)])) + const manifest = await safeReadProjectManifestAndMakeExportable(dir, filesIndex) ?? {} if (opts.manifest) { - // In a regular pnpm workspace it will probably never happen that a dependency has no package.json file. - // Safe read was added to support the Bit workspace in which the components have no package.json files. - // Related PR in Bit: https://github.com/teambit/bit/pull/5251 - const manifest = await safeReadProjectManifestOnly(dir) ?? {} opts.manifest.resolve(manifest as any) // eslint-disable-line @typescript-eslint/no-explicit-any } return { @@ -141,3 +139,20 @@ async function fetchPackageFilesFromDir ( packageImportMethod: 'hardlink' as const, } } + +async function safeReadProjectManifestAndMakeExportable ( + dir: string, + filesIndex: Record +): Promise { + const manifest = await safeReadProjectManifestOnly(dir) + // In a regular pnpm workspace it will probably never happen that a dependency has no package.json file. + // Safe read was added to support the Bit workspace in which the components have no package.json files. + // Related PR in Bit: https://github.com/teambit/bit/pull/5251 + if (!manifest) return null + const exportableManifest = await createExportableManifest(dir, manifest) + if (equal(manifest, exportableManifest)) return manifest + const manifestPathOverride = path.join(dir, 'node_modules/.pnpm/package.json') + await writeProjectManifest(manifestPathOverride, exportableManifest) + filesIndex['package.json'] = manifestPathOverride + return manifest +} diff --git a/fetching/directory-fetcher/test/fixtures/exportable-manifest/package.json b/fetching/directory-fetcher/test/fixtures/exportable-manifest/package.json new file mode 100644 index 00000000000..e08d267ac44 --- /dev/null +++ b/fetching/directory-fetcher/test/fixtures/exportable-manifest/package.json @@ -0,0 +1,8 @@ +{ + "name": "exportable", + "version": "1.0.0", + "main": "src/index.ts", + "publishConfig": { + "main": "dist/index.js" + } +} diff --git a/fetching/directory-fetcher/test/index.ts b/fetching/directory-fetcher/test/index.ts index 440b06db850..1a7b3df38c6 100644 --- a/fetching/directory-fetcher/test/index.ts +++ b/fetching/directory-fetcher/test/index.ts @@ -157,3 +157,24 @@ describe('fetch resolves symlinked files to their real locations', () => { expect(fetchResult.filesIndex['src/index.js']).toBe(path.resolve('src/index.js')) }) }) + +test('fetch should return exportable manifest', async () => { + process.chdir(f.find('exportable-manifest')) + const fetcher = createDirectoryFetcher() + + // eslint-disable-next-line + const fetchResult = await fetcher.directory({} as any, { + directory: '.', + type: 'directory', + }, { + lockfileDir: process.cwd(), + }) + + expect(fetchResult.filesIndex['package.json']).not.toBe(path.resolve('package.json')) + + expect(JSON.parse(fs.readFileSync(fetchResult.filesIndex['package.json'], 'utf8'))).toStrictEqual({ + name: 'exportable', + version: '1.0.0', + main: 'dist/index.js', + }) +}) diff --git a/fetching/directory-fetcher/tsconfig.json b/fetching/directory-fetcher/tsconfig.json index a95636e8c76..4d2530bbf50 100644 --- a/fetching/directory-fetcher/tsconfig.json +++ b/fetching/directory-fetcher/tsconfig.json @@ -12,9 +12,18 @@ { "path": "../../__utils__/test-fixtures" }, + { + "path": "../../packages/types" + }, + { + "path": "../../pkg-manifest/exportable-manifest" + }, { "path": "../../pkg-manifest/read-project-manifest" }, + { + "path": "../../pkg-manifest/write-project-manifest" + }, { "path": "../../resolving/resolver-base" }, diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index a4c37c33331..c9cbb1d34db 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -1459,6 +1459,9 @@ importers: fetching/directory-fetcher: dependencies: + '@pnpm/exportable-manifest': + specifier: workspace:* + version: link:../../pkg-manifest/exportable-manifest '@pnpm/fetcher-base': specifier: workspace:* version: link:../fetcher-base @@ -1471,6 +1474,15 @@ importers: '@pnpm/resolver-base': specifier: workspace:* version: link:../../resolving/resolver-base + '@pnpm/types': + specifier: workspace:* + version: link:../../packages/types + '@pnpm/write-project-manifest': + specifier: workspace:* + version: link:../../pkg-manifest/write-project-manifest + fast-deep-equal: + specifier: ^3.1.3 + version: 3.1.3 npm-packlist: specifier: ^5.1.3 version: 5.1.3 @@ -4698,6 +4710,18 @@ importers: '@pnpm/registry-mock': specifier: 3.11.0 version: 3.11.0(typanion@3.14.0) + '@types/cross-spawn': + specifier: ^6.0.2 + version: 6.0.2 + cross-spawn: + specifier: ^7.0.3 + version: 7.0.3 + load-json-file: + specifier: ^6.2.0 + version: 6.2.0 + write-yaml-file: + specifier: ^5.0.0 + version: 5.0.0 releasing/plugin-commands-publishing: dependencies: diff --git a/releasing/plugin-commands-deploy/package.json b/releasing/plugin-commands-deploy/package.json index c5b558690a4..24b760987df 100644 --- a/releasing/plugin-commands-deploy/package.json +++ b/releasing/plugin-commands-deploy/package.json @@ -39,7 +39,11 @@ "@pnpm/lockfile-types": "workspace:*", "@pnpm/plugin-commands-deploy": "workspace:*", "@pnpm/prepare": "workspace:*", - "@pnpm/registry-mock": "3.11.0" + "@pnpm/registry-mock": "3.11.0", + "@types/cross-spawn": "^6.0.2", + "cross-spawn": "^7.0.3", + "load-json-file": "^6.2.0", + "write-yaml-file": "^5.0.0" }, "dependencies": { "@pnpm/cli-utils": "workspace:*", diff --git a/releasing/plugin-commands-deploy/test/deploy.test.ts b/releasing/plugin-commands-deploy/test/deploy.test.ts index 76ec91c9a7b..638ef8f2dac 100644 --- a/releasing/plugin-commands-deploy/test/deploy.test.ts +++ b/releasing/plugin-commands-deploy/test/deploy.test.ts @@ -3,9 +3,15 @@ import path from 'path' import { deploy } from '@pnpm/plugin-commands-deploy' import { assertProject } from '@pnpm/assert-project' import { preparePackages } from '@pnpm/prepare' +import { REGISTRY_MOCK_PORT } from '@pnpm/registry-mock' import { readProjects } from '@pnpm/filter-workspace-packages' +import crossSpawn from 'cross-spawn' +import { sync as loadJsonFile } from 'load-json-file' +import writeYamlFile from 'write-yaml-file' import { DEFAULT_OPTS } from './utils' +const pnpmBin = path.join(__dirname, '../../../pnpm/bin/pnpm.cjs') + test('deploy', async () => { preparePackages([ { @@ -20,6 +26,10 @@ test('deploy', async () => { 'project-3': 'workspace:*', 'is-negative': '1.0.0', }, + main: 'local-file-1.js', + publishConfig: { + main: 'publish-file-1.js', + }, }, { name: 'project-2', @@ -29,6 +39,10 @@ test('deploy', async () => { 'project-3': 'workspace:*', 'is-odd': '1.0.0', }, + main: 'local-file-2.js', + publishConfig: { + main: 'publish-file-2.js', + }, }, { name: 'project-3', @@ -46,6 +60,10 @@ test('deploy', async () => { fs.writeFileSync(`${name}/index.js`, '', 'utf8') }) + await writeYamlFile('pnpm-workspace.yaml', { packages: ['*'] }) + crossSpawn.sync(pnpmBin, ['install', '--ignore-scripts', '--store-dir=../store', `--registry=http://localhost:${REGISTRY_MOCK_PORT}`]) + fs.rmSync('pnpm-lock.yaml') + const { allProjects, selectedProjectsGraph } = await readProjects(process.cwd(), [{ namePattern: 'project-1' }]) await deploy.handler({ @@ -73,6 +91,26 @@ test('deploy', async () => { expect(fs.existsSync('deploy/node_modules/.pnpm/file+project-3/node_modules/project-3/index.js')).toBeTruthy() expect(fs.existsSync('deploy/node_modules/.pnpm/file+project-3/node_modules/project-3/test.js')).toBeFalsy() expect(fs.existsSync('pnpm-lock.yaml')).toBeFalsy() // no changes to the lockfile are written + const project1Manifest = loadJsonFile('deploy/package.json') + expect(project1Manifest).toMatchObject({ + name: 'project-1', + main: 'publish-file-1.js', + dependencies: { + 'is-positive': '1.0.0', + 'project-2': '2.0.0', + }, + }) + expect(project1Manifest).not.toHaveProperty('publishConfig') + const project2Manifest = loadJsonFile('deploy/node_modules/.pnpm/file+project-2/node_modules/project-2/package.json') + expect(project2Manifest).toMatchObject({ + name: 'project-2', + main: 'publish-file-2.js', + dependencies: { + 'project-3': '2.0.0', + 'is-odd': '1.0.0', + }, + }) + expect(project2Manifest).not.toHaveProperty('publishConfig') }) test('deploy with dedupePeerDependents=true ignores the value of dedupePeerDependents', async () => {