Skip to content

docs: improve instructions for testing local changes against other packages#6084

Merged
patak-cat merged 3 commits intovitejs:mainfrom
benmccann:patch-4
Dec 12, 2021
Merged

docs: improve instructions for testing local changes against other packages#6084
patak-cat merged 3 commits intovitejs:mainfrom
benmccann:patch-4

Conversation

@benmccann
Copy link
Copy Markdown
Collaborator

Description

pnpm link has never worked for me and it might be less clear to list two ways. For pnpm.overrides, there was a key step missing, which is that Vite needs to be specified in the root package.json and not in a sub-package's package.json

Additional context

I've never been able to test Vite against SvelteKit up until now. Thanks to some help from @bluwy on Discord I finally got it figured out. I thought it'd make sense to update these docs for others


What is the purpose of this pull request?

  • Bug fix
  • New Feature
  • Documentation update
  • Other

Before submitting the PR, please make sure you do the following

  • Read the Contributing Guidelines.
  • Read the Pull Request Guidelines and follow the Commit Convention.
  • Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
  • Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123).
  • Ideally, include relevant tests that fail without this PR but pass with it.

patak-cat
patak-cat previously approved these changes Dec 12, 2021
@Niputi Niputi added the documentation Improvements or additions to documentation label Dec 12, 2021
@Niputi
Copy link
Copy Markdown
Contributor

Niputi commented Dec 12, 2021

isn't this option only for monorepos or mostly helpful for monorepo? pnpm link have worked for me for repos which are not monorepo

@benmccann
Copy link
Copy Markdown
Collaborator Author

This option will work on any pnpm repo. It does not need to be a monorepo with multiple packages - though it will also work in those circumstances

pnpm link have worked for me for repos which are not monorepo

Do you mean that it will work also for npm and yarn repos?

@Niputi
Copy link
Copy Markdown
Contributor

Niputi commented Dec 12, 2021

Do you mean that it will work also for npm and yarn repos?

dont think so. when I used pnpm link on a repo which didn't use pnpm, I changed to pnpm

This option will work on any pnpm repo. It does not need to be a monorepo with multiple packages

ah okay. thanks for letting me know

@patak-cat
Copy link
Copy Markdown
Member

Could you correct the linting error?

@patak-cat patak-cat merged commit 61d076a into vitejs:main Dec 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants