Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change to open url in new tab #409

Merged
merged 1 commit into from
Nov 15, 2024
Merged

Change to open url in new tab #409

merged 1 commit into from
Nov 15, 2024

Conversation

devleejb
Copy link
Member

@devleejb devleejb commented Nov 14, 2024

What this PR does / why we need it:

  • Change to open url in new tab

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?:


Additional documentation:


Checklist:

  • Added relevant tests or not required
  • Didn't break anything

Summary by CodeRabbit

  • New Features

    • Enhanced Markdown link rendering to open in a new tab with security attributes.
    • Added support for handling link attributes in Markdown content.
  • Chores

    • Updated project dependencies to include markdown-it-link-attributes.

Copy link
Contributor

coderabbitai bot commented Nov 14, 2024

Walkthrough

The pull request introduces changes to the @codepair/frontend project by adding a new dependency, "markdown-it-link-attributes": "^4.0.1", to the package.json file. Additionally, the Preview.tsx component is updated to utilize the mila plugin for the MarkdownIt instance, enhancing link rendering by setting specific attributes for links. A new module declaration for "markdown-it-link-attributes" is also added in global.d.ts to support the new functionality.

Changes

File Change Summary
frontend/package.json Added new dependency: "markdown-it-link-attributes": "^4.0.1"
frontend/src/components/editor/Preview.tsx Added import for mila and updated MarkdownIt instance to use mila for link attributes.
frontend/src/global.d.ts Added module declaration: declare module "markdown-it-link-attributes";

Possibly related PRs

  • Add hyperlink creation feature #332: This PR adds a new dependency to package.json, similar to the main PR which also adds a new dependency, indicating a potential overlap in dependency management.
  • Add markdown render checkbox plugin #400: This PR introduces a new dependency and modifies the Preview.tsx file to integrate a new plugin into the MarkdownIt instance, which is directly related to the changes in the main PR that also involve modifications to Preview.tsx for Markdown rendering.

🐇 In the code, I hop and play,
New links open in a bright new way!
With mila by my side,
Security is my guide,
In Markdown, I frolic and sway! 🌟

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.

frontend/src/components/editor/Preview.tsx

Oops! Something went wrong! :(

ESLint: 9.14.0

ESLint couldn't find an eslint.config.(js|mjs|cjs) file.

From ESLint v9.0.0, the default configuration file is now eslint.config.js.
If you are using a .eslintrc.* file, please follow the migration guide
to update your configuration file to the new format:

https://eslint.org/docs/latest/use/configure/migration-guide

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


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 17b2bc2 and c253a5e.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (3)
  • frontend/package.json (1 hunks)
  • frontend/src/components/editor/Preview.tsx (2 hunks)
  • frontend/src/global.d.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
  • frontend/package.json
  • frontend/src/components/editor/Preview.tsx
  • frontend/src/global.d.ts

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

@devleejb
Copy link
Member Author

@blurfx I wonder that if this afftects to IncrementalDOM. Could your review this change?

@devleejb devleejb requested a review from blurfx November 14, 2024 04:03
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🧹 Outside diff range and nitpick comments (1)
frontend/src/components/editor/Preview.tsx (1)

14-14: Consider using a more descriptive import name

The import name mila could be renamed to something more descriptive like markdownItLinkAttributes to better indicate its purpose.

-import mila from "markdown-it-link-attributes";
+import markdownItLinkAttributes from "markdown-it-link-attributes";
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 462e21e and 17b2bc2.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (3)
  • frontend/package.json (1 hunks)
  • frontend/src/components/editor/Preview.tsx (2 hunks)
  • frontend/src/global.d.ts (1 hunks)
🔇 Additional comments (3)
frontend/src/global.d.ts (1)

4-4: LGTM! The module declaration is correctly added.

The declaration follows the established pattern for markdown-it plugins and is necessary for TypeScript type checking.

Let's verify the module usage:

✅ Verification successful

Module declaration is correctly added and properly utilized

The verification confirms:

  • The module is correctly imported in frontend/src/components/editor/Preview.tsx
  • It's properly configured to set target="_blank" for links
  • The dependency is properly declared in package.json
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the usage of markdown-it-link-attributes module
# Expected: Should find usage in Preview.tsx setting target="_blank" for links

# Search for imports of the module
echo "Checking module imports:"
rg "markdown-it-link-attributes"

# Search for link attribute configurations
echo -e "\nChecking link attribute configurations:"
rg -A 5 "target.*_blank"

Length of output: 992

frontend/package.json (2)

59-59: LGTM! Dependency addition aligns with PR objectives.

The addition of markdown-it-link-attributes is appropriate for implementing the "open in new tab" functionality for URLs in markdown content.


59-59: Verify package version security.

Let's verify the security of the markdown-it-link-attributes package.

✅ Verification successful

Package version 4.0.1 is secure and up-to-date

The verification shows:

  • Latest version is 4.0.1, which matches the version in package.json
  • No known security vulnerabilities found in GitHub's advisory database
  • Package has no dependencies, reducing the attack surface
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for security advisories and latest versions

# Check npm for latest versions and security advisories
echo "Checking npm registry for markdown-it-link-attributes..."
npm view markdown-it-link-attributes time --json | jq 'to_entries | .[-1].key'

# Check for known vulnerabilities
echo "Checking for known vulnerabilities..."
gh api graphql -f query='
{
  securityVulnerabilities(first: 5, ecosystem: NPM, package: "markdown-it-link-attributes") {
    nodes {
      advisory {
        summary
        severity
        publishedAt
      }
      vulnerableVersionRange
      firstPatchedVersion {
        identifier
      }
    }
  }
}'

# Check package dependencies
echo "Checking package dependencies..."
npm view markdown-it-link-attributes dependencies --json

Length of output: 790

frontend/src/components/editor/Preview.tsx Outdated Show resolved Hide resolved
Copy link
Member

@blurfx blurfx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems there is no problem with incremental updating. lgtm

@devleejb devleejb merged commit 7eb889b into main Nov 15, 2024
2 checks passed
@devleejb devleejb deleted the url-new-tab branch November 15, 2024 15:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants