Skip to content

docs: update Node version requirement to address package manager issues #5811

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

Merged
merged 1 commit into from
Aug 24, 2020

Conversation

haoqunjiang
Copy link
Member

@haoqunjiang haoqunjiang commented Aug 22, 2020

It's recommended to use NPM v6 with Node.js v8, because:

  1. Some of the upstream packages may accidentally introduce dependencies
    that require Node.js 10+ in the engines field. This only leads to a
    warning in NPM but will break Yarn.

  2. NPM v5 does not support dependency versions starting with npm:,
    so it can't support Vue 3 related features in Vue CLI.

Also added recommendation for n as the Node version manager because nvm sometimes causes problems for Vue CLI UI.

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Code style update
  • Refactor
  • Docs
  • Underlying tools
  • Other, please describe:

Does this PR introduce a breaking change? (check one)

  • Yes
  • No

Other information:

It's recommended to use NPM v6 with Node.js v8, because:

1. Some of the upstream packages may accidentally introduce dependencies
that requires Node.js 10+ in the `engines` field. This only leads to a
warning in NPM but will break Yarn.

2. NPM v5 does not support dependency versions starting with `npm:`,
so it can't support Vue 3 related features in Vue CLI.
@haoqunjiang haoqunjiang merged commit d9d191f into vuejs:master Aug 24, 2020
@haoqunjiang haoqunjiang deleted the docs-compatibility branch August 24, 2020 07:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant