Skip to content

refactor (vscode): migrate from submodule to subtree #2476

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.

Sign up for GitHub

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 16 commits into from
Dec 17, 2020
Merged

refactor (vscode): migrate from submodule to subtree #2476

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
6c5c22e
chore: remove submodule
jsjoeio Dec 15, 2020
be3e823
Squashed 'lib/vscode/' content from commit e5a624b788
jsjoeio Dec 15, 2020
41bee49
Merge commit 'be3e8236086165e5e45a5a10783823874b3f3ebd' as 'lib/vscode'
jsjoeio Dec 15, 2020
51a2a2a
feat: apply patch after setting up subtree
jsjoeio Dec 15, 2020
25e6f84
feat: remove vscode scripts used with submodule
jsjoeio Dec 15, 2020
fcc16e5
refactor: move vscode.sh to postinstall
jsjoeio Dec 16, 2020
5830532
refactor: remove submodule code from steps scripts
jsjoeio Dec 16, 2020
e391f68
docs: update workflow and remove yarn vscode
jsjoeio Dec 16, 2020
b176e3e
refactor: update workflow in codetour
jsjoeio Dec 16, 2020
5b4fb69
docs: fix codetour and docs
jsjoeio Dec 16, 2020
65ff47b
docs: update based on feedback
jsjoeio Dec 16, 2020
be97f80
fix: add grep -v lib/vscode to git ls-files
jsjoeio Dec 16, 2020
fdde5a8
chore: format lint file
jsjoeio Dec 17, 2020
74d6d5e
fix: remove unnecessary grep line in fmt script
jsjoeio Dec 17, 2020
9a16e4e
docs: add section for updating vs code
jsjoeio Dec 17, 2020
98338e9
chore: fix linting error
jsjoeio Dec 17, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 0 additions & 9 deletions ci/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,15 +55,6 @@ This directory contains scripts used for the development of code-server.
- Runs tests.
- [./ci/dev/ci.sh](./dev/ci.sh) (`yarn ci`)
- Runs `yarn fmt`, `yarn lint` and `yarn test`.
- [./ci/dev/vscode.sh](./dev/vscode.sh) (`yarn vscode`)
- Ensures [./lib/vscode](../lib/vscode) is cloned, patched and dependencies are installed.
- [./ci/dev/patch-vscode.sh](./dev/patch-vscode.sh) (`yarn vscode:patch`)
- Applies [./ci/dev/vscode.patch](./dev/vscode.patch) to [./lib/vscode](../lib/vscode).
- [./ci/dev/diff-vscode.sh](./dev/diff-vscode.sh) (`yarn vscode:diff`)
- Diffs [./lib/vscode](../lib/vscode) into [./ci/dev/vscode.patch](./dev/vscode.patch).
- [./ci/dev/vscode.patch](./dev/vscode.patch)
- Our patch of VS Code, see [./doc/CONTRIBUTING.md](../doc/CONTRIBUTING.md#vs-code-patch).
- Generate it with `yarn vscode:diff` and apply with `yarn vscode:patch`.
- [./ci/dev/watch.ts](./dev/watch.ts) (`yarn watch`)
- Starts a process to build and launch code-server and restart on any code changes.
- Example usage in [./doc/CONTRIBUTING.md](../doc/CONTRIBUTING.md).
Expand Down
32 changes: 12 additions & 20 deletions doc/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,14 @@
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
# Contributing

- [Pull Requests](#pull-requests)
- [Requirements](#requirements)
- [Development Workflow](#development-workflow)
- [Build](#build)
- [Structure](#structure)
- [VS Code Patch](#vs-code-patch)
- [Currently Known Issues](#currently-known-issues)
- [Contributing](#contributing)
- [Pull Requests](#pull-requests)
- [Requirements](#requirements)
- [Development Workflow](#development-workflow)
- [Build](#build)
- [Structure](#structure)
- [VS Code Patch](#vs-code-patch)
- [Currently Known Issues](#currently-known-issues)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

Expand Down Expand Up @@ -42,7 +43,6 @@ of the dependencies code-server uses.

```shell
yarn
yarn vscode
yarn watch
# Visit http://localhost:8080 once the build is completed.
```
Expand All @@ -51,15 +51,11 @@ To develop inside an isolated Docker container:

```shell
./ci/dev/image/run.sh yarn
./ci/dev/image/run.sh yarn vscode
./ci/dev/image/run.sh yarn watch
```

`yarn watch` will live reload changes to the source.

If you introduce changes to the patch and you've previously built, you
must (1) manually reset VS Code and (2) run `yarn vscode:patch`.

## Build

You can build using:
Expand Down Expand Up @@ -89,7 +85,6 @@ The `release.sh` script is equal to running:

```shell
yarn
yarn vscode
yarn build
yarn build:vscode
yarn release
Expand Down Expand Up @@ -117,7 +112,7 @@ The `code-server` script serves an HTTP API for login and starting a remote VS C
The CLI code is in [./src/node](./src/node) and the HTTP routes are implemented in
[./src/node/app](./src/node/app).

Most of the meaty parts are in the VS Code patch, which we described next.
Most of the meaty parts are in the VS Code portion of the codebase under [./lib/vscode](./lib/vscode), which we described next.

### VS Code Patch

Expand All @@ -127,10 +122,9 @@ and exposed an API to the front-end for file access and all UI needs.

Over time, Microsoft added support to VS Code to run it on the web. They have made
the front-end open source, but not the server. As such, code-server v2 (and later) uses
the VS Code front-end and implements the server. You can find this in
[./ci/dev/vscode.patch](../ci/dev/vscode.patch) under the path `src/vs/server`.
the VS Code front-end and implements the server. We use a git subtree to be able to pull in VS Code's front-end. This code lives under [./lib/vscode](./lib/vscode).

Other notable changes in our patch include:
Some noteworthy changes in our codebase:

- Adding our build file, which includes our code and VS Code's web code
- Allowing multiple extension directories (both user and built-in)
Expand All @@ -146,12 +140,10 @@ Other notable changes in our patch include:

As the web portion of VS Code matures, we'll be able to shrink and possibly
eliminate our patch. In the meantime, upgrading the VS Code version requires
us to ensure that the patch is applied and works as intended. In the future,
us to ensure that our changes are applied and work as intended. In the future,
we'd like to run VS Code unit tests against our builds to ensure that features
work as expected.

To generate a new patch, run `yarn vscode:diff`

**Note**: We have [extension docs](../ci/README.md) on the CI and build system.

If the functionality you're working on does NOT depend on code from VS Code, please
Expand Down