feat: support overrides field in pnpm-workspace.yaml

Author: antfu

src/commands/check/render.ts

@@ -88,8 +88,8 @@ export function renderChanges(
           .join(', ')
       : c.dim('no change')
 
-    const displayName = pkg.name?.startsWith('catalog:')
-      ? c.dim('catalog:') + c.yellow(pkg.name.slice('catalog:'.length))
+    const displayName = pkg.name?.startsWith('pnpm-catalog:')
+      ? c.dim('pnpm-catalog:') + c.yellow(pkg.name.slice('pnpm-catalog:'.length))
       : pkg.name
         ? c.cyan(pkg.name)
         : c.red('›') + c.dim(` ${filepath || ''}`.trimEnd())

src/io/pnpmWorkspaces.ts

@@ -17,12 +17,12 @@ export async function loadPnpmWorkspace(
 
   const catalogs: PnpmWorkspaceMeta[] = []
 
-  function createCatalogFromKeyValue(catalogName: string, map: Record<string, string>): PnpmWorkspaceMeta {
+  function createPnpmWorkspaceEntry(name: string, map: Record<string, string>): PnpmWorkspaceMeta {
     const deps: RawDep[] = Object.entries(map)
-      .map(([name, version]) => parseDependency(name, version, 'pnpm:catalog', shouldUpdate))
+      .map(([pkg, version]) => parseDependency(pkg, version, 'pnpm-workspace', shouldUpdate))
 
     return {
-      name: `catalog:${catalogName}`,
+      name,
       private: true,
       version: '',
       type: 'pnpm-workspace.yaml',
@@ -37,34 +37,47 @@ export async function loadPnpmWorkspace(
 
   if (raw.catalog) {
     catalogs.push(
-      createCatalogFromKeyValue('default', raw.catalog),
+      createPnpmWorkspaceEntry('pnpm-catalog:default', raw.catalog),
     )
   }
 
   if (raw.catalogs) {
     for (const key of Object.keys(raw.catalogs)) {
       catalogs.push(
-        createCatalogFromKeyValue(key, raw.catalogs[key]),
+        createPnpmWorkspaceEntry(`pnpm-catalog:${key}`, raw.catalogs[key]),
       )
     }
   }
 
+  if (raw.overrides) {
+    catalogs.push(
+      createPnpmWorkspaceEntry('pnpm-workspace:overrides', raw.overrides),
+    )
+  }
+
   return catalogs
 }
 
 export async function writePnpmWorkspace(
   pkg: PnpmWorkspaceMeta,
   _options: CommonOptions,
 ) {
-  const versions = dumpDependencies(pkg.resolved, 'pnpm:catalog')
+  const versions = dumpDependencies(pkg.resolved, 'pnpm-workspace')
 
   if (!Object.keys(versions).length)
     return
 
-  const catalogName = pkg.name.replace('catalog:', '')
-
-  for (const [key, targetVersion] of Object.entries(versions)) {
-    pkg.context.setPackage(catalogName, key, targetVersion)
+  if (pkg.name.startsWith('pnpm-catalog:')) {
+    const catalogName = pkg.name.replace('pnpm-catalog:', '')
+    for (const [key, targetVersion] of Object.entries(versions)) {
+      pkg.context.setPackage(catalogName, key, targetVersion)
+    }
+  }
+  else {
+    const paths = pkg.name.replace('pnpm-workspace:', '').split(/\./g)
+    for (const [key, targetVersion] of Object.entries(versions)) {
+      pkg.context.setPath([...paths, key], targetVersion)
+    }
   }
 
   if (pkg.context.hasChanged()) {

src/types.ts

@@ -14,7 +14,7 @@ export type DepType =
   | 'pnpm.overrides'
   | 'resolutions'
   | 'overrides'
-  | 'pnpm:catalog'
+  | 'pnpm-workspace'
 
 export const DependenciesTypeShortMap = {
   'packageManager': 'package-manager',
@@ -25,7 +25,7 @@ export const DependenciesTypeShortMap = {
   'resolutions': 'resolutions',
   'overrides': 'overrides',
   'pnpm.overrides': 'pnpm-overrides',
-  'pnpm:catalog': 'catalog',
+  'pnpm-workspace': 'pnpm-workspace',
 }
 
 export interface RawDep {

test/fixtures/pnpm-catalog/pnpm-workspace.yaml

@@ -13,3 +13,6 @@ catalogs:
   react18:
     react: ^18.2.0
     react-dom: ^18.2.0
+
+overrides:
+  vue: ~3.3.0

test/pnpmCatalog.test.ts

@@ -33,9 +33,10 @@ it('pnpm catalog', async () => {
 
   expect(result.packages.map(p => p.name)).toMatchInlineSnapshot(`
     [
-      "catalog:default",
-      "catalog:react17",
-      "catalog:react18",
+      "pnpm-catalog:default",
+      "pnpm-catalog:react17",
+      "pnpm-catalog:react18",
+      "pnpm-workspace:overrides",
       "@taze/monorepo-example",
     ]
   `)
@@ -48,7 +49,7 @@ it('pnpm catalog', async () => {
   ).toMatchInlineSnapshot(`
     [
       {
-        "name": "catalog:default",
+        "name": "pnpm-catalog:default",
         "packages": [
           [
             "react",
@@ -61,7 +62,7 @@ it('pnpm catalog', async () => {
         ],
       },
       {
-        "name": "catalog:react17",
+        "name": "pnpm-catalog:react17",
         "packages": [
           [
             "react",
@@ -74,7 +75,7 @@ it('pnpm catalog', async () => {
         ],
       },
       {
-        "name": "catalog:react18",
+        "name": "pnpm-catalog:react18",
         "packages": [
           [
             "react",
@@ -86,6 +87,15 @@ it('pnpm catalog', async () => {
           ],
         ],
       },
+      {
+        "name": "pnpm-workspace:overrides",
+        "packages": [
+          [
+            "vue",
+            "~3.3.0",
+          ],
+        ],
+      },
       {
         "name": "@taze/monorepo-example",
         "packages": [
@@ -133,12 +143,12 @@ describe('pnpm catalog update w/ yaml anchors and aliases', () => {
     const context = parsePnpmWorkspaceYaml(workspaceYamlContents)
     const pkg: PnpmWorkspaceMeta = {
       type: 'pnpm-workspace.yaml',
-      name: 'catalog:default',
+      name: 'pnpm-catalog:default',
       resolved: [
         // testing purpose
-        { name: 'react', targetVersion: '^18.3.1', source: 'pnpm:catalog', update: true, currentVersion: '^18.2.0', diff: 'minor' } as any,
+        { name: 'react', targetVersion: '^18.3.1', source: 'pnpm-workspace', update: true, currentVersion: '^18.2.0', diff: 'minor' } as any,
         // testing purpose
-        { name: 'react-dom', targetVersion: '^18.3.1', source: 'pnpm:catalog', update: true, currentVersion: '^18.2.0', diff: 'minor' } as any,
+        { name: 'react-dom', targetVersion: '^18.3.1', source: 'pnpm-workspace', update: true, currentVersion: '^18.2.0', diff: 'minor' } as any,
       ],
       raw: context.toJSON(),
       context,
@@ -151,10 +161,11 @@ describe('pnpm catalog update w/ yaml anchors and aliases', () => {
     await pnpmWorkspaces.writePnpmWorkspace(pkg, {})
 
     expect(output).toMatchInlineSnapshot(`
-    "catalog:
-      react: &foo ^18.3.1
-      react-dom: *foo
-    "`)
+      "catalog:
+        react: &foo ^18.3.1
+        react-dom: *foo
+      "
+    `)
   })
 
   it('should preserve yaml anchors and aliases with single string value, when anchor is defined in a separate field', async () => {
@@ -168,12 +179,12 @@ describe('pnpm catalog update w/ yaml anchors and aliases', () => {
       `
     const context = parsePnpmWorkspaceYaml(workspaceYamlContents)
     const pkg: PnpmWorkspaceMeta = {
-      name: 'catalog:default',
+      name: 'pnpm-catalog:default',
       resolved: [
         // testing purpose
-        { name: 'react', targetVersion: '^18.3.1', source: 'pnpm:catalog', update: true, currentVersion: '^18.2.0', diff: 'minor' } as any,
+        { name: 'react', targetVersion: '^18.3.1', source: 'pnpm-workspace', update: true, currentVersion: '^18.2.0', diff: 'minor' } as any,
         // testing purpose
-        { name: 'react-dom', targetVersion: '^18.3.1', source: 'pnpm:catalog', update: true, currentVersion: '^18.2.0', diff: 'minor' } as any,
+        { name: 'react-dom', targetVersion: '^18.3.1', source: 'pnpm-workspace', update: true, currentVersion: '^18.2.0', diff: 'minor' } as any,
       ],
       raw: context.toJSON(),
       context,
@@ -186,12 +197,13 @@ describe('pnpm catalog update w/ yaml anchors and aliases', () => {
     }
     await pnpmWorkspaces.writePnpmWorkspace(pkg, {})
     expect(output).toMatchInlineSnapshot(`
-    "defines:
-      - &react ^18.3.1
+      "defines:
+        - &react ^18.3.1
 
-    catalog:
-      react: *react
-      react-dom: *react
-    "`)
+      catalog:
+        react: *react
+        react-dom: *react
+      "
+    `)
   })
 })