Skip to content

fix: same text and url#68

Open
Barbapapazes wants to merge 5 commits into
mainfrom
fix/same-text-url
Open

fix: same text and url#68
Barbapapazes wants to merge 5 commits into
mainfrom
fix/same-text-url

Conversation

@Barbapapazes

@Barbapapazes Barbapapazes commented Nov 2, 2023

Copy link
Copy Markdown
Contributor

🔗 Linked issue

❓ Type of change

  • 📖 Documentation (updates to the documentation, readme, or JSdoc annotations)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • 👌 Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

If a link looks like this [./example](./example), current implementation will return [https://raw.githubusercontent.com/example](./example), which is not the expected behavior.

This PR fixes this issue by checking replacing the link but not the text.

we could start adding some using testing to validate utils functions and edge cases

📝 Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

@Barbapapazes Barbapapazes self-assigned this Nov 2, 2023
@Barbapapazes Barbapapazes requested a review from pi0 November 2, 2023 15:36
Comment thread utils/markdown.ts Outdated
if (url) {
return match.replace(
`(${path})`,
`(${cdnBaseURL}/${path.replace(/^\.\//, "")})`,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Can you please double-check if we could fix/improve the regex above? generating new (${path}) seems hacky to replace while haven't tried it locally... Also what is a sample README URL we can test against?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yes, here some readme where there is the issue: #68 (comment)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I've updated the regexp to simplify code and avoid too many if.

@Barbapapazes Barbapapazes requested a review from pi0 January 10, 2024 09:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants