Skip to content

Commit

Permalink
fix review
Browse files Browse the repository at this point in the history
  • Loading branch information
goulvenclech committed Dec 21, 2024
1 parent 6c00787 commit a08bc23
Show file tree
Hide file tree
Showing 11 changed files with 19 additions and 41 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
<img alt="WEBlsp logo" src="https://raw.githubusercontent.com/web-lsp/weblsp/refs/heads/main/.github/assets/WEBlsp_logo_light.svg" />
</picture>

A Language Server for the Web.
A language server for the Web.

(Work In Progress) ~~It provides full-featured language support for HTML and CSS, including code completion, diagnostics, hover, and more.~~ Compliant with the [Language Server Protocol](https://microsoft.github.io/language-server-protocol/), WEBlsp is designed to work with any IDE that supports LSP. Build on top of ~~HTMLlsrs~~ and [CSSlsrs](https://github.com/web-lsp/weblsp/tree/main/crates/csslsrs), our own modern, fast, and reliable Language Services.
WEBlsp is an implementation of the [Language Server Protocol](https://microsoft.github.io/language-server-protocol/) (Work In Progress) ~~providing full-featured language support for HTML and CSS, including code completion, diagnostics, hover, and more.~~ It uses ~~HTMLlsrs~~ and [CSSlsrs](https://github.com/web-lsp/weblsp/tree/main/crates/csslsrs), our own modern and fast language services, designed to be integrated into language servers written in Rust or via WebAssembly.

## Quick Links

Expand Down Expand Up @@ -44,8 +44,8 @@ WEBlsp is a monorepo that contains the following crates (Rust packages):

| Name | Description | Crates.io | README |
| --------- | ------------------------ | --------- | --------------------------------------- |
| `weblsp` | The main Language Server | WIP | [README.md](./crates/weblsp/README.md) |
| `csslsrs` | CSS Language Service | WIP | [README.md](./crates/csslsrs/README.md) |
| `weblsp` | The main language server | WIP | [README.md](./crates/weblsp/README.md) |
| `csslsrs` | CSS language service | WIP | [README.md](./crates/csslsrs/README.md) |

### Packages

Expand All @@ -54,7 +54,7 @@ Additionally, WEBlsp contains the following NPM packages (JavaScript packages):
| Name | Description | NPM | README |
| --------------------- | ------------------------------------------ | --- | ----------------------------------------------------- |
| `vscode` | WEBlsp VSCode extension | WIP | [README.md](./packages/vscode/README.md) |
| `csslsrs` | WASM CSS Language Service | WIP | [README.md](./packages/csslsrs/README.md) |
| `csslsrs` | CSSlsrs API for JS/TS | WIP | [README.md](./packages/csslsrs/README.md) |
| `benchmark-wasm` | Benchmark WASM packages | WIP | [README.md](./packages/benchmark-wasm/README.md) |
| `ls-tests-benchmarks` | End-to-end tests and benchmarks for WEBlsp | WIP | [README.md](./packages/ls-tests-benchmarks/README.md) |

4 changes: 2 additions & 2 deletions crates/csslsrs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
<img alt="WEBlsp logo" src="https://raw.githubusercontent.com/web-lsp/weblsp/refs/heads/main/.github/assets/CSSlsrs_logo_light.svg" />
</picture>

A Language Service for CSS.
A language service for CSS.

(Work In Progress) ~~It provides full-featured language support for HTML and CSS, including code completion, diagnostics, hover, and more.~~ Compliant with the [Language Server Protocol](https://microsoft.github.io/language-server-protocol/), CSSlsrs can be integrated into Language Servers written in Rust or JavaScript/TypeScript (via WebAssembly). Thanks to [Biome](https://biomejs.dev/)'s parser, we deliver a fast and efficient language service, designed to improve your productivity when working with CSS.
(Work In Progress) ~~It provides full-featured language support, including code completion, diagnostics, hover, and more.~~ Compliant with the [Language Server Protocol](https://microsoft.github.io/language-server-protocol/), CSSlsrs can be integrated into language servers written in Rust or via WebAssembly. We use [Biome](https://biomejs.dev/)'s CSS parser behind the scenes.

## Quick Links

Expand Down
2 changes: 1 addition & 1 deletion crates/csslsrs/src/service.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ use crate::{
use lsp_types::{TextDocumentItem, Uri};
use serde::{Deserialize, Serialize};

/// The Language Service is the main entry point for interacting with CSSlsrs.
/// The language service is the main entry point for interacting with CSSlsrs.
/// It contains a DocumentStore, a PositionEncoding and a reference to the CSS data.
pub struct LanguageService {
pub(crate) store: DocumentStore,
Expand Down
6 changes: 2 additions & 4 deletions crates/weblsp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,9 @@
<img alt="WEBlsp logo" src="https://raw.githubusercontent.com/web-lsp/weblsp/refs/heads/main/.github/assets/WEBlsp_logo_light.svg" />
</picture>

A Language Server for the Web.
A language server for the Web.

(Work In Progress) ~~It provides full-featured language support for HTML and CSS, including code completion, diagnostics, hover, and more.~~ Compliant with the [Language Server Protocol](https://microsoft.github.io/language-server-protocol/), WEBlsp is designed to work with any IDE that supports LSP.

This crate contains the Language Server implementation in Rust. WEBlsp receives requests from the client, and dispatches them to the appropriate language service (e.g., [CSSlsrs](https://github.com/web-lsp/weblsp/tree/main/crates/csslsrs)), before sending the response back to the client.
WEBlsp is an implementation of the [Language Server Protocol](https://microsoft.github.io/language-server-protocol/), using ~~HTMLlsrs~~ and [CSSlsrs](https://github.com/web-lsp/weblsp/tree/main/crates/csslsrs) behind the scenes. (Work In Progress) ~~It provides full-featured language support for HTML and CSS, including code completion, diagnostics, hover, and more.~~

## Quick Links

Expand Down
4 changes: 2 additions & 2 deletions crates/weblsp/src/css.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ use std::error::Error;

use crate::requests::cast;

/// Initialize our CSS Language Service (CSSlsrs).
/// Initialize our CSS language service (CSSlsrs).
/// Used once at the start of the main loop, so the document store stays alive throughout the server's lifetime.
pub fn init_language_service() -> LanguageService {
LanguageService::default()
}

/// Handle WEBlsp's CSS requests. This function will be called by the main loop when a CSS request is received,
/// and will dispatch the request to our CSS Language Service (CSSlsrs).
/// and will dispatch the request to our CSS language service (CSSlsrs).
pub fn handle_request(
language_service: &mut LanguageService,
connection: &Connection,
Expand Down
2 changes: 1 addition & 1 deletion crates/weblsp/src/notifications.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ pub fn handle_notification(
}
"textDocument/didOpen" => {
// didOpen notification carry a textDocument item, which contains the document's URI and languageId.
// We can use this information to determine in which Language Service's store we should add the document.
// We can use this information to determine in which language service's store we should add the document.
let params: DidOpenTextDocumentParams =
serde_json::from_value(notification.params).unwrap();
match params.text_document.language_id.as_str() {
Expand Down
2 changes: 1 addition & 1 deletion justfile
Original file line number Diff line number Diff line change
Expand Up @@ -33,5 +33,5 @@ benchmark:
cargo bench
echo "Running WASM benchmarks..."
pnpm -C ./packages/benchmark-wasm run benchmark --run
echo "Running Language Server benchmarks..."
echo "Running language server benchmarks..."
pnpm -C ./packages/ls-tests-benchmarks run benchmark --run
6 changes: 2 additions & 4 deletions packages/csslsrs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,9 @@
<img alt="WEBlsp logo" src="https://raw.githubusercontent.com/web-lsp/weblsp/refs/heads/main/.github/assets/CSSlsrs_logo_light.svg" />
</picture>

A Language Service for CSS.
A language service for CSS.

(Work In Progress) ~~It provides full-featured language support for HTML and CSS, including code completion, diagnostics, hover, and more.~~ Compliant with the [Language Server Protocol](https://microsoft.github.io/language-server-protocol/), CSSlsrs can be integrated into Language Servers written in Rust or JavaScript/TypeScript (via WebAssembly). Thanks to [Biome](https://biomejs.dev/)'s parser, we deliver a fast and efficient language service, designed to improve your productivity when working with CSS.

This package contains the WASM implementation of [CSSlsrs](https://github.com/web-lsp/weblsp/tree/main/crates/csslsrs) for JavaScript/TypeScript Language Servers.
(Work In Progress) ~~It provides full-featured language support for HTML and CSS, including code completion, diagnostics, hover, and more.~~ Compliant with the [Language Server Protocol](https://microsoft.github.io/language-server-protocol/), this package contains JavaScript/TypeScript API for [CSSlsrs](https://github.com/web-lsp/weblsp/tree/main/crates/csslsrs) WASM exports.

## Quick Links

Expand Down
20 changes: 1 addition & 19 deletions packages/vscode/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,6 @@
<img alt="WEBlsp logo" src="https://raw.githubusercontent.com/web-lsp/weblsp/refs/heads/main/.github/assets/WEBlsp_logo_light.svg" />
</picture>

A Language Server for the Web, now in VSCode.
A language server for the Web, now in VSCode.

(Work In Progress) ~~It provides full-featured language support for HTML and CSS, including code completion, diagnostics, hover, and more.~~

## Quick Links

📖 [Main repository](https://github.com/web-lsp/weblsp/), with all related crates and packages.

🐛 [Report a bug](https://github.com/web-lsp/weblsp/issues), please read our [contributing guidelines](https://github.com/web-lsp/weblsp/blob/main/CONTRIBUTING.md) and [code of conduct](https://github.com/web-lsp/weblsp/blob/main/CODE_OF_CONDUCT.md) first.

🚨 [Report a security vulnerability](https://github.com/web-lsp/weblsp/security/advisories/new), and be sure to review our [security policy](https://github.com/web-lsp/weblsp/blob/main/SECURITY.md).

💬 [Join the discussion](https://github.com/web-lsp/weblsp/discussions), if you have any questions, ideas, or suggestions.

## Installation

WIP.

## Configuration

WIP.
2 changes: 1 addition & 1 deletion packages/vscode/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "@weblsp/vscode",
"displayName": "WEBlsp",
"version": "1.0.0",
"description": "A Language Server for the Web — WORK IN PROGRESS ⚠️",
"description": "A language server for the Web — WORK IN PROGRESS ⚠️",
"repository": {
"type": "git",
"url": "https://github.com/web-lsp/weblsp"
Expand Down
2 changes: 1 addition & 1 deletion packages/vscode/src/extension.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ export async function activate(context: vscode.ExtensionContext) {

client = new lsp.LanguageClient(
"weblsp",
"WEBlsp Language Server",
"WEBlsp language server",
serverOptions,
clientOptions
);
Expand Down

0 comments on commit a08bc23

Please sign in to comment.