Skip to content

feat: document LSP methods #4197

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
ematipico wants to merge 12 commits into
base: next
Choose a base branch
from
Open

feat: document LSP methods #4197

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
fb5589a
feat: document LSP methods
ematipico Apr 28, 2026
bb61f4c
chore: add potential custom requests but not at this time
ematipico Apr 28, 2026
ca102c8
chore: document option
ematipico Apr 28, 2026
8220024
chore: fix lsp codegen
ematipico May 8, 2026
396be0a
fix wording
ematipico May 8, 2026
16ff5ed
update first party support
ematipico May 8, 2026
15bf2d3
Update src/content/docs/editors/introduction.mdx
ematipico May 8, 2026
1353ac5
Apply suggestions from code review
ematipico May 8, 2026
3a78fa3
chore: feedback
ematipico May 8, 2026
77049a5
Apply suggestions from code review
ematipico May 8, 2026
9c40029
Update codegen/src/lsp.rs
ematipico May 8, 2026
bb234ef
fix links
yanthomasdev May 12, 2026
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
180 changes: 98 additions & 82 deletions Cargo.lock
View file
Open in desktop

Large diffs are not rendered by default.

122 changes: 61 additions & 61 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,69 +1,69 @@
[package]
name = "codegen"
version = "0.1.0"
edition = "2024"
description = "Crate used to generate pages from the Rust source code of Biome"
publish = false
name = "codegen"
version = "0.1.0"
edition = "2024"
description = "Crate used to generate pages from the Rust source code of Biome"
publish = false

[lib]
name = "codegen"
path = "codegen/src/lib.rs"
name = "codegen"
path = "codegen/src/lib.rs"

