Skip to content

Update README.md to explain reason for BYO language server #102

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

Open
jpike88 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md to explain reason for BYO language server #102

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

## Overview

**Note: This project is currently a work in progress. Expect potential bugs or issues.**

This extension integrates the Angular Language Service into Zed. It uses the same options that Angular applies during compilation. To ensure the most accurate information, enable the `strictTemplates` option in the `tsconfig.json` of the angular project as shown in below:

```json
Expand All @@ -14,7 +12,11 @@ This extension integrates the Angular Language Service into Zed. It uses the sam

## Requirements

The extension does not bundle or download a language server. It runs the copy of `@angular/language-server` installed in your project, using the Node binary managed by Zed. Install it alongside `typescript` as dev dependencies:
**This extension does not bundle or download a language server. **

**Why?** the version of the angular language server is sensitive to your project's angular version. A misalignment between them can create all kinds of unexpected problems. If this extension were to maintain its own copy, it's almost guaranteeing that it will be a problem (this is especially the case for people who are maintaining multiple angular applications).

Therefore, this extension will look for and run the copy of `@angular/language-server` installed in your project. Install it alongside `typescript` as dev dependencies:

```sh
npm install --save-dev @angular/language-server typescript
Expand Down
Loading