Added initial HTML and Email rendering

[ronaldlangeveld]

refs https://linear.app/ghost/issue/PLG-335/setup-cta-card-rendering

• Added renderCallToActionNode function to handle CTA card rendering.
• Introduced ctaCardTemplate for web and emailCTATemplate for email outputs.
• The templates are dummy text in order to get the state ready for design.
• Updated tests to cover new rendering functionalities.
• Doesn't include visibility settings yet.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/kg-default-nodes/lib/nodes/call-to-action/CallToActionNode.js

Oops! Something went wrong! :(

ESLint: 8.57.0

Error: Failed to load parser '@babel/eslint-parser' declared in 'packages/kg-default-nodes/.eslintrc.js': Cannot find module '@babel/eslint-parser'
Require stack:

• /packages/kg-default-nodes/.eslintrc.js
  at Module._resolveFilename (node:internal/modules/cjs/loader:1248:15)
  at Function.resolve (node:internal/modules/helpers:145:19)
  at Object.resolve (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:2346:46)
  at ConfigArrayFactory._loadParser (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:3325:39)
  at ConfigArrayFactory._normalizeObjectConfigDataBody (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:3099:43)
  at _normalizeObjectConfigDataBody.next ()
  at ConfigArrayFactory._normalizeObjectConfigData (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:3040:20)
  at _normalizeObjectConfigData.next ()
  at ConfigArrayFactory.loadInDirectory (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:2886:28)
  at CascadingConfigArrayFactory._loadConfigInAncestors (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:3871:46)

packages/kg-default-nodes/lib/nodes/call-to-action/calltoaction-renderer.js

Oops! Something went wrong! :(

ESLint: 8.57.0

Error: Failed to load parser '@babel/eslint-parser' declared in 'packages/kg-default-nodes/.eslintrc.js': Cannot find module '@babel/eslint-parser'
Require stack:

• /packages/kg-default-nodes/.eslintrc.js
  at Module._resolveFilename (node:internal/modules/cjs/loader:1248:15)
  at Function.resolve (node:internal/modules/helpers:145:19)
  at Object.resolve (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:2346:46)
  at ConfigArrayFactory._loadParser (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:3325:39)
  at ConfigArrayFactory._normalizeObjectConfigDataBody (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:3099:43)
  at _normalizeObjectConfigDataBody.next ()
  at ConfigArrayFactory._normalizeObjectConfigData (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:3040:20)
  at _normalizeObjectConfigData.next ()
  at ConfigArrayFactory.loadInDirectory (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:2886:28)
  at CascadingConfigArrayFactory._loadConfigInAncestors (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:3871:46)

Walkthrough

This pull request introduces new functionality to the call-to-action nodes. The CallToActionNode class now has an exportDOM method that calls a newly imported renderer function to generate HTML output. Enhancements in the call-to-action renderer module add two template functions for standard and email formats, and the tests have been updated to verify HTML output, JSON serialization, and proper functionality across different data attributes.

Changes

File(s)	Change Summary
packages/kg-default-nodes/lib/.../CallToActionNode.js	Added import for renderCallToActionNode and introduced the exportDOM(options = {}) method that calls the renderer with the node instance.
packages/kg-default-nodes/lib/.../calltoaction-renderer.js	Introduced ctaCardTemplate and emailCTATemplate functions, and implemented renderCallToActionNode to render CTA content based on the provided options (email vs. web).
packages/kg-default-nodes/test/.../call-to-action.test.js	Updated tests with new cases for verifying exportDOM, updated exportOptions to include exportFormat: 'html', and added tests for JSON export/import and text content extraction.

Sequence Diagram(s)

sequenceDiagram
    participant Node as CallToActionNode
    participant Renderer as renderCallToActionNode
    participant Template as Template Functions

    Node->>Renderer: exportDOM(options)
    Renderer->>Renderer: Build dataset from node properties
    alt Target Email
        Renderer->>Template: emailCTATemplate(dataset)
    else Standard Web
        Renderer->>Template: ctaCardTemplate(dataset)
    end
    Template-->>Renderer: Return HTML content
    Renderer-->>Node: Return rendered HTML

Loading

Possibly related PRs

• Added URL input handling on CTA Card #1417: Introduced the renderCallToActionNode function, which is now utilized in the exportDOM method implementation.
• Added CallToAction Lexical Nodes #1412: Directly connected through the integration of the new export functionality with the rendering function.
• Added Button Colour Handling to CTA card #1418: Related via enhancements in the CallToActionNode class, including property updates affecting rendering behavior.

Poem

I hopped through lines of code with cheer,
Adding exports that now appear.
A node now sings in HTML light,
With email templates shining bright.
My bunny heart jumps through every change,
Celebrating code that’s smart and strange! 🐰💻

Tip

🌐 Web search-backed reviews and chat

• We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
• You can disable this feature by setting web_search: false in the knowledge_base settings.
• Please share any feedback in the Discord discussion.

---

📜 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 220af76 and ed78eff.

📒 Files selected for processing (3)

• packages/kg-default-nodes/lib/nodes/call-to-action/CallToActionNode.js (2 hunks)
• packages/kg-default-nodes/lib/nodes/call-to-action/calltoaction-renderer.js (1 hunks)
• packages/kg-default-nodes/test/nodes/call-to-action.test.js (4 hunks)

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