[[bin]]
name = "codegen"
path = "codegen/src/main.rs"
name = "codegen"
path = "codegen/src/main.rs"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
[dependencies]
anyhow = "1.0.102"
biome_analyze = { git = "https://github.com/biomejs/biome.git", rev = "48bb0325cd95def95826b947290f0defb9faef45", version = "0.5.7", features = [
"schema"
] }
biome_cli = { git = "https://github.com/biomejs/biome.git", rev = "48bb0325cd95def95826b947290f0defb9faef45", version = "0.0.0" }
biome_configuration = { git = "https://github.com/biomejs/biome.git", rev = "48bb0325cd95def95826b947290f0defb9faef45", version = "0.0.1", features = [
"cli",
"schema"
] }
biome_console = { git = "https://github.com/biomejs/biome.git", rev = "48bb0325cd95def95826b947290f0defb9faef45", version = "0.5.7" }
biome_css_analyze = { git = "https://github.com/biomejs/biome.git", rev = "48bb0325cd95def95826b947290f0defb9faef45", version = "0.5.7" }
biome_css_parser = { git = "https://github.com/biomejs/biome.git", rev = "48bb0325cd95def95826b947290f0defb9faef45", version = "0.5.7" }
biome_css_semantic = { git = "https://github.com/biomejs/biome.git", rev = "48bb0325cd95def95826b947290f0defb9faef45", version = "0.0.0" }
biome_css_syntax = { git = "https://github.com/biomejs/biome.git", rev = "48bb0325cd95def95826b947290f0defb9faef45", version = "0.5.7" }
biome_deserialize = { git = "https://github.com/biomejs/biome.git", rev = "48bb0325cd95def95826b947290f0defb9faef45", version = "0.6.0" }
biome_diagnostics = { git = "https://github.com/biomejs/biome.git", rev = "48bb0325cd95def95826b947290f0defb9faef45", version = "0.5.7" }
biome_flags = { git = "https://github.com/biomejs/biome.git", rev = "48bb0325cd95def95826b947290f0defb9faef45", version = "0.0.0" }
biome_formatter = { git = "https://github.com/biomejs/biome.git", rev = "48bb0325cd95def95826b947290f0defb9faef45", version = "0.5.7" }
biome_fs = { git = "https://github.com/biomejs/biome.git", rev = "48bb0325cd95def95826b947290f0defb9faef45", version = "0.5.7" }
biome_graphql_analyze = { git = "https://github.com/biomejs/biome.git", rev = "48bb0325cd95def95826b947290f0defb9faef45", version = "0.0.1" }
biome_graphql_parser = { git = "https://github.com/biomejs/biome.git", rev = "48bb0325cd95def95826b947290f0defb9faef45", version = "0.1.0" }
biome_graphql_syntax = { git = "https://github.com/biomejs/biome.git", rev = "48bb0325cd95def95826b947290f0defb9faef45", version = "0.1.0" }
biome_html_analyze = { git = "https://github.com/biomejs/biome.git", rev = "48bb0325cd95def95826b947290f0defb9faef45", version = "0.5.7" }
biome_html_parser = { git = "https://github.com/biomejs/biome.git", rev = "48bb0325cd95def95826b947290f0defb9faef45", version = "0.0.1" }
biome_html_syntax = { git = "https://github.com/biomejs/biome.git", rev = "48bb0325cd95def95826b947290f0defb9faef45", version = "0.5.7" }
biome_js_analyze = { git = "https://github.com/biomejs/biome.git", rev = "48bb0325cd95def95826b947290f0defb9faef45", version = "0.5.7" }
biome_js_formatter = { git = "https://github.com/biomejs/biome.git", rev = "48bb0325cd95def95826b947290f0defb9faef45", version = "0.5.7" }
biome_js_parser = { git = "https://github.com/biomejs/biome.git", rev = "48bb0325cd95def95826b947290f0defb9faef45", version = "0.5.7" }
biome_js_syntax = { git = "https://github.com/biomejs/biome.git", rev = "48bb0325cd95def95826b947290f0defb9faef45", version = "0.5.7" }
biome_json_analyze = { git = "https://github.com/biomejs/biome.git", rev = "48bb0325cd95def95826b947290f0defb9faef45", version = "0.5.7" }
biome_json_factory = { git = "https://github.com/biomejs/biome.git", rev = "48bb0325cd95def95826b947290f0defb9faef45", version = "0.5.7" }
biome_json_formatter = { git = "https://github.com/biomejs/biome.git", rev = "48bb0325cd95def95826b947290f0defb9faef45", version = "0.5.7" }
biome_json_parser = { git = "https://github.com/biomejs/biome.git", rev = "48bb0325cd95def95826b947290f0defb9faef45", version = "0.5.7" }
biome_json_syntax = { git = "https://github.com/biomejs/biome.git", rev = "48bb0325cd95def95826b947290f0defb9faef45", version = "0.5.7" }
biome_module_graph = { git = "https://github.com/biomejs/biome.git", rev = "48bb0325cd95def95826b947290f0defb9faef45", version = "0.0.1" }
biome_project_layout = { git = "https://github.com/biomejs/biome.git", rev = "48bb0325cd95def95826b947290f0defb9faef45", version = "0.0.1" }
biome_rowan = { git = "https://github.com/biomejs/biome.git", rev = "48bb0325cd95def95826b947290f0defb9faef45", version = "0.5.7" }
biome_ruledoc_utils = { git = "https://github.com/biomejs/biome.git", rev = "48bb0325cd95def95826b947290f0defb9faef45", version = "0.0.1" }
biome_service = { git = "https://github.com/biomejs/biome.git", rev = "48bb0325cd95def95826b947290f0defb9faef45", version = "0.0.0" }
biome_string_case = { git = "https://github.com/biomejs/biome.git", rev = "48bb0325cd95def95826b947290f0defb9faef45", version = "0.5.7" }
biome_test_utils = { git = "https://github.com/biomejs/biome.git", rev = "48bb0325cd95def95826b947290f0defb9faef45", version = "0.0.0" }
biome_text_edit = { git = "https://github.com/biomejs/biome.git", rev = "48bb0325cd95def95826b947290f0defb9faef45", version = "0.5.7" }
bpaf = { version = "0.9.25", features = ["docgen"] }
# If you update this library, be aware of the breaking changes
camino = "1.2.2"
# Needed to fix some weird dependency
lock_api = "0.4.14"
pulldown-cmark = "0.13.3"
schemars = "1.2.1"
serde = "1.0.228"
serde_json = "1.0.149"
ureq = "3.3.0"
anyhow = "1.0.102"
biome_analyze = { git = "https://github.com/biomejs/biome.git", rev = "ebbf0bd382059936ac00de29fc58931728f854d9", version = "0.5.7", features = [
"schema"
] }
biome_cli = { git = "https://github.com/biomejs/biome.git", rev = "ebbf0bd382059936ac00de29fc58931728f854d9", version = "0.0.0" }
biome_configuration = { git = "https://github.com/biomejs/biome.git", rev = "ebbf0bd382059936ac00de29fc58931728f854d9", version = "0.0.1", features = [
"cli",
"schema"
] }
biome_console = { git = "https://github.com/biomejs/biome.git", rev = "ebbf0bd382059936ac00de29fc58931728f854d9", version = "0.5.7" }
biome_css_analyze = { git = "https://github.com/biomejs/biome.git", rev = "ebbf0bd382059936ac00de29fc58931728f854d9", version = "0.5.7" }
biome_css_parser = { git = "https://github.com/biomejs/biome.git", rev = "ebbf0bd382059936ac00de29fc58931728f854d9", version = "0.5.7" }
biome_css_semantic = { git = "https://github.com/biomejs/biome.git", rev = "ebbf0bd382059936ac00de29fc58931728f854d9", version = "0.0.0" }
biome_css_syntax = { git = "https://github.com/biomejs/biome.git", rev = "ebbf0bd382059936ac00de29fc58931728f854d9", version = "0.5.7" }
biome_deserialize = { git = "https://github.com/biomejs/biome.git", rev = "ebbf0bd382059936ac00de29fc58931728f854d9", version = "0.6.0" }
biome_diagnostics = { git = "https://github.com/biomejs/biome.git", rev = "ebbf0bd382059936ac00de29fc58931728f854d9", version = "0.5.7" }
biome_flags = { git = "https://github.com/biomejs/biome.git", rev = "ebbf0bd382059936ac00de29fc58931728f854d9", version = "0.0.0" }
biome_formatter = { git = "https://github.com/biomejs/biome.git", rev = "ebbf0bd382059936ac00de29fc58931728f854d9", version = "0.5.7" }
biome_fs = { git = "https://github.com/biomejs/biome.git", rev = "ebbf0bd382059936ac00de29fc58931728f854d9", version = "0.5.7" }
biome_graphql_analyze = { git = "https://github.com/biomejs/biome.git", rev = "ebbf0bd382059936ac00de29fc58931728f854d9", version = "0.0.1" }
biome_graphql_parser = { git = "https://github.com/biomejs/biome.git", rev = "ebbf0bd382059936ac00de29fc58931728f854d9", version = "0.1.0" }
biome_graphql_syntax = { git = "https://github.com/biomejs/biome.git", rev = "ebbf0bd382059936ac00de29fc58931728f854d9", version = "0.1.0" }
biome_html_analyze = { git = "https://github.com/biomejs/biome.git", rev = "ebbf0bd382059936ac00de29fc58931728f854d9", version = "0.5.7" }
biome_html_parser = { git = "https://github.com/biomejs/biome.git", rev = "ebbf0bd382059936ac00de29fc58931728f854d9", version = "0.0.1" }
biome_html_syntax = { git = "https://github.com/biomejs/biome.git", rev = "ebbf0bd382059936ac00de29fc58931728f854d9", version = "0.5.7" }
biome_js_analyze = { git = "https://github.com/biomejs/biome.git", rev = "ebbf0bd382059936ac00de29fc58931728f854d9", version = "0.5.7" }
biome_js_formatter = { git = "https://github.com/biomejs/biome.git", rev = "ebbf0bd382059936ac00de29fc58931728f854d9", version = "0.5.7" }
biome_js_parser = { git = "https://github.com/biomejs/biome.git", rev = "ebbf0bd382059936ac00de29fc58931728f854d9", version = "0.5.7" }
biome_js_syntax = { git = "https://github.com/biomejs/biome.git", rev = "ebbf0bd382059936ac00de29fc58931728f854d9", version = "0.5.7" }
biome_json_analyze = { git = "https://github.com/biomejs/biome.git", rev = "ebbf0bd382059936ac00de29fc58931728f854d9", version = "0.5.7" }
biome_json_factory = { git = "https://github.com/biomejs/biome.git", rev = "ebbf0bd382059936ac00de29fc58931728f854d9", version = "0.5.7" }
biome_json_formatter = { git = "https://github.com/biomejs/biome.git", rev = "ebbf0bd382059936ac00de29fc58931728f854d9", version = "0.5.7" }
biome_json_parser = { git = "https://github.com/biomejs/biome.git", rev = "ebbf0bd382059936ac00de29fc58931728f854d9", version = "0.5.7" }
biome_json_syntax = { git = "https://github.com/biomejs/biome.git", rev = "ebbf0bd382059936ac00de29fc58931728f854d9", version = "0.5.7" }
biome_module_graph = { git = "https://github.com/biomejs/biome.git", rev = "ebbf0bd382059936ac00de29fc58931728f854d9", version = "0.0.1" }
biome_project_layout = { git = "https://github.com/biomejs/biome.git", rev = "ebbf0bd382059936ac00de29fc58931728f854d9", version = "0.0.1" }
biome_rowan = { git = "https://github.com/biomejs/biome.git", rev = "ebbf0bd382059936ac00de29fc58931728f854d9", version = "0.5.7" }
biome_ruledoc_utils = { git = "https://github.com/biomejs/biome.git", rev = "ebbf0bd382059936ac00de29fc58931728f854d9", version = "0.0.1" }
biome_service = { git = "https://github.com/biomejs/biome.git", rev = "ebbf0bd382059936ac00de29fc58931728f854d9", version = "0.0.0", features = ["schema"] }
biome_string_case = { git = "https://github.com/biomejs/biome.git", rev = "ebbf0bd382059936ac00de29fc58931728f854d9", version = "0.5.7" }
biome_test_utils = { git = "https://github.com/biomejs/biome.git", rev = "ebbf0bd382059936ac00de29fc58931728f854d9", version = "0.0.0" }
biome_text_edit = { git = "https://github.com/biomejs/biome.git", rev = "ebbf0bd382059936ac00de29fc58931728f854d9", version = "0.5.7" }
bpaf = { version = "0.9.25", features = ["docgen"] }
# If you update this library, be aware of the breaking changes
camino = "1.2.2"
# Needed to fix some weird dependency
lock_api = "0.4.14"
pulldown-cmark = "0.13.3"
schemars = "1.2.1"
serde = "1.0.228"
serde_json = "1.0.149"
ureq = "3.3.0"
110 changes: 56 additions & 54 deletions astro.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,9 @@ export default defineConfig({
"/blog/annoucing-biome": "/blog/announcing-biome",
"/guides/editors/create-a-extension": "/guides/editors/create-an-extension",
"/internals/credits": "/internals/people-and-credits",
"/guides/editors/first-party-extensions": "/editors/first-party-extensions",
"/guides/editors/third-party-extensions": "/editors/third-party-extensions",
"/guides/editors/create-an-extension": "/editors/create-an-extension",
},
integrations: [
react(),
Expand Down Expand Up @@ -237,60 +240,6 @@ export default defineConfig({
ru: "Обновление до Biome v2",
},
},
{
label: "Biome in your IDE",
translations: {
es: "Biome en tu IDE",
fr: "Biome dans votre IDE",
ja: "Biome をあなたのエディタに導入する",
"zh-CN": "编辑器中使用 Biome",
pl: "Biome w Twoim IDE",
"pt-BR": "Biome no seu editor",
uk: "Biome в вашому IDE",
ru: "Biome в вашей IDE",
},
items: [
{
label: "First-party extensions",
link: "/guides/editors/first-party-extensions",
translations: {
es: "Extensiones de primera mano",
fr: "Extensions officielles",
ja: "Biome 公式拡張機能",
"zh-CN": "官方扩展",
pl: "Oficjalne rozszerzenia",
uk: "Офіційні розширення",
ru: "Официальные расширения",
},
},
{
label: "Third-party extensions",
link: "/guides/editors/third-party-extensions",
translations: {
es: "Extensiones de terceros",
fr: "Extensions tierces",
ja: "サードパーティの拡張機能",
"zh-CN": "第三方扩展",
pl: "Rozszerzenia stron trzecich",
uk: "Розширення сторонніх розробників",
ru: "Сторонние расширения",
},
},
{
label: "Integrate Biome in an editor extension",
link: "/guides/editors/create-an-extension",
translations: {
es: "Integrar Biome en una extensión para un editor",
fr: "Intégrer Biome à une extension pour un éditeur",
ja: "エディタ拡張機能への Biome の統合",
"zh-CN": "在编辑器扩展中集成 Biome",
pl: "Integracja Biome w rozszerzeniu edytora",
uk: "Інтеграція Biome в розширення редактора",
ru: "Интеграция Biome в расширение редактора",
},
},
],
},
{
label: "Integrate Biome with your VCS",
link: "/guides/integrate-in-vcs",
Expand Down Expand Up @@ -691,6 +640,51 @@ export default defineConfig({
},
],
},
{
label: "Biome Language Server",
translations: {
es: "Biome en tu IDE",
fr: "Biome dans votre IDE",
ja: "Biome をあなたのエディタに導入する",
"zh-CN": "编辑器中使用 Biome",
pl: "Biome w Twoim IDE",
"pt-BR": "Biome no seu editor",
uk: "Biome в вашому IDE",
ru: "Biome в вашей IDE",
},
Comment on lines +645 to +654
Copy link
Copy Markdown
Member

@siketyan siketyan May 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nitpick: Translations are outdated.

items: [
{
label: "Introduction",
link: "/editors/introduction",
},
{
label: "First-party extensions",
link: "/editors/first-party-extensions",
translations: {
es: "Extensiones de primera mano",
fr: "Extensions officielles",
ja: "Biome 公式拡張機能",
"zh-CN": "官方扩展",
pl: "Oficjalne rozszerzenia",
uk: "Офіційні розширення",
ru: "Официальные расширения",
},
},
{
label: "Third-party extensions",
link: "/editors/third-party-extensions",
translations: {
es: "Extensiones de terceros",
fr: "Extensions tierces",
ja: "サードパーティの拡張機能",
"zh-CN": "第三方扩展",
pl: "Rozszerzenia stron trzecich",
uk: "Розширення сторонніх розробників",
ru: "Сторонние расширения",
},
},
],
},
{
label: "Reference",
translations: {
Expand Down Expand Up @@ -790,6 +784,14 @@ export default defineConfig({
label: "GritQL",
link: "/reference/gritql",
},
{
label: "Daemon requests",
link: "/reference/daemon",
badge: {
text: "new",
variant: "success",
},
},
],
},
{
Expand Down
5 changes: 5 additions & 0 deletions codegen/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ pub mod diagnostics;
pub mod domains;
pub mod env_variables;
pub mod lintdoc;
pub mod lsp;
pub mod metadata;
pub mod redirects;
pub mod rules_sources;
Expand Down Expand Up @@ -49,6 +50,10 @@ pub enum CodegenCommand {
#[bpaf(command)]
Redirects,

/// Generates the LSP custom methods documentation
#[bpaf(command)]
Lsp,

/// Updates the documentation of the rule pages and the files of a release
#[bpaf(command)]
All,
Expand Down
Loading
Loading