fix(deps): replace `type-fest` w/ `@package-json/types` by stepankuzmin · Pull Request #434 · un-ts/eslint-plugin-import-x

stepankuzmin · 2025-10-20T14:01:55Z

PackageJson types are imported in published declaration files, which causes TypeScript compilation errors for consumers who don't have skipLibCheck enabled.

$ tsc

node_modules/eslint-plugin-import-x/lib/rules/no-extraneous-dependencies.d.ts:1:34 - error TS2307: Cannot find module 'type-fest' or its corresponding type declarations.

1 import type { PackageJson } from 'type-fest';
                                   ~~~~~~~~~~~

node_modules/eslint-plugin-import-x/lib/utils/read-pkg-up.d.ts:1:34 - error TS2307: Cannot find module 'type-fest' or its corresponding type declarations.

1 import type { PackageJson } from 'type-fest';

This PR replaces type-fest with the smaller @package-json/types package, ensuring the types are available to all consumers while reducing bundle size.

Changes

Replace type-fest with @package-json/types in dependencies
Update all source file imports to use @package-json/types
Remove type-fest dependency entirely (test imports are just strings, not actual code)

Type-fest types are imported in published declaration files, which causes TypeScript compilation errors for consumers who don't have skipLibCheck enabled. Moving type-fest to dependencies ensures the types are available to all consumers.

changeset-bot · 2025-10-20T14:02:00Z

🦋 Changeset detected

Latest commit: f372fee

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
eslint-plugin-import-x	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

coderabbitai · 2025-10-20T14:02:08Z

Walkthrough

Moved type-fest from devDependencies to dependencies in package.json and added a changeset file (.changeset/fix-type-fest-dependency.md) marking a patch release; no runtime code or exported API changes.

Changes

Cohort / File(s)	Summary
Dependency configuration `package.json`	Moved `type-fest` from `devDependencies` to `dependencies`, making its type declarations available to package consumers at install time.
Release metadata / changeset `.changeset/fix-type-fest-dependency.md`	Added a changeset documenting a patch release that accompanies the dependency adjustment.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

fix: incorrect top level types field for cjs #280 — Adjusts packaging/type declaration metadata (related change to package.json and type/package publishing behavior).

Suggested reviewers

JounQin

Poem

🐰 A hop, a tweak, the types now roam,

From dev to deps they find a home.
No code was changed, just paths set right,
Consumers sleep well through build-time night.
🥕✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Title Check	⚠️ Warning	The pull request title states "replace `type-fest` w/ `@package-json/types`", suggesting a replacement operation where one package is swapped for another. However, the actual changeset shows that `type-fest` is being moved from devDependencies to dependencies in package.json, with no mention of `@package-json/types` anywhere in the changes or PR objectives. The PR objectives explicitly confirm the intent is to move `type-fest` to dependencies to resolve TypeScript compilation errors for consumers, not to replace it with a different package. The title is therefore misleading and does not accurately reflect the actual change being made.	The title should be corrected to accurately describe the change, such as "fix(deps): move `type-fest` to dependencies" or similar wording that reflects the actual operation of relocating the package rather than replacing it. The reference to `@package-json/types` should be removed unless it is actually part of the changeset, which the provided information does not indicate.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

codesandbox-ci · 2025-10-20T14:02:26Z

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

ellipsis-dev

Important

Looks good to me! 👍

Reviewed everything up to f76f905 in 39 seconds. Click for details.

Reviewed 20 lines of code in 1 files
Skipped 0 files when reviewing.
Skipped posting 2 draft comments. View those below.
Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.

1. package.json:86

Draft comment:
Ensure 'type-fest' is now in dependencies so its types are available to consumers compiling declaration files.
Reason this comment was not posted:
Confidence changes required: 0% <= threshold 50% None

2. package.json:161

Draft comment:
Remove 'type-fest' from devDependencies since it's now provided as part of the production dependencies.
Reason this comment was not posted:
Confidence changes required: 0% <= threshold 50% None

Workflow ID: wflow_NjAokcgHQOVa9kmz

^{You can customize}^{by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.}

socket-security · 2025-10-20T14:02:40Z

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License
	@package-json/types@0.0.12

View full report

coderabbitai

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 27b175f and f76f905.

📒 Files selected for processing (1)

