feat: add support for peerDependencies in update process (#175)

Co-authored-by: Anthony Fu <[email protected]>

Author: productdevbook

README.md

@@ -70,10 +70,18 @@ taze --include lodash,webpack
 taze --include /react/ --exclude react-dom # regex is also supported
 ```
 
-### Lockedversion
+### Locked Versions
 
 Locked (fixed version without `^` or `~`) packages are skipped by default, use `taze --include-locked` or `taze -l` to show them.
 
+### Peer Dependencies
+
+Bumping version in `peerDependencies` is not enabled by default. Pass `--peer` option to include them in the update process.
+
+```bash
+taze --peer
+```
+
 ### Config file
 
 With `taze.config.js` file, you can configure the same options the command has.

src/cli.ts

@@ -34,6 +34,7 @@ cli
   .option('--group', 'group dependencies by source on display')
   .option('--include-locked, -l', 'include locked dependencies & devDependencies')
   .option('--timediff', 'show time difference between the current and the updated version')
+  .option('--peer', 'Include peerDependencies in the update process')
   .action(async (mode: RangeMode | undefined, options: Partial<CheckOptions>) => {
     if (mode) {
       if (!MODE_CHOICES.includes(mode)) {

src/io/packageJson.ts

@@ -1,18 +1,27 @@
-import type { CommonOptions, PackageMeta, RawDep } from '../types'
+import type { CommonOptions, DepType, PackageMeta, RawDep } from '../types'
 import { resolve } from 'pathe'
 import { builtinAddons } from '../addons'
 import { dumpDependencies, getByPath, parseDependencies, parseDependency, setByPath } from './dependencies'
 import { readJSON, writeJSON } from './packages'
 
-const depsFields = [
+const allDepsFields = [
   'dependencies',
   'devDependencies',
+  'peerDependencies',
   'optionalDependencies',
   'packageManager',
   'pnpm.overrides',
   'resolutions',
   'overrides',
-] as const
+] as const satisfies DepType[]
+
+function isDepFieldEnabled(key: DepType, options: CommonOptions): boolean {
+  if (options.depFields?.[key] === false)
+    return false
+  if (key === 'peerDependencies')
+    return !!options.peer
+  return true
+}
 
 export async function loadPackageJSON(
   relative: string,
@@ -23,19 +32,20 @@ export async function loadPackageJSON(
   const raw = await readJSON(filepath)
   const deps: RawDep[] = []
 
-  for (const key of depsFields) {
-    if (options.depFields?.[key] !== false) {
-      if (key === 'packageManager') {
-        if (raw.packageManager) {
-          const [name, version] = raw.packageManager.split('@')
-          // `+` sign can be used to pin the hash of the package manager, we remove it to be semver compatible.
-          deps.push(parseDependency(name, `^${version.split('+')[0]}`, 'packageManager', shouldUpdate))
-        }
-      }
-      else {
-        deps.push(...parseDependencies(raw, key, shouldUpdate))
+  for (const key of allDepsFields) {
+    if (!isDepFieldEnabled(key, options))
+      continue
+
+    if (key === 'packageManager') {
+      if (raw.packageManager) {
+        const [name, version] = raw.packageManager.split('@')
+        // `+` sign can be used to pin the hash of the package manager, we remove it to be semver compatible.
+        deps.push(parseDependency(name, `^${version.split('+')[0]}`, 'packageManager', shouldUpdate))
       }
     }
+    else {
+      deps.push(...parseDependencies(raw, key, shouldUpdate))
+    }
   }
 
   return [
@@ -59,9 +69,10 @@ export async function writePackageJSON(
 ) {
   let changed = false
 
-  depsFields.forEach((key) => {
-    if (options.depFields?.[key] === false)
-      return
+  for (const key of allDepsFields) {
+    if (!isDepFieldEnabled(key, options))
+      continue
+
     if (key === 'packageManager') {
       const value = Object.entries(dumpDependencies(pkg.resolved, 'packageManager'))[0]
       if (value) {
@@ -75,7 +86,7 @@ export async function writePackageJSON(
         changed = true
       }
     }
-  })
+  }
 
   if (changed) {
     for (const addon of (options.addons || builtinAddons)) {

src/types.ts

@@ -78,6 +78,10 @@ export interface CommonOptions {
    * Bypass cache
    */
   force?: boolean
+  /**
+   * Include peerDependencies in the update process
+   */
+  peer?: boolean
   /**
    * Override bumping mode for specific dependencies
    */

test/parseDependencies.test.ts

@@ -279,4 +279,34 @@ describe('parseDependencies', () => {
         ]
       `)
   })
+
+  it('parse package `peerDependencies`', () => {
+    const myPackage = {
+      name: '@taze/package1',
+      private: true,
+      peerDependencies: {
+        '@taze/not-exists': '^4.13.19',
+        '@typescript/lib-dom': 'npm:@types/web@^0.0.80',
+      },
+    }
+    const result = parseDependencies(myPackage, 'peerDependencies', () => true)
+    expect(result).toMatchInlineSnapshot(`
+      [
+        {
+          "currentVersion": "^4.13.19",
+          "name": "@taze/not-exists",
+          "parents": [],
+          "source": "peerDependencies",
+          "update": true,
+        },
+        {
+          "currentVersion": "npm:@types/web@^0.0.80",
+          "name": "@typescript/lib-dom",
+          "parents": [],
+          "source": "peerDependencies",
+          "update": true,
+        },
+      ]
+    `)
+  })
 })