jellydn / hurl.nvim

Hurl.nvim is a Neovim plugin designed to run HTTP requests directly from `.hurl` files. Elevate your API development workflow by executing and viewing responses without leaving your editor.
https://gyazo.com/19492e8b5366cec3f22d5fd97a63f37a
MIT License
129 stars 14 forks source link

feat: add xml type for response formatting and highlight #181

Closed javoscript closed 2 weeks ago

javoscript commented 2 weeks ago

WHAT

Add support for XML response content types.

WHY

Though not as common as HTML or JSON APIs, XML is still widely used.

Handling it as generic text works currently, but no response formatting or syntax highlighting is being done.

HOW

Adding the relevant function utils.is_xml_response(content_type) and type handling for formatting (with tidy command) and syntax highlighting the response.

Probably a more generic and extensible way of allowing plugin users to configure custom formatting commands for different response types would be better. But, in this case I didn't want to change too much the internal logic of the plugin, just add support for XML.

Screenshots (if appropriate):

A formatted and syntax highlighted response example:

Screenshot 2024-07-09 at 12 11 13

Types of changes

Checklist:

Summary by CodeRabbit

codesandbox[bot] commented 2 weeks ago

Review or Edit in CodeSandbox

Open the branch in Web EditorVS CodeInsiders
Open Preview

ellipsis-dev[bot] commented 2 weeks 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

changeset-bot[bot] commented 2 weeks ago

⚠️ No Changeset found

Latest commit: a94408cd675bae7141d89c2f20ed5daed4560ff0

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

coderabbitai[bot] commented 2 weeks ago

Walkthrough

The changes enhance the XML formatting capabilities in the Neovim plugin setup using hurl.nvim. New configurations for XML formatting using the tidy command were introduced, along with adjustments to the response handling logic to include XML responses. This improvement allows for better handling and formatting of XML content within the Neovim editor.

Changes

Files Change Summaries
README.md Added XML formatting configuration using tidy with options '-xml', '-i', '-q'.
doc/hurl.nvim.txt Added XML configuration block with formatting options using tidy.
lua/hurl/history.lua Added conditional branch to check and handle XML content type separately.
lua/hurl/init.lua Introduced new configuration option for XML with specific tidy arguments.
lua/hurl/main.lua Updated logic to handle XML responses separately based on content type.
lua/hurl/popup.lua Expanded type parameter options in M.show function to include 'xml'.
lua/hurl/split.lua Expanded type parameter options in M.show function to include 'xml'.
lua/hurl/utils.lua Added XML handling to util.format and new function util.is_xml_response.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Neovim
    participant Plugin as hurl.nvim
    participant Formatter as tidy

    User->>Neovim: Open XML file
    Neovim->>Plugin: Request to format XML
    Plugin->>Formatter: Execute tidy with -xml, -i, -q
    Formatter->>Plugin: Formatted XML
    Plugin->>Neovim: Display formatted XML
    Neovim->>User: Show formatted XML

Poem

In Neovim's quiet night,
XML shines so bright,
With tidy's gentle touch,
Formatting we love so much.
hurl now so wise and spry,
Handles XML on the fly.
Coders cheer, reaching high! 🌟🐇


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 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](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 weeks ago

@all-contributors add @javoscript for code.

allcontributors[bot] commented 2 weeks ago

@jellydn

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