mirror of
https://github.com/angular/angular.git
synced 2026-09-14 13:54:52 +08:00
docs(vscode-extension): Update developer docs to match current setup
developer docs needed an update after moving to the angular/angular repo
This commit is contained in:
committed by
Kirill Cherkashin
parent
1bf1e7e2a7
commit
df2aaaaede
@@ -9,45 +9,22 @@ The dependencies of the `server` need to be duplicated in the root [`package.jso
|
||||
Therefore, if a new prod dependency is added to the server, it needs to be
|
||||
added to both [`package.json`](package.json) and [`server/package.json`](server/package.json).
|
||||
|
||||
## Navigating Projects in IDE
|
||||
## Building the extension .vsix
|
||||
|
||||
This repository contains multiple TypeScript projects, each with its own `tsconfig.json`.
|
||||
TypeScript's [project references](https://www.typescriptlang.org/docs/handbook/project-references.html) are used to handle the builds.
|
||||
As a result, some projects depend on the `.d.ts` output of their dependencies, like `client`
|
||||
and `server` depend on `common`. In order to navigate the projects in your IDE,
|
||||
you need to first build them by running
|
||||
If you'd like build the extension .vsix, run
|
||||
|
||||
```shell
|
||||
pnpm compile
|
||||
pnpm --filter=ng-template run package`
|
||||
```
|
||||
|
||||
If you'd like to force a clean build, you can delete the existing build artifacts
|
||||
by running
|
||||
|
||||
```shell
|
||||
pnpm bazel build //:npm --config=release
|
||||
```
|
||||
|
||||
## Formatting source code
|
||||
|
||||
This repository uses a common toolset provided in the angular organization for formatting, `ng-dev`. It is installed as a standard npm package,
|
||||
and can be run locally with `pnpm format`.
|
||||
The built vsix can be found in `./dist/bin/vscode-ng-language-service/ng-template.vsix`
|
||||
|
||||
## Test Local Changes in VSCode
|
||||
|
||||
Any changes made to the code in this repository or the upstream
|
||||
`@angular/language-service` package can be immediately tested out in a
|
||||
Any changes made to the code in this repository tested out in a
|
||||
development version of VSCode. The instructions below explain how to bring up
|
||||
a local instance and then install a local version of `@angular/language-service`.
|
||||
|
||||
### Check TypeScript version
|
||||
|
||||
First, make sure that the TypeScript version in `@angular/angular` is the same
|
||||
as that used in this repository. If not, update the following files:
|
||||
|
||||
1. `typescript` dependency in [`package.json`](package.json)
|
||||
2. `MIN_TS_VERSION` in [`version_provider.ts`](server/src/version_provider.ts)
|
||||
|
||||
### Launch VSCode in Extension Development Host
|
||||
|
||||
The scripts in `.vscode` directory are setup to automatically compile the code,
|
||||
@@ -55,27 +32,14 @@ then launch a new instance of VSCode with the Angular extension installed.
|
||||
To do so, either
|
||||
|
||||
1. Press F5, or
|
||||
2. Go to Run on the sidebar, select `Launch Client` from the task list
|
||||
2. Go to Run on the sidebar, select `VSCE: Launch Dev Client` from the task list
|
||||
|
||||
After the client is launched, you can optionally choose to attach a debugger to
|
||||
the local instance. To do so,
|
||||
|
||||
1. Go to Run on the sidebar, select `Attach to Server` from the task list
|
||||
1. Go to Run on the sidebar, select `VSCE: Attach to Server` from the task list
|
||||
|
||||
As a shortcut, there's also a task setup to automatically launch the client and
|
||||
attach the debugger in a single step. To do so,
|
||||
|
||||
1. Go to Run on the sidebar, select `Client + Server` from the task list
|
||||
|
||||
Note: Because we are building with bazel, any breakpoints need to be set on the files in `bazel-bin/...` or by adding a `debugger;` statement before compilation.
|
||||
|
||||
### Install Local `@angular/language-service`
|
||||
|
||||
If changes are made to the upstream language service package, they can also be
|
||||
tested locally. This involves building the NPM package, then updating the server
|
||||
dependency. To do so, run the following script from the `@angular/angular`
|
||||
repository.
|
||||
|
||||
```bash
|
||||
./packages/language-service/build.sh /path/to/vscode-ng-language-service
|
||||
```
|
||||
1. Go to Run on the sidebar, select `VSCE: Dev Client + Attach to Server` from the task list
|
||||
|
||||
Reference in New Issue
Block a user