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

Rewrite relative links when copying README #221

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

backflip
Copy link

@backflip backflip commented Jan 4, 2025

Following links from https://www.npmjs.com/package/@capsizecss/core sends me to 404 pages like https://github.com/seek-oss/capsize/blob/HEAD/packages/core/packages/metrics/README.md.

This PR extends the script copying the root's README to packages/core to rewrite relative links.

A local diff of the copied file (left: before, right: after):
image

@backflip backflip requested a review from a team as a code owner January 4, 2025 08:00
Copy link

changeset-bot bot commented Jan 4, 2025

⚠️ No Changeset found

Latest commit: 289c319

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

Comment on lines 14 to 16
const transformed = content.replace(
/]\((?!(#|https?:))/g,
`](${relativePath}/`,
Copy link
Contributor

Choose a reason for hiding this comment

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

Are you able to extend this to find and replace link references too? e.g. like these

@michaeltaranto
Copy link
Contributor

Thanks for opening this. It'd be good to extend the solution to cover link references which would also be broken.

@backflip
Copy link
Author

Thanks for opening this. It'd be good to extend the solution to cover link references which would also be broken.

Good point. I have changed the replacement function to replace every occurrence of packages/EXISTING_PACKAGE/.

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