Skip to content

chore(router): copy README file from workspace root #2502

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Kshao123
Copy link

add README to make the package look less bare on npm

https://docs.npmjs.com/about-package-readme-files

1

Copy link

netlify bot commented May 21, 2025

Deploy Preview for vue-router canceled.

Name Link
🔨 Latest commit 2ef2409
🔍 Latest deploy log https://app.netlify.com/projects/vue-router/deploys/682de4a40f9d0e00083b8cc1

Copy link
Contributor

@skirtles-code skirtles-code left a comment

Choose a reason for hiding this comment

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

This used to be handled in release.mjs, but it seems that was removed in e03edfd. Unclear whether that was intentional. Maybe the plan was to handle this like Pinia, which uses a separate, shorter version of its README.md for the npm release?

Not sure which approach posva would prefer for Vue Router.

Comment on lines +108 to +109
"prepack": "cp ../../README.md ./README.md",
"postpack": "rm ./README.md"
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think using cp and rm is portable. The package rimraf is already included, which is a portable version of rm. In the past I've used the copyfiles package as a portable replacement for cp.

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