Standardize CTA component naming to CallToAction

[ronaldlangeveld]

ref https://linear.app/ghost/issue/PLG-351/standardise-naming-convention-for-call-to-action-components

• Renamed all CTAxxx files and components to CallToActionxxx

[coderabbitai]

Walkthrough

The pull request systematically renames call-to-action related components, constants, and command identifiers for clarity and consistency. The primary changes include renaming the CtaCard component to CallToActionCard along with its associated constants (CTA_COLORS to CALLTOACTION_COLORS and ctaColorPicker to callToActionColorPicker). In addition, import statements across several files have been updated to include explicit file extensions (e.g., .jsx) for better clarity. Similar renaming is propagated to the CallToActionNode class, where internal state variables and the insertion command identifier (INSERT_CTA_COMMAND to INSERT_CALL_TO_ACTION_COMMAND) are updated. The changes extend to the corresponding story file and related components, ensuring that the new naming conventions are consistently applied without affecting the underlying component logic.

Possibly related PRs

• Added button text editing to CTA Card #1416: Modifies the CtaCard component by adding functions for updating button text, directly linking to the renaming changes in the main PR.
• Integrated CTA Node Component into Koenig-Lexical #1413: Integrates the CallToActionNode class with references to the CallToActionCard component, showing overlapping code-level modifications.
• Added changing background colour handling to CTA Card #1419: Updates the CallToActionNodeComponent to use the newly renamed CallToActionCard, aligning closely with the changes in this PR.

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/koenig-lexical/src/components/ui/cards/CallToActionCard.jsx

Oops! Something went wrong! :(

ESLint: 8.57.0

ESLint couldn't find the config "react-app" to extend from. Please check that the name of the config is correct.

The config "react-app" was referenced from the config file in "/packages/koenig-lexical/.eslintrc.cjs".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

packages/koenig-lexical/src/nodes/CallToActionNode.jsx

Oops! Something went wrong! :(

ESLint: 8.57.0

ESLint couldn't find the config "react-app" to extend from. Please check that the name of the config is correct.

The config "react-app" was referenced from the config file in "/packages/koenig-lexical/.eslintrc.cjs".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

packages/koenig-lexical/src/components/ui/cards/CallToActionCard.stories.jsx

Oops! Something went wrong! :(

ESLint: 8.57.0

ESLint couldn't find the config "react-app" to extend from. Please check that the name of the config is correct.

The config "react-app" was referenced from the config file in "/packages/koenig-lexical/.eslintrc.cjs".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

• 2 others

---

📜 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 4455a7d and a275cd2.

📒 Files selected for processing (5)

• packages/koenig-lexical/src/components/ui/cards/CallToActionCard.jsx (7 hunks)
• packages/koenig-lexical/src/components/ui/cards/CallToActionCard.stories.jsx (1 hunks)
• packages/koenig-lexical/src/nodes/CallToActionNode.jsx (5 hunks)
• packages/koenig-lexical/src/nodes/CallToActionNodeComponent.jsx (4 hunks)
• packages/koenig-lexical/src/plugins/CallToActionPlugin.jsx (2 hunks)

✅ Files skipped from review due to trivial changes (1)

• packages/koenig-lexical/src/components/ui/cards/CallToActionCard.stories.jsx

🧰 Additional context used

🧠 Learnings (2)

packages/koenig-lexical/src/nodes/CallToActionNodeComponent.jsx (1)

Learnt from: ronaldlangeveld
PR: TryGhost/Koenig#1437
File: packages/koenig-lexical/src/nodes/CallToActionNodeComponent.jsx:0-0
Timestamp: 2025-02-06T04:48:22.660Z
Learning: In the CallToActionNodeComponent of Koenig, only the main content editor (htmlEditor) should be set as editable in the useEffect hook. The sponsor label editor's (sponsorLabelHtmlEditor) editability is handled separately as it's an optional feature.

packages/koenig-lexical/src/nodes/CallToActionNode.jsx (1)

Learnt from: ronaldlangeveld
PR: TryGhost/Koenig#1437
File: packages/koenig-lexical/src/nodes/CallToActionNodeComponent.jsx:0-0
Timestamp: 2025-02-06T04:48:22.660Z
Learning: In the CallToActionNodeComponent of Koenig, only the main content editor (htmlEditor) should be set as editable in the useEffect hook. The sponsor label editor's (sponsorLabelHtmlEditor) editability is handled separately as it's an optional feature.

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Node 20.11.1

🔇 Additional comments (4)

packages/koenig-lexical/src/plugins/CallToActionPlugin.jsx (1)

2-2: LGTM! Command renaming is consistent with the standardization effort.

The renaming of INSERT_CTA_COMMAND to INSERT_CALL_TO_ACTION_COMMAND aligns with the PR's objective of standardizing call-to-action component naming.

Also applies to: 18-18

packages/koenig-lexical/src/nodes/CallToActionNode.jsx (1)

11-11: LGTM! Variable renaming is thorough and consistent.

The renaming of variables from CTA to CallToAction prefix is comprehensive and maintains consistency:

• Command constant renamed to INSERT_CALL_TO_ACTION_COMMAND
• Editor state variables renamed to __callToActionHtmlEditor and __callToActionHtmlEditorInitialState
• Setup and population functions updated accordingly

Also applies to: 14-15, 44-44, 48-49

packages/koenig-lexical/src/nodes/CallToActionNodeComponent.jsx (1)

6-6: LGTM! Component and function renaming is consistent.

The changes maintain naming consistency:

• Updated import to use CallToActionCard
• Renamed function from reselectCTACard to reselectCallToActionCard

Also applies to: 121-121, 131-131

packages/koenig-lexical/src/components/ui/cards/CallToActionCard.jsx (1)

17-17: LGTM! Component and constant renaming is thorough and consistent.

The changes maintain naming consistency throughout the file:

• Renamed component from CtaCard to CallToActionCard
• Updated constants to use CALLTOACTION_COLORS and callToActionColorPicker
• Updated PropTypes and defaultProps declarations

Also applies to: 32-32, 70-70, 330-330, 359-359

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