improve npm/yarn install flow and add Windows 10 instructions #4015
Conversation
| You must have Node.js v12 (or later) installed. See | ||
| [#1633](https://github.com/cdr/code-server/issues/1633). |
There was a problem hiding this comment.
the npm.md page recommends node v14 and links to the same issue. Since the VS Code page mentions Node v14, I decided to remove this to be consistent
docs/npm.md
Outdated
| # npm Install Requirements | ||
| # yarn, npm |
There was a problem hiding this comment.
this PR suggests changing this page to an overall doc on installing with yarn, not just the prereqs
|
|
||
| ## Windows | ||
|
|
||
| Installing code-server requires all of the [prerequisites for VS Code development](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#prerequisites). When installing the C++ compiler tool chain, we recommend using "Option 2: Visual Studio 2019" for best results. |
There was a problem hiding this comment.
I ran into several issues installing windows-build-tools on a fresh Windows machine.
There was a problem hiding this comment.
This sounds kinda rough. I have some experience building stuff on Windows (actually doing Clang/LLVM + MSVC, which I think can be cross-compiled under Wine) so this might be something I can look into at some point...
There was a problem hiding this comment.
Yeah, installing Visual Studio is an unfortunate prerequisite, where npm install -g windows-build-tools would be a bit more understandable.
If you think it'd be helpful, I can do some more debugging with the npm method and see if there are any pointers I can leave in this doc, or put upstream.
|
✨ Coder.com for PR #4015 deployed! It will be updated on every commit.
|
Codecov Report
@@ Coverage Diff @@
## main #4015 +/- ##
=======================================
Coverage 63.51% 63.51%
=======================================
Files 36 36
Lines 1872 1872
Branches 379 379
=======================================
Hits 1189 1189
Misses 580 580
Partials 103 103 Continue to review full report at Codecov.
|
| @@ -12,6 +12,7 @@ | |||
| - [macOS](#macos) | |||
| - [Docker](#docker) | |||
| - [Helm](#helm) | |||
| - [Windows](#windows) | |||
There was a problem hiding this comment.
@BrunoQuaresma The preview for this PR seems to show the old build rather than the new one for some reason, maybe a missing env var in the build settings or something?
There was a problem hiding this comment.
|
|
||
| ## Windows | ||
|
|
||
| Installing code-server requires all of the [prerequisites for VS Code development](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#prerequisites). When installing the C++ compiler tool chain, we recommend using "Option 2: Visual Studio 2019" for best results. |
There was a problem hiding this comment.
This sounds kinda rough. I have some experience building stuff on Windows (actually doing Clang/LLVM + MSVC, which I think can be cross-compiled under Wine) so this might be something I can look into at some point...
Co-authored-by: Katie Horne <[email protected]>
Co-authored-by: Katie Horne <[email protected]>
Co-authored-by: Jonathan Yu <[email protected]>
The user flow for our npm docs were slightly confusing to me. While there was a dedicated page for the npm prerequisites, the install command itself was on install.md. This PR moves all of the steps to npm.md.
Windows 10 instructions were also added to this PR since it benefits from the improved docs structure, as there are quite a few "gotchas" with installing on Windows, which have now been documented. It also links to #1397, to centralize issues & discussions around additional support for Windows.