Add possibility to customize request view mappings

yngwi commented 2 months ago

Closes issue #184 by adding a mappings section to the _HURL_GLOBAL_CONFIG table and using the individual mappings when registering mappings for the split and popup response views.

Note: vim.tbl_extend has been replaced with vim.tbl_deep_extend when merging the default and user provided config tables to ensure also partial custom user mappings are possible. This also affects other settings. I hope this is OK.

Summary by CodeRabbit

New Features
- Introduced customizable keyboard shortcuts for managing response popups in Neovim, including shortcuts for closing popups and navigating between them.
Documentation
- Updated documentation to reflect new configuration options and provide clearer guidance on customizing key mappings for the hurl.nvim plugin.
Refactor
- Enhanced flexibility in handling key mappings by using a centralized configuration object, improving maintainability and configurability of popup behavior.

codesandbox[bot] commented 2 months ago

Review or Edit in CodeSandbox

Open the branch in Web Editor • VS Code • Insiders
Open Preview

changeset-bot[bot] commented 2 months ago

⚠️ No Changeset found

Latest commit: 8d6a369c9bef3f9576c2f5474b41159d8a898349

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

ellipsis-dev[bot] commented 2 months ago

Your free trial has expired. To keep using Ellipsis, sign up at https://app.ellipsis.dev for $20/seat/month or reach us at help@ellipsis.dev

coderabbitai[bot] commented 2 months ago

Walkthrough

This update enhances the Neovim configuration for the hurl.nvim plugin by introducing a centralized mappings table. This new feature defines intuitive keyboard shortcuts for managing response popups and split views, improving user interaction. Key actions like closing popups or navigating between panels are now customizable, streamlining the overall user experience and making the plugin more adaptable.

Changes

Files	Change Summary
`README.md`, `doc/hurl.nvim.txt`	Added a new `mappings` section for defining default key bindings for closing and navigating response popups. Updated documentation for customization.
`lua/hurl/init.lua`	Introduced a `mappings` table in `default_config` for keyboard shortcuts. Changed configuration merging from `vim.tbl_extend` to `vim.tbl_deep_extend`.
`lua/hurl/popup.lua`, `lua/hurl/split.lua`	Refactored key mappings to use `_HURL_GLOBAL_CONFIG` for flexibility and configurability, enhancing maintainability of popup controls.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HurlPopup
    participant GlobalConfig

    User->>HurlPopup: Press 'q'
    HurlPopup->>GlobalConfig: Check mapping for close
    GlobalConfig-->>HurlPopup: Return close mapping
    HurlPopup->>User: Close the popup

🐰 In a world of keys, so bright and fine,
The rabbit hops, with joy in line.
Mappings now dance, a customizable spree,
Closing and navigating, oh what glee!
With each little press, a wish comes true,
Hurl's magic unfolds, just for you! 🌟

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

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

jellydn commented 2 months ago

@all-contributors add @yngwi for code,doc.

allcontributors[bot] commented 2 months ago

@jellydn

I've put up a pull request to add @yngwi! :tada:

jellydn / hurl.nvim