syntax_sugar: add Highlight() function

[amitaifrey]

In most Markdown processors, ==%s== is used to highlight text so that it will appear with a yellow background. See
https://www.codecademy.com/resources/docs/markdown/highlight for more information and an example.

Summary by CodeRabbit

• New Features

  • Introduced a new text formatting feature that allows users to highlight text by surrounding it with double equals signs (e.g., "Hello" becomes "==Hello==").

• Tests

  • Added a new test to validate the functionality of the highlight feature, ensuring it produces the expected output.

[coderabbitai]

Walkthrough

The changes introduce a new function, Highlight, to the syntax_sugar.go file, which formats text by surrounding it with double equals signs. Additionally, a corresponding test function, TestHighlight, is added to syntax_sugar_test.go to validate the behavior of the Highlight function, ensuring it produces the expected output.

Changes

Files	Change Summary
.../syntax_sugar.go	New function Highlight(text string) string added.
.../syntax_sugar_test.go	New test function TestHighlight(t *testing.T) added to validate Highlight.

Poem

In the meadow, bright and spry,
A new function leaps to the sky!
With equals signs, it shines so bright,
Highlighting words, a joyful sight.
Hopping 'round, we cheer and play,
Emphasizing text in a fun new way! 🐇✨

---

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

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c2cf2f8 and 2d6a591.

Files selected for processing (2)

• syntax_sugar.go (1 hunks)
• syntax_sugar_test.go (1 hunks)

Additional comments not posted (2)

syntax_sugar.go (1)

49-53: LGTM!

The Highlight function correctly formats the text with double equals signs.

syntax_sugar_test.go (1)

114-127: LGTM!

The TestHighlight function correctly tests the Highlight function.

[nao1215]

@amitaifrey
Thank you for the clear explanation.
I merge this PR.