feat: add NPM overrides field

antfu-collective · Nov 29, 2023 · d3ae886 · d3ae886
1 parent e2cae50
commit d3ae886
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 1 deletion.
diff --git a/src/io/packages.ts b/src/io/packages.ts
@@ -26,8 +26,12 @@ export async function writePackage(pkg: PackageMeta, options: CommonOptions) {
     ['dependencies', !options.dev],
     ['devDependencies', !options.prod],
     ['optionalDependencies', !options.prod && !options.dev],
+    // PNPM
     ['pnpm.overrides', !options.prod && !options.dev],
+    // YARN
     ['resolutions', !options.prod && !options.dev],
+    // NPM
+    ['overrides', !options.prod && !options.dev],
   ] as const
 
   depKeys.forEach(([key, shouldWrite]) => {
@@ -67,6 +71,7 @@ export async function loadPackage(relative: string, options: CommonOptions, shou
       ...parseDependencies(raw, 'optionalDependencies', shouldUpdate),
       ...parseDependencies(raw, 'pnpm.overrides', shouldUpdate),
       ...parseDependencies(raw, 'resolutions', shouldUpdate),
+      ...parseDependencies(raw, 'overrides', shouldUpdate),
     ]
   }
 

diff --git a/src/types.ts b/src/types.ts
@@ -3,7 +3,7 @@ import type { SortOption } from './utils/sort'
 
 export type RangeMode = 'default' | 'major' | 'minor' | 'patch' | 'latest' | 'newest'
 export type PackageMode = Omit<RangeMode, 'default'> | 'ignore'
-export type DepType = 'dependencies' | 'devDependencies' | 'peerDependencies' | 'optionalDependencies' | 'packageManager' | 'pnpm.overrides' | 'resolutions'
+export type DepType = 'dependencies' | 'devDependencies' | 'peerDependencies' | 'optionalDependencies' | 'packageManager' | 'pnpm.overrides' | 'resolutions' | 'overrides'
 export const DependenciesTypeShortMap = {
   dependencies: '',
   devDependencies: 'dev',

diff --git a/test/dumpDependencies.test.ts b/test/dumpDependencies.test.ts
@@ -47,4 +47,13 @@ describe('dumpDependencies', () => {
       }
     `)
   })
+
+  it('dump `overrides` type', () => {
+    const dump = dumpDependencies([getPackageBySource('overrides')], 'overrides')
+    expect(dump).toMatchInlineSnapshot(`
+      {
+        "@types/semver": "^7.3.12",
+      }
+    `)
+  })
 })