package.json (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

GitHub Check: Codacy Static Code Analysis

stepankuzmin · 2025-10-20T14:09:49Z

Also, since it's only PackageJson type that is beign used in the plugin, it might make sense to copy only this type and drop type-fest as a dependency.

SukkaW · 2025-10-21T06:37:56Z

Also, since it's only PackageJson type that is beign used in the plugin, it might make sense to copy only this type and drop type-fest as a dependency.

Agreed. So why not use a smaller dependency? I myself prefer https://www.npmjs.com/package/@package-json/types and has been using it in some of my personal projects (including my own ESLint config preset).

Replace type-fest with the smaller @package-json/types package since only the PackageJson type is used in published declaration files. This fixes TypeScript compilation errors for consumers who don't have skipLibCheck enabled while reducing bundle size. - Add @package-json/types to dependencies - Remove type-fest completely (no longer needed) - Update imports in src/rules/no-duplicates.ts, src/rules/no-extraneous-dependencies.ts, and src/utils/read-pkg-up.ts - Update changeset to reflect the replacement

stepankuzmin · 2025-10-23T09:29:41Z

Heads up, @SukkaW, I've switched to @package-json/types in this PR instead of type-fest.

SukkaW

LGTM

pkg-pr-new · 2025-10-23T14:28:25Z

Open in StackBlitz

npm i https://pkg.pr.new/eslint-plugin-import-x@434

commit: f372fee

stepankuzmin · 2025-10-29T14:14:56Z

Thanks, @SukkaW!

Is there anything we could do to ship it?

SukkaW · 2025-10-29T19:31:35Z

Thanks, @SukkaW!

Is there anything we could do to ship it?

It seems that CI is finished. Let's merge it!

mshima · 2026-03-12T00:52:16Z

@package-json/types is broken:

compile
> tsc

Error: node_modules/@package-json/types/dist/index.d.ts(277,5): error TS2411: Property 'node' of type 'string | undefined' is not assignable to 'string' index type 'string'.
Error: node_modules/@package-json/types/dist/index.d.ts(287,5): error TS2411: Property 'extends' of type 'string | undefined' is not assignable to 'string' index type 'string'.
Error: node_modules/@package-json/types/dist/index.d.ts(356,9): error TS2411: Property 'main' of type 'string | undefined' is not assignable to 'string' index type 'string'.
Error: node_modules/@package-json/types/dist/index.d.ts(357,9): error TS2411: Property 'browser' of type 'string | undefined' is not assignable to 'string' index type 'string'.

https://github.com/jhipster/generator-jhipster/actions/runs/22978922040/job/66714103187?pr=32663

@package-json/types was added in un-ts#434 as a replacement for type-fest, after type-fest leaked into published .d.ts files from devDependencies. However the swap introduced a new transitive dependency (~148k weekly downloads, low activity) for what is effectively three type annotations touching only 8 package.json fields. This commit removes the dependency entirely and replaces it with a small inline PackageJson interface in src/utils/package-json.ts that covers exactly the fields this plugin accesses: - name, version (read-pkg-up, no-duplicates) - dependencies, devDependencies, optionalDependencies, peerDependencies, bundleDependencies, bundledDependencies (no-extraneous-dependencies) Benefits: - Zero runtime/type dependencies added to consumers - No more exposure to upstream type breakages (e.g. TS2411 strict errors in @package-json/types that affect consumers with strict: true) - The interface is trivial to maintain; package.json dep fields are stable Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

fix(deps): move type-fest to dependencies

f76f905

Type-fest types are imported in published declaration files, which causes TypeScript compilation errors for consumers who don't have skipLibCheck enabled. Moving type-fest to dependencies ensures the types are available to all consumers.

ellipsis-dev Bot reviewed Oct 20, 2025

View reviewed changes

coderabbitai Bot reviewed Oct 20, 2025

View reviewed changes

Comment thread package.json Outdated

chore: add changeset for type-fest dependency fix

b328646

This comment was marked as outdated.

Sign in to view

SukkaW approved these changes Oct 23, 2025

View reviewed changes

SukkaW changed the title ~~fix(deps): move type-fest to dependencies~~ fix(deps): replace type-fest w/ @package-json/types Oct 23, 2025

SukkaW enabled auto-merge (squash) October 29, 2025 19:31

SukkaW disabled auto-merge October 29, 2025 19:33

SukkaW merged commit a3aae61 into un-ts:master Oct 29, 2025
45 checks passed

github-actions Bot mentioned this pull request Oct 29, 2025

chore: release eslint-plugin-import-x #407

Merged

coderabbitai Bot mentioned this pull request Mar 13, 2026

fix: move @package-json/types to devDependencies #470

Closed

nbouvrette mentioned this pull request Mar 15, 2026

fix(deps): replace @package-json/types with an inline minimal type #476

Open

coderabbitai Bot mentioned this pull request Mar 17, 2026

fix(#471): bump @package-json/types #478

Open

Uh oh!

Conversation

stepankuzmin commented Oct 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Uh oh!

changeset-bot Bot commented Oct 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

coderabbitai Bot commented Oct 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested reviewers

Poem

Pre-merge checks and finishing touches

Uh oh!

codesandbox-ci Bot commented Oct 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ellipsis-dev Bot left a comment

Choose a reason for hiding this comment

Uh oh!

socket-security Bot commented Oct 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

stepankuzmin commented Oct 20, 2025

Uh oh!

This comment was marked as outdated.

Uh oh!

SukkaW commented Oct 21, 2025

Uh oh!

stepankuzmin commented Oct 23, 2025

Uh oh!

SukkaW left a comment

Choose a reason for hiding this comment

Uh oh!

pkg-pr-new Bot commented Oct 23, 2025

Uh oh!

stepankuzmin commented Oct 29, 2025

Uh oh!

SukkaW commented Oct 29, 2025

Uh oh!

Uh oh!

mshima commented Mar 12, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

stepankuzmin commented Oct 20, 2025 •

edited

Loading

changeset-bot Bot commented Oct 20, 2025 •

edited

Loading

coderabbitai Bot commented Oct 20, 2025 •

edited

Loading

codesandbox-ci Bot commented Oct 20, 2025 •

edited

Loading

socket-security Bot commented Oct 20, 2025 •

edited

Loading