Skip to content
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

💪 Use type alias instead of comments #339

Merged
merged 1 commit into from
May 2, 2024
Merged

💪 Use type alias instead of comments #339

merged 1 commit into from
May 2, 2024

Conversation

lambdalisue
Copy link
Member

@lambdalisue lambdalisue commented May 2, 2024

It seems the latest deno fmt try to format the comments like

from /home/runner/work/denops.vim/denops.vim/denops/@denops-private/host.ts:
57 | -    success: string, // Callback ID
57 | +    success: string // Callback ID
58 | -    failure: string, // Callback ID
58 | +    ,
59 | +    failure: string // Callback ID
59 | -  ): Promise<void>;
60 | +    ,
61 | +  ): Promise<void>;

But the comment was mainly for documentation, so it is better to use type alias instead of comments.

Summary by CodeRabbit

  • Refactor
    • Enhanced type definitions for better clarity and maintenance in service interactions.

It seems the latest deno fmt try to format the comments like

from /home/runner/work/denops.vim/denops.vim/denops/@denops-private/host.ts:
57 | -    success: string, // Callback ID
57 | +    success: string // Callback ID
58 | -    failure: string, // Callback ID
58 | +    ,
59 | +    failure: string // Callback ID
59 | -  ): Promise<void>;
60 | +    ,
61 | +  ): Promise<void>;

But the comment was mainly for documentation, so it is better to use
type alias instead of comments.
Copy link

coderabbitai bot commented May 2, 2024

Walkthrough

The recent update in the codebase introduces a new type CallbackId, enhancing type safety by replacing generic string types for success and failure properties within the call method of the Service interface. This change is aimed at improving clarity and reducing potential errors related to callback identification.

Changes

File Path Change Summary
denops/.../host.ts Introduced CallbackId type; updated call method in Service

🐰✨
A hop of code, a leap of types,
Strings no more, CallbackId ignites.
Safer calls in the code's burrow,
A tiny change, a future thorough.
Cheers to the devs, with carrots to bite! 🥕
🌟🐇


Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between c727a3f and 37f0c3e.
Files selected for processing (1)
  • denops/@denops-private/host.ts (2 hunks)
Additional comments not posted (2)
denops/@denops-private/host.ts (2)

48-48: Introduction of CallbackId enhances type specificity and readability.


58-59: Using CallbackId for success and failure properties in dispatchAsync method improves semantic clarity and documentation.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

Copy link

codecov bot commented May 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.81%. Comparing base (c727a3f) to head (37f0c3e).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #339   +/-   ##
=======================================
  Coverage   89.81%   89.81%           
=======================================
  Files           9        9           
  Lines         648      648           
  Branches       61       61           
=======================================
  Hits          582      582           
  Misses         66       66           

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

@lambdalisue lambdalisue merged commit 9f0f941 into main May 2, 2024
9 checks passed
@lambdalisue lambdalisue deleted the fix-format branch May 2, 2024 20:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant