opensource/code-server
1
0
Fork 0
mirror of https://github.com/coder/code-server.git synced 2025-08-02 22:58:50 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: remove references to installing with yarn in favor of npm (#5518)

Browse Source
This commit is contained in:
Edouard Vincent
2022-08-30 10:00:11 -07:00
committed by GitHub
parent 6262c7a0bf
commit ef3f4e82b2
6 changed files with 37 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/npm.md
View File

@ -20,6 +20,11 @@ If you're installing code-server via `npm`, you'll need to install additional
dependencies required to build the native modules used by VS Code. This article
includes installing instructions based on your operating system.
> **WARNING**: Do not use `yarn` to install code-server. Unlike `npm`, it does not respect
> lockfiles for distributed applications. It will instead use the latest version
> available at installation time - which might not be the one used for a given
> code-server release, and [might lead to unexpected behavior](https://github.com/coder/code-server/issues/4927).
## Node.js version
We use the same major version of Node.js shipped with Code's remote, which is
@ -72,7 +77,7 @@ Proceed to [installing](#installing)
## FreeBSD
```sh
pkg install -y git python npm-node16 yarn-node16 pkgconf
pkg install -y git python npm-node16 pkgconf
pkg install -y libinotify
```
@ -85,8 +90,7 @@ Installing code-server requires all of the [prerequisites for VS Code developmen
Next, install code-server with:
```bash
yarn global add code-server
# Or: npm install -g code-server
npm install --global code-server --unsafe-perm
code-server
# Now visit http://127.0.0.1:8080. Your password is in ~/.config/code-server/config.yaml
```
@ -96,8 +100,7 @@ A `postinstall.sh` script will attempt to run. Select your terminal (e.g., Git b
If the `code-server` command is not found, you'll need to [add a directory to your PATH](https://www.architectryan.com/2018/03/17/add-to-the-path-on-windows-10/). To find the directory, use the following command:
```shell
yarn global bin
# Or: npm config get prefix
npm config get prefix
```
For help and additional troubleshooting, see [#1397](https://github.com/coder/code-server/issues/1397).
@ -107,8 +110,7 @@ For help and additional troubleshooting, see [#1397](https://github.com/coder/co
After adding the dependencies for your OS, install the code-server package globally:
```bash
yarn global add code-server
# Or: npm install -g code-server
npm install --global code-server --unsafe-perm
code-server
# Now visit http://127.0.0.1:8080. Your password is in ~/.config/code-server/config.yaml
```
@ -122,7 +124,7 @@ page](https://github.com/coder/code-server/discussions).
Occasionally, you may run into issues with Node.js.
If you install code-server using `yarn` or `npm`, and you upgrade your Node.js
If you install code-server using `npm`, and you upgrade your Node.js
version, you may need to reinstall code-server to recompile native modules.
Sometimes, you can get around this by navigating into code-server's `lib/vscode`
directory and running `npm rebuild` to recompile the modules.
@ -136,12 +138,12 @@ A step-by-step example of how you might do this is:
### Debugging install issues with npm
`yarn` suppresses logs when running `yarn global add`, so to debug installation issues, install with `npm` instead:
To debug installation issues, install with `npm`:
```shell
# Uninstall
npm uninstall -g --unsafe-perm code-server > /dev/null 2>&1
npm uninstall --global --unsafe-perm code-server > /dev/null 2>&1
# Install with logging
npm install --loglevel verbose -g --unsafe-perm code-server
npm install --loglevel verbose --global --unsafe-perm code-server
```