vibinex / vibinex-server

This website will be the interface for the organizations to get AI insights about their own code and their software development teams.
https://vibinex.com
GNU General Public License v3.0
12 stars 12 forks source link

Fix multiline copy for docker instructions #415

Closed avikalpg closed 1 week ago

avikalpg commented 1 week ago

Bug

For multiline code in the docs, when the user copies the contents, they see extra newline characters in the command, which means the command does not work on directly pasting.

Resolution

Modified the CodeWithCopyButton component such that it displays the text exactly as it is provided. This way, the default copy functionality also works as expected.

Side-effects

As a result, we now don't need the extra newline characters in the docker-instructions component, which were earlier added to make sure that the code is displayed correctly.

Additional feature

Improved the responsiveness of the copy button for subsequent button presses. Earlier, once the button was pressed, the feedback was constantly displayed on the screen. And if the user clicked on the button again, there was no feedback about whether or not was the text correctly copied to the clipboard.

vercel[bot] commented 1 week ago

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

Name Status Preview Comments Updated (UTC)
team-monitor-website ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 5, 2024 5:57am
vibinex-dpu[bot] commented 1 week ago

Relevant users for this PR:

Contributor Name/Alias Relevance
tapishr 92.86%
avikalpg 7.14%

Auto assigning to relevant reviewers.

If you are a relevant reviewer, you can use the Vibinex browser extension to see parts of the PR relevant to you Relevance of the reviewer is calculated based on the git blame information of the PR. To know more, hit us up at contact@vibinex.com.

To change comment and auto-assign settings, go to your Vibinex settings page.

coderabbitai[bot] commented 1 week ago

[!IMPORTANT]

Review skipped

Review was skipped due to path filters

Files ignored due to path filters (1) * `package-lock.json` is excluded by `!**/package-lock.json`

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The recent updates include enhancements to the CodeWithCopyButton.tsx for improved text handling and user feedback on copy actions. The DockerInstructions.tsx has been simplified by streamlining the command output based on selected conditions. Additionally, the package.json file reflects a minor version increment, indicating small improvements or bug fixes.

Changes

File Path Change Summary
components/setup/CodeWithCopyButton.tsx Introduced text cleanup functionality, added useEffect for managing copy button state, and implemented a timer for feedback.
components/setup/DockerInstructions.tsx Modified selfHostingCode string template to simplify output by removing unnecessary environment variable settings.
package.json Updated version number from "1.2.12" to "1.2.13."

Poem

🐰 In the garden where code does play,
A button now shines, brightening the day.
Docker commands, once tangled and long,
Are now simple tunes, a sweet, cheerful song.
With each little change, we hop with delight,
Celebrating progress, our future is bright! 🌼


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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
vibinex-dpu[bot] commented 1 week ago

Relevant users for this PR:

Contributor Name/Alias Relevance
tapishr 81.25%
avikalpg 18.75%

Auto assigning to relevant reviewers.

If you are a relevant reviewer, you can use the Vibinex browser extension to see parts of the PR relevant to you Relevance of the reviewer is calculated based on the git blame information of the PR. To know more, hit us up at contact@vibinex.com.

To change comment and auto-assign settings, go to your Vibinex settings page.

sonarcloud[bot] commented 1 week ago

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

vibinex-dpu[bot] commented 1 week ago

Relevant users for this PR:

Contributor Name/Alias Relevance Approval
tapishr 81.25% :white_check_mark:
avikalpg 18.75% :x:

Total Coverage for PR: 81.25%

If you are a relevant reviewer, you can use the Vibinex browser extension to see parts of the PR relevant to you Relevance of the reviewer is calculated based on the git blame information of the PR. To know more, hit us up at contact@vibinex.com.

To change comment and auto-assign settings, go to your Vibinex repository settings page.

avikalpg commented 1 week ago

Screenshot would have been helpful

Next time daal dunga. I thought vercel deployment mein dekh paoge aaraam se.