refactor(ui): insufficient padding in codeblock components

[ashokasec]

What does this PR do?

Adds padding in the right side of the codeblock component

Fixes #2298

Type of change

• Bug fix (non-breaking change which fixes an issue)
• Chore (refactoring code, technical debt, workflow improvements)
• Enhancement (small improvements)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

How should this be tested?

Before

After

Checklist

Required

• Filled out the "How to test" section in this PR
• Read Contributing Guide
• Self-reviewed my own code
• Commented on my code in hard-to-understand areas
• Ran pnpm build
• Ran pnpm fmt
• Checked for warnings, there are none
• Removed all console.logs
• Merged the latest changes from main onto my branch with git pull origin main
• My changes don't cause any responsiveness issues

Appreciated

• If a UI change was made: Added a screen recording or screenshots to this PR
• Updated the Unkey Docs if changes were necessary

Summary by CodeRabbit

• New Features
  • Enhanced spacing in the rendered output of code blocks for improved readability.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 8633948

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.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

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]

📝 Walkthrough

Walkthrough

The changes in this pull request involve a minor modification to the CodeBlock component located in apps/www/components/template/codeblock.tsx. A new <span> element with the class "pl-6" has been added to enhance the spacing within the rendered output of the code block. This adjustment is intended to improve the visual presentation of code snippets without altering the existing functionality.

Changes

File Path	Change Summary
apps/www/components/template/codeblock.tsx	Added a <span> element with class "pl-6" for improved spacing in the Highlight component.

Assessment against linked issues

Objective	Addressed	Explanation
Improve padding in code block component on /templates page (#2298)	✅

Possibly related PRs

• fix: align single code block with the buttons #2154: The changes in this PR involve modifications to the BlogCodeBlock component, which is related to the CodeBlock component in the main PR, as both deal with rendering code blocks and involve layout adjustments.

Suggested labels

Feature, 🕹️ oss.gg, :joystick: 50 points, hacktoberfest

Suggested reviewers

• mcstepp
• chronark
• perkinsjr

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 0608fee and 8633948.

📒 Files selected for processing (1)

• apps/www/components/template/codeblock.tsx (1 hunks)

🧰 Additional context used

🪛 Biome

apps/www/components/template/codeblock.tsx

[error] 64-64: JSX elements without children should be marked as self-closing. In JSX, it is valid for any element to be self-closing.

Unsafe fix: Use a SelfClosingElement instead

(lint/style/useSelfClosingElements)

🔇 Additional comments (1)

apps/www/components/template/codeblock.tsx (1)

64-64: 🛠️ Refactor suggestion

Consider adjusting the padding approach

Thank you for addressing the padding issue in the codeblock component. While the added <span> element with "pl-6" class does increase spacing, there are a few points to consider:

1. The PR objective mentions enhancing padding on the right side, but "pl-6" adds left padding. Consider using "pr-6" for right padding or "px-6" for both sides.
2. Using an empty <span> for padding might not be the most semantic approach. Alternative methods could be:
   • Adding padding directly to the parent <div> element.
   • Using a CSS pseudo-element (e.g., ::after) to create the spacing.

Here's a suggested refactor that addresses these points:

- <span className="pl-6"></span>
+ <span className="pr-6" />

Alternatively, you could add padding to the parent <div>:

<div
  // biome-ignore lint/suspicious/noArrayIndexKey: I got nothing better right now
  key={`${line}-${i}`}
  {...getLineProps({ line })}
+ className="pr-6"
>
  {/* ... existing content ... */}
</div>

As pointed out by the static analysis tool, it's a good practice to use self-closing tags for elements without children. This improves code readability and follows JSX best practices.

To ensure this change doesn't affect other parts of the codebase, you may want to run the following command:

This will help verify that the padding change doesn't negatively impact other uses of the CodeBlock component.

🧰 Tools

🪛 Biome

[error] 64-64: JSX elements without children should be marked as self-closing. In JSX, it is valid for any element to be self-closing.

Unsafe fix: Use a SelfClosingElement instead

(lint/style/useSelfClosingElements)

---

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

[vercel]

@ashokasec is attempting to deploy a commit to the Unkey Team on Vercel.

A member of the Team first needs to authorize it.

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[github-actions]

Thank you for following the naming conventions for pull request titles! 🙏

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
engineering	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 10, 2024 7:43pm

[Suvankar621]

/assign

[oss-gg]

Assigned to @Suvankar621! Please open a draft PR linking this issue within 48h ⚠️ If we can't detect a PR from you linking this issue in 48h, you'll be unassigned automatically 🕹️ Excited to have you ship this 🚀

[ashokasec]

@Suvankar621 I saw you submitted another PR after the first one had already been submitted. It is typically not recommended to submit several PRs for the same issue without coordination. This may cause unnecessary confusions in the workflow.

Additionally, the UI changes in your PR don't seem to align well with the current design approach.

Thanks for understanding.

[shahilsinghyadav]

/assign

[oss-gg]

The /assign command can only be used on issues, not on pull requests.

[HSRAKTU]

/assign

[oss-gg]

The /assign command can only be used on issues, not on pull requests.