Skip to content

Add 'overrides' property to package.json types #1287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sindresorhus merged 4 commits into from
Nov 4, 2025
+17 −0
Merged

Add 'overrides' property to package.json types #1287

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
399d1d8
Add 'overrides' property to package.json types
SBoudrias Oct 26, 2025
2b12c7e
Clarify 'overrides' property comment in package-json.d.ts
SBoudrias Oct 26, 2025
745dfb2
address Pr comments
SBoudrias Nov 3, 2025
e2d2d8e
address Pr comments
SBoudrias Nov 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions source/package-json.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,13 @@ export namespace PackageJson {
*/
type Dependency = Partial<Record<string, string>>;

/**
Recursive map describing selective dependency version overrides supported by npm.
*/
type DependencyOverrides = {
[packageName: string]: string | undefined | DependencyOverrides;
};

/**
Specifies requirements for development environment components such as operating systems, runtimes, or package managers. Used to ensure consistent development environments across the team.
*/
Expand Down Expand Up @@ -510,6 +517,11 @@ export namespace PackageJson {
*/
bundleDependencies?: string[];

/**
Overrides is used to support selective version overrides using npm, which lets you define custom package versions or ranges inside your dependencies.
*/
overrides?: DependencyOverrides;

/**
Engines that this package runs on.
*/
Expand Down
5 changes: 5 additions & 0 deletions test-d/package-json.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,11 @@ expectType<string[] | undefined>(packageJson.bundleDependencies);
expectType<string[] | undefined>(packageJson.bundledDependencies);
expectType<PackageJson.Dependency | undefined>(packageJson.resolutions);
expectType<PackageJson.WorkspaceConfig | string[] | undefined>(packageJson.workspaces);
expectAssignable<PackageJson['overrides']>({foo: '1.0.0'});
expectAssignable<PackageJson['overrides']>({foo: {'.': '1.0.0', bar: '1.0.0'}});
expectAssignable<PackageJson['overrides']>({baz: {bar: {foo: '1.0.0'}}});
expectAssignable<PackageJson['overrides']>({foo: undefined});
expectAssignable<PackageJson['overrides']>({foo: {bar: undefined}});
expectAssignable<PackageJson.DevEngineDependency>({
name: 'unicorn',
version: '>= 1.0.0',
Expand Down