🐛 Fix `helper/input` cancellation on Vim #273

mityu · 2024-11-11T11:50:10Z

Fix helper/input does not return null on / if the cursor is not at the end of line on Vim.

does not remove text between cursor and the tail of line, so if / is typed outside the end of line, unexpected text appears after ###DenopsStdHelperInputCancelled### and input cancellation fails.

Summary by CodeRabbit

New Features
- Updated key mappings for input cancellation using <Esc> and <C-c> to enhance user input handling.
Bug Fixes
- Added new test cases to improve coverage of input handling for <Esc> and <C-c> key sequences when pressed outside the end of the line, ensuring accurate recognition during input processing.

coderabbitai · 2024-11-11T11:50:18Z

Walkthrough

The changes in this pull request involve modifications to the ensurePrerequisites function in helper/input.ts. The cacheKey has been updated to reflect a new version, and key mappings for user input cancellation using <Esc> and <C-c> have been altered to change their behavior. Corresponding adjustments were made to the test cases in helper/input_test.ts to enhance coverage for these new input handling scenarios. The overall structure, logic, and exported types of the functions remain unchanged.

Changes

File	Change Summary
helper/input.ts	Updated `cacheKey` to `"denops_std/helper/input@3"` and modified key mappings for `<Esc>` and `<C-c>` in the `s:input` function. No changes to function logic or exported types.
helper/input_test.ts	Added new test cases for `input()` function to handle key presses outside the end of the line for `<Esc>` and `<C-c>`. No changes to exported entities.

Poem

In the meadow where bunnies play,
New mappings have come to brighten the day!
With <Esc> and <C-c> now refined,
Input flows smoothly, oh so aligned.
Hop and skip, let the keys dance,
In this code garden, we take a chance! 🐇✨

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between b255eee and 3459053.

📒 Files selected for processing (2)

helper/input.ts (2 hunks)
helper/input_test.ts (1 hunks)

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

helper/input.ts
helper/input_test.ts

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>, 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 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.

codecov · 2024-11-11T11:51:48Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.97%. Comparing base (ec2d3ab) to head (3459053).
Report is 2 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #273   +/-   ##
=======================================
  Coverage   85.97%   85.97%           
=======================================
  Files          63       63           
  Lines        3415     3415           
  Branches      299      299           
=======================================
  Hits         2936     2936           
  Misses        477      477           
  Partials        2        2

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

mityu · 2024-11-11T12:43:21Z

Should I update the version number in the cacheKey variable?

lambdalisue

Should I update the version number in the cacheKey variable?

Yes, please.

lambdalisue · 2024-11-11T14:06:16Z

helper/input_test.ts

            "CmdlineEnter",
            "*",
-            `call feedkeys("Hello world!\\<Esc>", "it")`,
+            `call feedkeys("Hello world!\\<Left>\\<Esc>", "it")`,


Please add a new test and keep the previous one.

Fix `helper/input` does not return `null` on <ESC>/<C-c> if the cursor is not at the end of line on Vim.

mityu · 2024-11-11T14:12:34Z

Updated the patch.

lambdalisue · 2024-11-11T16:11:01Z

Thanks a lot 🎉

mityu force-pushed the fix-helper-input-cancellation branch from 7a8f792 to b255eee Compare November 11, 2024 11:54

mityu changed the title ~~Fix helper/input cancellation on Vim~~ 🐛 Fix helper/input cancellation on Vim Nov 11, 2024

lambdalisue requested changes Nov 11, 2024

View reviewed changes

🐛 Fix helper/input cancellation on Vim

3459053

Fix `helper/input` does not return `null` on <ESC>/<C-c> if the cursor is not at the end of line on Vim.

mityu force-pushed the fix-helper-input-cancellation branch from b255eee to 3459053 Compare November 11, 2024 14:11

lambdalisue approved these changes Nov 11, 2024

View reviewed changes

lambdalisue merged commit 4d06caa into vim-denops:main Nov 11, 2024
10 checks passed

mityu deleted the fix-helper-input-cancellation branch November 11, 2024 16:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

🐛 Fix `helper/input` cancellation on Vim #273

🐛 Fix `helper/input` cancellation on Vim #273

Uh oh!

mityu commented Nov 11, 2024 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Nov 11, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

codecov bot commented Nov 11, 2024 •

edited

Loading

Uh oh!

mityu commented Nov 11, 2024

Uh oh!

lambdalisue left a comment

Uh oh!

lambdalisue Nov 11, 2024

Uh oh!

mityu commented Nov 11, 2024

Uh oh!

Uh oh!

lambdalisue commented Nov 11, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

🐛 Fix helper/input cancellation on Vim #273

🐛 Fix helper/input cancellation on Vim #273

Uh oh!

Conversation

mityu commented Nov 11, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Nov 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

codecov bot commented Nov 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

mityu commented Nov 11, 2024

Uh oh!

lambdalisue left a comment

Choose a reason for hiding this comment

Uh oh!

lambdalisue Nov 11, 2024

Choose a reason for hiding this comment

Uh oh!

mityu commented Nov 11, 2024

Uh oh!

Uh oh!

lambdalisue commented Nov 11, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

🐛 Fix `helper/input` cancellation on Vim #273

🐛 Fix `helper/input` cancellation on Vim #273

mityu commented Nov 11, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Nov 11, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codecov bot commented Nov 11, 2024 •

edited

Loading