fix: require entry types, add module-sync entry

[JounQin]

https://arethetypeswrong.github.io/?p=eslint-import-resolver-typescript

Summary by CodeRabbit

• New Features

  • Enhanced module resolution with a new synchronization option to improve compatibility.
  • Introduced improved TypeScript support through dedicated type declaration integration.

• Chores

  • Streamlined CI/CD configurations by removing obsolete settings and updating automation permissions.
  • Refined package export structures and pre-release scripts for better module compatibility.
  • Optimized test configurations and dependency management, including an upgrade of the package manager version and adjustments based on Node.js version.
  • Updated .gitignore to exclude Plug'n'Play related files from version control.

[changeset-bot]

🦋 Changeset detected

Latest commit: a9bfe72

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

This PR includes changesets to release 1 package

Name	Type
eslint-import-resolver-typescript	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

[socket-security]

Report too large to display inline

View full report↗︎

[codesandbox-ci]

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.

[github-actions]

size-limit report 📦

Path	Size
lib/index.js	1.35 KB (0%)

[pkg-pr-new]

Open in Stackblitz

npm i https://pkg.pr.new/import-js/eslint-import-resolver-typescript@417

commit: a9bfe72

[coderabbitai]

Walkthrough

This pull request introduces several configuration and declaration changes. A new patch file is added to improve the eslint-import-resolver-typescript package by fixing the require entry and introducing a module-sync entry. Additional new files include a TypeScript declaration file re-exporting a module. Various configuration files are modified: removal of unused keys in a CodeSandbox JSON, enhancement of GitHub Actions workflow permissions, and cleanup of package scripts and exports in the main package.json. Test files are updated to modify Node version conditionals and adjust comments, along with Yarn version updates in the PnP configuration.

Changes

