🎨 Added classes to tags helper output

[brandishwar]

no issue

• Far easier to customize the tags helper output when the parts have CSS classes
• Avoids the need to write custom code to customize how tags look - unless you really want to

[coderabbitai]

Walkthrough

The pull request updates the tags helper functionality and its test cases. In the helper function, the import of the Handlebars-based template service has been removed and replaced with Lodash’s template function for generating HTML. The implementation now differentiates linked tags from non-linked ones by using separate functions. Additionally, prefixes, suffixes, and tag separators are now wrapped in <span> elements with defined class attributes. Corresponding test cases have been updated to verify the new HTML structure, including span-wrapped tag outputs and separators. No changes were made to the declarations of exported or public entities.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a1e1a2f and ab72ae9.

📒 Files selected for processing (2)

• ghost/core/core/frontend/helpers/tags.js (2 hunks)
• ghost/core/test/unit/frontend/helpers/tags.test.js (15 hunks)

🔇 Additional comments (5)

ghost/core/core/frontend/helpers/tags.js (4)

14-20: Well-structured template and class definitions!

The use of Lodash templates with predefined CSS classes improves maintainability and provides consistent styling hooks. The class names follow a clear naming convention with the post-tag prefix.

---

36-49: Clean and secure tag processing implementation!

The code properly:

• Separates linked and non-linked tag rendering
• Consistently applies CSS classes
• Escapes tag names to prevent XSS

---

51-59: Robust tag list processing with consistent styling!

The implementation correctly handles:

• Array slicing with proper index adjustments
• Consistent separator styling using the template

🧰 Tools

🪛 Biome (1.9.4)

[error] 51-51: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

---

61-77: Clean prefix/suffix implementation with consistent styling!

The code properly:

• Wraps prefix/suffix in styled spans only when needed
• Maintains consistent styling approach

ghost/core/test/unit/frontend/helpers/tags.test.js (1)

21-332: Excellent test coverage!

The test suite thoroughly verifies:

• All new CSS classes and HTML structure
• Various tag rendering scenarios
• Edge cases and visibility options

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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>, 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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.

[cathysarisky]

Hey @brandishwar ! Welcome to the Ghost repo! :)

I don't work for Ghost.org - I'm a community contributor like you.

I think that improving the output of {{tags}} with some useful classes is a great idea. However, I think the execution needs work. My big concern: You're changing the current behavior, in a way that's absolutely going to break some themes. In particular, currently the output of {{tags}} may safely be used as a plain string, in places where HTML tags are not appropriate.

Here's what I suggest instead (but again, I'm not the core team):

• Retain the existing behavior as much as possible. If your changes require changing the results of an existing test, carefully ask why, and what might break.
• New span wrapping should be controlled by an argument. (wrapAll ?)
• There should be tests for the new functionality (set to true, not set, set to false)

It's probably safe to add a new class to existing tags in the presence of autolink, but new html is definitely going to mess something up for someone.

[brandishwar]

Here's what I suggest instead (but again, I'm not the core team):

• Retain the existing behavior as much as possible. If your changes require changing the results of an existing test, carefully ask why, and what might break.
• New span wrapping should be controlled by an argument. (wrapAll ?)
• There should be tests for the new functionality (set to true, not set, set to false)

And one scenario where someone would want to keep the plaintext (with autolink Off) is... metadata beyond what sites are supported by default in Ghost. Probably other scenarios for it that I'm not considering.

Wrapping this behind a new parameter I think is the best way to go - Off by default, of course. So I'll withdraw this PR while I get that sorted.

[cathysarisky]

Sounds like a plan!