feat: more overloads plugin function typing

[kazupon]

Description

Linked Issues

Additional context

Summary by CodeRabbit

• New Features

  • Enhanced plugin system with improved support for plugins that have extension capabilities and typed dependency extensions, allowing for more precise extension typing and better type safety.

• Refactor

  • Updated type handling in plugins and related tests to reflect broader and more accurate extension context expectations.
  • Simplified type imports and annotations in the completion plugin for improved maintainability.

[coderabbitai]

Walkthrough

This change introduces new overloaded type signatures for the plugin function to support more precise typing of plugin extensions and dependency extensions. It updates related test assertions to match the expanded type expectations and adjusts type annotations in the plugin-completion package for improved extension context typing.

Changes

File(s)	Change Summary
packages/gunshi/src/plugin/core.ts	Added three new overloaded type signatures for the plugin function to support typed extensions and dependency extensions.
packages/gunshi/src/plugin/core.test.ts	Updated type assertions in tests to expect broader/intersected extension context types; imported ExtendContext type.
packages/plugin-completion/src/index.ts	Removed explicit return type annotation, updated plugin call to use new generic extension context typing, and simplified type handling.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant PluginFactory
    participant Plugin
    User->>PluginFactory: Call plugin<E, I, P>(options)
    PluginFactory->>Plugin: Create plugin with typed extensions and dependencies
    Plugin-->>User: Return PluginWithExtension or PluginWithoutExtension

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~15 minutes

Possibly related PRs

• fix(gunshi): fix type error plugin onExtension, when extension is not define #236: Adjusts plugin extension typing by ensuring the extension property is always defined and updates related test expectations, showing a related evolution of plugin extension typing and handling.

Suggested labels

feature

Poem

Hopping through code with a typist’s delight,
Extensions and overloads now fit just right.
Plugins are smarter, their types interlace,
Each context extension finds its right place.
With tests all updated, the future looks bright—
A rabbit’s new feature, typed up tight! 🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

---

📜 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 7677c60 and dd9e33c.

📒 Files selected for processing (1)

• packages/plugin-completion/src/index.ts (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• packages/plugin-completion/src/index.ts

⏰ 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). (2)

• GitHub Check: Test on Node.js 20
• GitHub Check: Cloudflare Pages

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feat/plugin-typing

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 generate unit tests to generate unit tests for 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.

[cloudflare-workers-and-pages]

Deploying gunshi with    Cloudflare Pages

Latest commit:	dd9e33c
Status:	✅  Deploy successful!
Preview URL:	https://78c5c358.gunshi.pages.dev
Branch Preview URL:	https://feat-plugin-typing.gunshi.pages.dev

View logs

[pkg-pr-new]

Open in StackBlitz

@gunshi/bone

npm i https://pkg.pr.new/@gunshi/bone@259

@gunshi/definition

npm i https://pkg.pr.new/@gunshi/definition@259

gunshi

npm i https://pkg.pr.new/gunshi@259

@gunshi/plugin

npm i https://pkg.pr.new/@gunshi/plugin@259

@gunshi/plugin-completion

npm i https://pkg.pr.new/@gunshi/plugin-completion@259

@gunshi/plugin-dryrun

npm i https://pkg.pr.new/@gunshi/plugin-dryrun@259

@gunshi/plugin-global

npm i https://pkg.pr.new/@gunshi/plugin-global@259

@gunshi/plugin-i18n

npm i https://pkg.pr.new/@gunshi/plugin-i18n@259

@gunshi/plugin-renderer

npm i https://pkg.pr.new/@gunshi/plugin-renderer@259

@gunshi/resources

npm i https://pkg.pr.new/@gunshi/resources@259

@gunshi/shared

npm i https://pkg.pr.new/@gunshi/shared@259

commit: dd9e33c