File(s)	Change Summary
.changeset/gold-rabbits-walk.md	Added new patch file for eslint-import-resolver-typescript to fix require entry types and add a module-sync entry.
.codesandbox/ci.json	Removed the "packages" key, simplifying the JSON configuration.
.github/workflows/release.yml	Introduced a new permissions section granting contents: write, id-token: write, and pull-requests: write permissions.
index.d.cts	Created a new declaration file that imports and re-exports the default export from ./lib/index.js using CommonJS syntax.
package.json	Removed "workspaces", restructured the "exports" property (splitting require into separate keys for import/module-sync), and updated the "prepare" script to run additional commands.
tests/importXResolverV3/eslint.config.cjs	Adjusted the conditional logic to export an empty object when Node’s version is ≤16 and removed an explanatory comment.
tests/pnp/*	Updated RAW_RUNTIME_STATE (added a dependency entry), refined @ts-expect-error comments in watch methods (adding "TBS"), added a yarnPath entry in .yarnrc.yml, and updated the packageManager version in package.json.

Sequence Diagram(s)

sequenceDiagram
    participant ESLint as ESLint Engine
    participant Config as ESLint Config Loader
    ESLint->>Config: Request configuration
    Config-->>Config: Check Node version condition
    alt Node version ≤ 16
        Config-->>ESLint: Return empty configuration {}
    else Node version > 16
        Config-->>ESLint: Return complete configuration object
    end

Loading

Poem

I'm a rabbit, hopping through the code,
Leaving trails of patches where new keys explode.
I nibble on exports and sprout fresh declarations,
Skipping through workflows with graceful validations.
In this garden of changes, I dance and I play,
Celebrating every update in my whimsical way! 🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c778faa and a9bfe72.

📒 Files selected for processing (2)

• tests/pnp/.gitignore (1 hunks)
• tests/pnp/.pnp.loader.mjs (0 hunks)

💤 Files with no reviewable changes (1)

• tests/pnp/.pnp.loader.mjs

✅ Files skipped from review due to trivial changes (1)

• tests/pnp/.gitignore

⏰ Context from checks skipped due to timeout of 90000ms (8)

• GitHub Check: Lint and Test with Node.js 20 on windows-latest
• GitHub Check: Lint and Test with Node.js 22 on windows-latest
• GitHub Check: Lint and Test with Node.js 18 on ubuntu-latest
• GitHub Check: Lint and Test with Node.js 18 on windows-latest
• GitHub Check: Lint and Test with Node.js 16 on windows-latest
• GitHub Check: Lint and Test with Node.js 18 on windows-latest
• GitHub Check: Lint and Test with Node.js 20 on windows-latest
• GitHub Check: Lint and Test with Node.js 22 on windows-latest

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[Copilot]

Pull Request Overview

This PR updates configuration to fix the handling of require entry types and adds support for a module-sync entry.

• Updates the Yarn configuration with a specific yarnPath.
• Adjusts the ESLint configuration to conditionally run based on the Node major version.
• Adds a new module export file, updates the release workflow permissions, and introduces a changeset note.

Reviewed Changes

Copilot reviewed 8 out of 13 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
tests/pnp/.yarnrc.yml	Adds a yarnPath setting for a specific Yarn release version.
tests/importXResolverV3/eslint.config.cjs	Updates the Node version condition and removes an inline comment.
index.d.cts	Introduces a new module export file.
.github/workflows/release.yml	Adds necessary permissions for the release workflow.
.changeset/gold-rabbits-walk.md	Updates the changeset note to reflect the new fixes and module-sync entry.

Files not reviewed (5)

• .codesandbox/ci.json: Language not supported
• package.json: Language not supported
• tests/pnp/.pnp.cjs: Language not supported
• tests/pnp/.pnp.loader.mjs: Language not supported
• tests/pnp/package.json: Language not supported

Comments suppressed due to low confidence (1)

tests/importXResolverV3/eslint.config.cjs:16

• [nitpick] Consider extracting the Node major version into a well-named constant (e.g., 'nodeMajor') before the conditional check to improve clarity.

process.versions.node.split('.')[0] <= 16

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (8)

tests/pnp/.pnp.cjs (4)

1462-1476: Clarification for TS Error Suppression in Hunk 3

The comments for the @ts-expect-error directives now include the note “reason TBS”. This improves clarity by indicating that the error suppression is intentional and explained (albeit briefly). For long-term maintainability, consider replacing TBS with a more descriptive explanation when further details become available.

---

1890-1904: Enhanced TS Error Directive in Hunk 4

The modifications update the error suppression comments in both watch and watchFile methods to include “reason TBS”. This consistency aids in understanding why TypeScript errors are ignored. It might be beneficial to expand TBS (e.g., “to be specified”) to a more detailed rationale once the underlying issue is fully addressed.

---

2593-2606: Consistent Update of TS Error Suppression in Hunk 5

Here, the updated @ts-expect-error - reason TBS comments are applied both in the baseFs.watch call and in the mount file system callback. This consistency is good; however, consider providing additional context (beyond “TBS”) if the error suppression becomes a recurring source of questions from future maintainers.

---

2610-2616: Harmonized TS Error Comment in Hunk 6

The change in this hunk also updates the @ts-expect-error comment to include “reason TBS”. This aligns with the other changes for similar functions throughout the file. For better long-term documentation, it may be worthwhile to eventually elaborate on the cause necessitating the error suppression.

.changeset/gold-rabbits-walk.md (1)

1-6: Document Patch for ESLint Import Resolver
This changeset documents the patch for fixing the require entry types and adding a new module-sync entry. The note clearly reflects the PR objective and provides context for the changes. Consider expanding on the “reason” behind the changes if additional details could help future maintainers.

tests/pnp/.pnp.loader.mjs (2)

896-902: Clarify TS Error Suppression in watch Method
The modified TS error suppression comment now reads

// @ts-expect-error - reason TBS

While it is good to include a reason, “TBS” (To Be Specified) is rather vague. Consider providing a more detailed explanation of the expected TypeScript error and why it can be safely ignored, to help future maintainers understand the context.

---

904-910: Clarify TS Error Suppression in watchFile Method
Similarly, the watchFile method now includes a TS error suppression comment with “reason TBS.” It would be beneficial to replace “TBS” with a more descriptive note that explains the underlying issue and justification for suppressing the error.

package.json (1)

60-60: Validate Prepare Script Chaining:
The updated "prepare" script now chains additional commands to change directories into tests/nestedPackageJson and run yarn, with a fallback (|| exit 0). Please review that this chaining (using && and ||) behaves as intended—especially considering that a failure in yarn will trigger an immediate exit with status 0, potentially masking errors during setup. Confirm whether this silent exit on error is acceptable for your workflow or if you’d like to handle failures more robustly.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 35d67f2 and c778faa.

⛔ Files ignored due to path filters (3)

• tests/nestedPackageJson/yarn.lock is excluded by !**/yarn.lock, !**/*.lock
• tests/pnp/.yarn/releases/yarn-4.8.0.cjs is excluded by !**/.yarn/**
• yarn.lock is excluded by !**/yarn.lock, !**/*.lock

📒 Files selected for processing (10)

• .changeset/gold-rabbits-walk.md (1 hunks)
• .codesandbox/ci.json (1 hunks)
• .github/workflows/release.yml (1 hunks)
• index.d.cts (1 hunks)
• package.json (2 hunks)
• tests/importXResolverV3/eslint.config.cjs (0 hunks)
• tests/pnp/.pnp.cjs (6 hunks)
• tests/pnp/.pnp.loader.mjs (2 hunks)
• tests/pnp/.yarnrc.yml (1 hunks)
• tests/pnp/package.json (1 hunks)

💤 Files with no reviewable changes (1)

• tests/importXResolverV3/eslint.config.cjs

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Lint and Test with Node.js 22 on windows-latest

🔇 Additional comments (8)

.codesandbox/ci.json (1)

1-5: Simplification via Removal of Unused "packages" Key
The removal of the "packages" property streamlines this JSON configuration. Make sure that no downstream tooling or integrations are still relying on this key. If it's no longer used, this change is appropriate.

.github/workflows/release.yml (1)

13-17: Addition of Explicit Workflow Permissions
The introduction of the permissions block with contents: write, id-token: write, and pull-requests: write clearly delineates the access scope for the release workflow. Please verify that these permissions are scoped as narrowly as needed and are aligned with your security policies.

tests/pnp/.pnp.cjs (2)

27-34: Configuration Dependency Addition in Hunk 1

The dependency list now includes a new entry ["pnp", "workspace:."], which fulfills the PR objective regarding fixing the require entry types. Please verify that the ordering of dependencies remains consistent with other configuration contexts in the project.

---

46-53: Consistent Package Dependency Addition in Hunk 2

In this block, the dependency entry ["pnp", "workspace:."] is similarly added alongside ["lodash.zip", "npm:4.2.0"]. Ensure that this new entry is correctly referenced wherever similar dependency configurations are expected.

tests/pnp/package.json (1)

4-4: Update Yarn Version in Package Manager Field
The packageManager field is updated to "[email protected]", which aligns with the corresponding Yarn binary path in the .yarnrc.yml file. Please verify that this new version is fully compatible with your project’s requirements and that there are no residual references to the old version.

index.d.cts (1)

1-3: New Declaration File for ESLint Import Resolver
This new declaration file imports the default export from ./lib/index.js and re‑exports it using CommonJS syntax (export =). This implementation correctly supports the updated require entry types and facilitates TypeScript’s type resolution.

tests/pnp/.yarnrc.yml (1)

4-5: Specify Yarn Binary Path for Yarn v4.8.0
The addition of the line

yarnPath: .yarn/releases/yarn-4.8.0.cjs

ensures that the correct Yarn version is used in the project. This change is consistent with the update in package.json. Please verify that the provided path is accurate and that the binary is correctly installed at that location.

package.json (1)

21-37: Revised Exports Structure Verification:
The new "exports" block now clearly distinguishes resolution strategies by defining separate entries for "import", "module-sync", "require", and "default". Please verify that the new "require" entry’s types path ("./index.d.cts") correctly points to the intended declaration file and that it integrates well with TypeScript’s module resolution.

[JounQin]

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

@coderabbitai You need to install dependencies with yarn + corepack.