Skip to content

fix: known types issue #4

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.

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
merged 2 commits into from
May 24, 2025
Merged

fix: known types issue #4

merged 2 commits into from
May 24, 2025

Conversation

JounQin
Copy link
Member

@JounQin JounQin commented May 24, 2025

Important

Make resolve and resolveImport optional in LegacyResolver and refine LegacyResolverObject types for better flexibility and clarity.

  • Behavior:
    • resolve and resolveImport in LegacyResolver are now optional, allowing more flexible resolver configurations.
  • Types:
    • LegacyResolverObject split into LegacyNodeResolverObject, LegacyTsResolverObject, and LegacyWebpackResolverObject for clearer type definitions.
    • options in LegacyResolverObjectBase changed to unknown to accommodate various resolver options.

This description was created by Ellipsis for d74bf7f. You can customize this summary. It will automatically update as commits are pushed.

@JounQin JounQin self-assigned this May 24, 2025
@Copilot Copilot AI review requested due to automatic review settings May 24, 2025 16:19
@JounQin JounQin added bug Something isn't working types labels May 24, 2025
Copy link

changeset-bot bot commented May 24, 2025

🦋 Changeset detected

Latest commit: 7375ad5

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-context 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

Copy link

coderabbitai bot commented May 24, 2025

Warning

Rate limit exceeded

@JounQin has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 10 minutes and 19 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 59ad43d and 7375ad5.

📒 Files selected for processing (2)
  • .changeset/late-penguins-sip.md (1 hunks)
  • src/types.ts (1 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings

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
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.

Signed-off-by: JounQin <admin@1stg.me>
Copy link

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.

Copy link

pkg-pr-new bot commented May 24, 2025

Open in StackBlitz

npm i https://pkg.pr.new/un-ts/eslint-import-context@4

commit: 2bc6d94

Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR refines the legacy resolver type definitions to be more flexible and introduce specialized resolver object interfaces.

  • Made resolve and resolveImport methods optional in LegacyResolver
  • Changed options to a generic unknown on the base and added three specialized resolver object interfaces
  • Introduced a union type for LegacyResolverObject including both base and specialized variants

Copy link

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Important

Looks good to me! 👍

Reviewed everything up to d74bf7f in 1 minute and 6 seconds. Click for details.
  • Reviewed 59 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 4 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. src/types.ts:76
  • Draft comment:
    Changed 'resolve' and 'resolveImport' to optional. Ensure that consumers check for their existence to avoid runtime errors.
  • Reason this comment was not posted:
    Comment looked like it was already resolved.
2. src/types.ts:87
  • Draft comment:
    Renamed LegacyResolverObject to LegacyResolverObjectBase. Confirm that all external references have been updated accordingly.
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 0% <= threshold 50% This comment is asking the PR author to confirm that all external references have been updated, which violates the rule against asking the author to confirm or double-check things. It does not provide a specific code suggestion or point out a specific issue.
3. src/types.ts:89
  • Draft comment:
    Replaced union of specific options types with 'unknown'. This reduces type safety; if flexibility is needed, consider documenting expected shapes or retaining a union type.
  • Reason this comment was not posted:
    Comment looked like it was already resolved.
4. src/types.ts:96
  • Draft comment:
    New specialized resolver object interfaces (LegacyNodeResolverObject, LegacyTsResolverObject, LegacyWebpackResolverObject) were added. Verify that the union type discriminates correctly (using the 'name' field) for proper type narrowing.
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 0% <= threshold 50% The comment is asking the PR author to verify that the union type discriminates correctly, which is against the rules. It does not provide a specific suggestion or point out a specific issue with the code.

Workflow ID: wflow_ggjKIfpTAAqTOI83

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

Copy link

codecov bot commented May 24, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (59ad43d) to head (7375ad5).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main        #4   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            3         3           
  Lines           53        53           
  Branches        16        16           
=========================================
  Hits            53        53           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Contributor

Deploy preview for eslint-import-context ready!

✅ Preview
https://eslint-import-context-bh8ld7mkx-1stg.vercel.app

Built with commit 7375ad5.
This pull request is being automatically deployed with vercel-action

Copy link
Contributor

📊 Package size report   2%↑

File Before After
lib/index.d.cts 4.8 kB 12%↑5.4 kB
lib/types.d.ts 3.7 kB 14%↑4.2 kB
Total (Includes all files) 58.3 kB 2%↑59.5 kB
Tarball size 17.3 kB 0.7%↑17.4 kB
Unchanged files
File Size
lib/index.cjs 35.4 kB
lib/index.d.ts 351 B
lib/index.js 348 B
lib/index.js.map 418 B
lib/types.js 44 B
lib/types.js.map 102 B
lib/utils.d.ts 741 B
lib/utils.js 1.6 kB
lib/utils.js.map 1.4 kB
LICENSE 1.1 kB
package.json 3.4 kB
README.md 4.9 kB

🤖 This report was automatically generated by pkg-size-action

Copy link
Contributor

size-limit report 📦

Path Size
src/index.ts 184 B (0%)

@JounQin JounQin merged commit 085b227 into main May 24, 2025
40 checks passed
@JounQin JounQin deleted the fix/types branch May 24, 2025 16:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working types
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant