feat: a new setting for injecting workspace packages (#8836)

pnpm · Dec 5, 2024 · 6483b64 · 6483b64
1 parent b8bda0a
commit 6483b64
Show file tree

Hide file tree

Showing 19 changed files with 255 additions and 6 deletions.
diff --git a/.changeset/long-spiders-smoke.md b/.changeset/long-spiders-smoke.md
@@ -0,0 +1,15 @@
+---
+"@pnpm/resolve-dependencies": minor
+"@pnpm/package-requester": minor
+"@pnpm/store-controller-types": minor
+"@pnpm/lockfile.settings-checker": minor
+"@pnpm/resolver-base": minor
+"@pnpm/npm-resolver": minor
+"@pnpm/core": minor
+"@pnpm/lockfile.types": minor
+"@pnpm/config": minor
+"@pnpm/deps.status": minor
+"pnpm": minor
+---
+
+A new setting, `inject-workspace-packages`, has been added to allow hard-linking all local workspace dependencies instead of symlinking them. Previously, this behavior was achievable via the [`dependenciesMeta[].injected`](https://pnpm.io/package_json#dependenciesmetainjected) setting, which remains supported [#8836](https://github.com/pnpm/pnpm/pull/8836).
diff --git a/config/config/src/Config.ts b/config/config/src/Config.ts
@@ -148,6 +148,7 @@ export interface Config {
   reporter?: string
   aggregateOutput: boolean
   linkWorkspacePackages: boolean | 'deep'
+  injectWorkspacePackages?: boolean
   preferWorkspacePackages: boolean
   reverse: boolean
   sort: boolean

diff --git a/config/config/src/index.ts b/config/config/src/index.ts
@@ -147,6 +147,7 @@ export async function getConfig (opts: {
     'hoist-workspace-packages': true,
     'ignore-workspace-cycles': false,
     'ignore-workspace-root-check': false,
+    'inject-workspace-packages': false,
     'link-workspace-packages': false,
     'lockfile-include-tarball-url': false,
     'manage-package-manager-versions': true,

diff --git a/config/config/src/types.ts b/config/config/src/types.ts
@@ -42,6 +42,7 @@ export const types = Object.assign({
   'ignore-workspace-cycles': Boolean,
   'ignore-workspace-root-check': Boolean,
   'include-workspace-root': Boolean,
+  'inject-workspace-packages': Boolean,
   'legacy-dir-filtering': Boolean,
   'link-workspace-packages': [Boolean, 'deep'],
   lockfile: Boolean,

diff --git a/deps/status/src/checkDepsStatus.ts b/deps/status/src/checkDepsStatus.ts
@@ -46,6 +46,7 @@ export type CheckDepsStatusOptions = Pick<Config,
 | 'autoInstallPeers'
 | 'catalogs'
 | 'excludeLinksFromLockfile'
+| 'injectWorkspacePackages'
 | 'linkWorkspacePackages'
 | 'hooks'
 | 'peersSuffixMaxLength'
@@ -74,6 +75,7 @@ async function _checkDepsStatus (opts: CheckDepsStatusOptions): Promise<{ upToDa
   const {
     allProjects,
     autoInstallPeers,
+    injectWorkspacePackages,
     catalogs,
     excludeLinksFromLockfile,
     linkWorkspacePackages,
@@ -192,6 +194,7 @@ async function _checkDepsStatus (opts: CheckDepsStatusOptions): Promise<{ upToDa
 
     const assertCtx: AssertWantedLockfileUpToDateContext = {
       autoInstallPeers,
+      injectWorkspacePackages,
       config: opts,
       excludeLinksFromLockfile,
       linkWorkspacePackages,
@@ -272,6 +275,7 @@ async function _checkDepsStatus (opts: CheckDepsStatusOptions): Promise<{ upToDa
       logger.debug({ msg: 'The manifest is newer than the lockfile. Continuing check.' })
       await assertWantedLockfileUpToDate({
         autoInstallPeers,
+        injectWorkspacePackages,
         config: opts,
         excludeLinksFromLockfile,
         linkWorkspacePackages,
@@ -311,6 +315,7 @@ interface AssertWantedLockfileUpToDateContext {
   autoInstallPeers?: boolean
   config: CheckDepsStatusOptions
   excludeLinksFromLockfile?: boolean
+  injectWorkspacePackages?: boolean
   linkWorkspacePackages: boolean | 'deep'
   getManifestsByDir: () => Record<string, DependencyManifest>
   getWorkspacePackages: () => WorkspacePackages | undefined
@@ -359,6 +364,7 @@ async function assertWantedLockfileUpToDate (
 
   const outdatedLockfileSettingName = getOutdatedLockfileSetting(wantedLockfile, {
     autoInstallPeers: config.autoInstallPeers,
+    injectWorkspacePackages: config.injectWorkspacePackages,
     excludeLinksFromLockfile: config.excludeLinksFromLockfile,
     peersSuffixMaxLength: config.peersSuffixMaxLength,
     overrides: createOverridesMapFromParsed(parseOverrides(rootManifestOptions?.overrides ?? {}, config.catalogs)),

diff --git a/lockfile/fs/src/lockfileFormatConverters.ts b/lockfile/fs/src/lockfileFormatConverters.ts
@@ -65,6 +65,9 @@ export function convertToLockfileFile (lockfile: Lockfile, opts: NormalizeLockfi
   if (newLockfile.settings?.peersSuffixMaxLength === 1000) {
     newLockfile.settings = omit(['peersSuffixMaxLength'], newLockfile.settings)
   }
+  if (newLockfile.settings?.injectWorkspacePackages === false) {
+    delete newLockfile.settings.injectWorkspacePackages
+  }
   return normalizeLockfile(newLockfile, opts)
 }
 

diff --git a/lockfile/settings-checker/src/getOutdatedLockfileSetting.ts b/lockfile/settings-checker/src/getOutdatedLockfileSetting.ts
@@ -9,6 +9,7 @@ export type ChangedField =
   | 'settings.autoInstallPeers'
   | 'settings.excludeLinksFromLockfile'
   | 'settings.peersSuffixMaxLength'
+  | 'settings.injectWorkspacePackages'
   | 'pnpmfileChecksum'
 
 export function getOutdatedLockfileSetting (
@@ -22,6 +23,7 @@ export function getOutdatedLockfileSetting (
     excludeLinksFromLockfile,
     peersSuffixMaxLength,
     pnpmfileChecksum,
+    injectWorkspacePackages,
   }: {
     overrides?: Record<string, string>
     packageExtensionsChecksum?: string
@@ -31,6 +33,7 @@ export function getOutdatedLockfileSetting (
     excludeLinksFromLockfile?: boolean
     peersSuffixMaxLength?: number
     pnpmfileChecksum?: string
+    injectWorkspacePackages?: boolean
   }
 ): ChangedField | null {
   if (!equals(lockfile.overrides ?? {}, overrides ?? {})) {
@@ -60,5 +63,8 @@ export function getOutdatedLockfileSetting (
   if (lockfile.pnpmfileChecksum !== pnpmfileChecksum) {
     return 'pnpmfileChecksum'
   }
+  if (Boolean(lockfile.settings?.injectWorkspacePackages) !== Boolean(injectWorkspacePackages)) {
+    return 'settings.injectWorkspacePackages'
+  }
   return null
 }
diff --git a/lockfile/types/src/index.ts b/lockfile/types/src/index.ts
@@ -9,6 +9,7 @@ export interface LockfileSettings {
   autoInstallPeers?: boolean
   excludeLinksFromLockfile?: boolean
   peersSuffixMaxLength?: number
+  injectWorkspacePackages?: boolean
 }
 
 export interface Lockfile {

diff --git a/pkg-manager/core/src/getPeerDependencyIssues.ts b/pkg-manager/core/src/getPeerDependencyIssues.ts
@@ -46,7 +46,7 @@ export async function getPeerDependencyIssues (
   const projectsToResolve = Object.values(ctx.projects).map((project) => ({
     ...project,
     updatePackageManifest: false,
-    wantedDependencies: getWantedDependencies(project.manifest),
+    wantedDependencies: getWantedDependencies(project.manifest, opts),
   }))
   const preferredVersions = getPreferredVersionsFromLockfileAndManifests(
     ctx.wantedLockfile.packages,

diff --git a/pkg-manager/core/src/install/extendInstallOptions.ts b/pkg-manager/core/src/install/extendInstallOptions.ts
@@ -155,6 +155,7 @@ export interface StrictInstallOptions {
   peersSuffixMaxLength: number
   prepareExecutionEnv?: PrepareExecutionEnv
   returnListOfDepsRequiringBuild?: boolean
+  injectWorkspacePackages?: boolean
 }
 
 export type InstallOptions =

diff --git a/pkg-manager/core/src/install/index.ts b/pkg-manager/core/src/install/index.ts
@@ -361,6 +361,7 @@ export async function mutateModules (
     if (!opts.ignorePackageManifest) {
       const outdatedLockfileSettingName = getOutdatedLockfileSetting(ctx.wantedLockfile, {
         autoInstallPeers: opts.autoInstallPeers,
+        injectWorkspacePackages: opts.injectWorkspacePackages,
         excludeLinksFromLockfile: opts.excludeLinksFromLockfile,
         peersSuffixMaxLength: opts.peersSuffixMaxLength,
         overrides: overridesMap,
@@ -384,6 +385,7 @@ export async function mutateModules (
         autoInstallPeers: opts.autoInstallPeers,
         excludeLinksFromLockfile: opts.excludeLinksFromLockfile,
         peersSuffixMaxLength: opts.peersSuffixMaxLength,
+        injectWorkspacePackages: opts.injectWorkspacePackages,
       }
       ctx.wantedLockfile.overrides = overridesMap
       ctx.wantedLockfile.packageExtensionsChecksum = packageExtensionsChecksum
@@ -395,6 +397,7 @@ export async function mutateModules (
         autoInstallPeers: opts.autoInstallPeers,
         excludeLinksFromLockfile: opts.excludeLinksFromLockfile,
         peersSuffixMaxLength: opts.peersSuffixMaxLength,
+        injectWorkspacePackages: opts.injectWorkspacePackages,
       }
     }
     if (
@@ -976,6 +979,7 @@ const _installInContext: InstallFunction = async (projects, ctx, opts) => {
       resolvePeersFromWorkspaceRoot: opts.resolvePeersFromWorkspaceRoot,
       supportedArchitectures: opts.supportedArchitectures,
       peersSuffixMaxLength: opts.peersSuffixMaxLength,
+      injectWorkspacePackages: opts.injectWorkspacePackages,
     }
   )
   if (!opts.include.optionalDependencies || !opts.include.devDependencies || !opts.include.dependencies) {
@@ -1355,6 +1359,7 @@ const installInContext: InstallFunction = async (projects, ctx, opts) => {
             includeDirect: opts.includeDirect,
             updateWorkspaceDependencies: false,
             nodeExecPath: opts.nodeExecPath,
+            injectWorkspacePackages: opts.injectWorkspacePackages,
           }
           for (const project of allProjectsLocatedInsideWorkspace) {
             if (!newProjects.some(({ rootDir }) => rootDir === project.rootDir)) {