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

docs: correct pnpm command #8763

Merged
merged 2 commits into from
Jun 24, 2022
Merged

docs: correct pnpm command #8763

merged 2 commits into from
Jun 24, 2022

Conversation

cassler
Copy link
Contributor

@cassler cassler commented Jun 24, 2022

Description

This PR corrects the pnpm getting started example. The instructions provided for scaffolding a template in pnpm do not set the template as expected. The extra double-dash is not needed in pnpm 7.

  • pnpm create vite -- --template vue <-- will prompt to select framework
  • pnpm create vite --template vue <-- correctly sets framework without prompting.

Additional context


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.

The instructions provided for scaffolding a template in pnpm do you set the template as expected. The extra double-dash is not needed in pnpm 7.

- `pnpm create vite -- --template vue` <--  asks to select framework
- `pnpm create vite --template vue` <-- correctly sets framework without prompting.
@netlify
Copy link

netlify bot commented Jun 24, 2022

Deploy Preview for vite-docs-main canceled.

Name Link
🔨 Latest commit c126dbf
🔍 Latest deploy log https://app.netlify.com/sites/vite-docs-main/deploys/62b606097523fb00082573ee

@bluwy
Copy link
Member

bluwy commented Jun 24, 2022

Good catch! Would be great to update https://github.com/vitejs/vite/blob/main/packages/create-vite/README.md too

@patak-dev patak-dev changed the title docs(guide): corrected pnpm command docs: correct pnpm command Jun 24, 2022
@patak-dev patak-dev merged commit 8108b1b into vitejs:main Jun 24, 2022
@patak-dev
Copy link
Member

Thanks!

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.

3 participants