Переход на использование чтения описания методов и переменных bsl-parser by theshadowco · Pull Request #3753 · 1c-syntax/bsl-language-server

theshadowco · 2026-01-08T11:38:44Z

Описание

Удалены дублирующие bsl-parser-lib классы
Удалено использование токенайзера для описаний

Связанные задачи

Closes

Чеклист

Общие

Ветка PR обновлена из develop
Отладочные, закомментированные и прочие, не имеющие смысла участки кода удалены
Изменения покрыты тестами
Обязательные действия перед коммитом выполнены (запускал команду gradlew precommit)

Для диагностик

Описание диагностики заполнено для обоих языков (присутствуют файлы для обоих языков, для русского заполнено все подробно, перевод на английский можно опустить)

Дополнительно

Summary by CodeRabbit

Refactor
- Unified documentation/description model to a parser-driven representation, streamlining how links, types and fields are handled.
Bug Fixes
- Improved hover content formatting for signatures, parameters and returned-value docs.
- More accurate diagnostics for missing parameter/return descriptions.
- Enhanced semantic tokenization for documentation fragments.
Chores
- BSL parser dependency version updated.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

coderabbitai · 2026-01-08T11:38:49Z

Caution

Review failed

The pull request is closed.

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

📝 Walkthrough

Walkthrough

Removed local description/model/parsing code and migrated usages to the bsl-parser dependency; call sites updated to import parser-provided description types, use factory methods, and adapt to SimpleRange/fields/links APIs.

Changes

Cohort / File(s)	Summary
Build `build.gradle.kts`	Bumped `bsl-parser` to `0.30.0-rc.2`.
Deleted local description models `src/main/java/.../context/symbol/description/{DescriptionReader.java, MethodDescription.java, ParameterDescription.java, SourceDefinedSymbolDescription.java, TypeDescription.java}`, `src/main/java/.../context/symbol/description/package-info.java`, `src/main/java/.../context/symbol/variable/VariableDescription.java`	Removed local description parsing/model classes and package-info.
Symbol computers `src/main/java/.../context/computer/{MethodSymbolComputer.java, VariableSymbolComputer.java}`	Switched imports to parser types; replaced direct constructors with factory calls (`MethodDescription.create(...)`, `VariableDescription.create(...)`).
Symbol types & signatures `src/main/java/.../context/symbol/{AbstractVariableSymbol.java, AnnotationParamSymbol.java, AnnotationSymbol.java, Describable.java, IntBasedVariableSymbol.java, MethodSymbol.java, ParameterDefinition.java, ShortBasedVariableSymbol.java, VariableSymbol.java}`	Updated imports to `com.github._1c_syntax.bsl.parser.description.*`; variable description type in public signatures now references parser-provided types.
Diagnostics `src/main/java/.../languageserver/diagnostics/{CommentedCodeDiagnostic.java, DeprecatedMethodCallDiagnostic.java, LineLengthDiagnostic.java, MissingParameterDescriptionDiagnostic.java, MissingReturnedValueDescriptionDiagnostic.java}`	Updated imports and logic to new APIs (`getLinks()`, `fields()`), and switched to `SimpleRange` for range handling.
Hover / formatting `src/main/java/.../languageserver/hover/{DescriptionFormatter.java, VariableSymbolMarkupContentBuilder.java}`	Migrated to parser description types; refactored formatting (HyperlinkTypeDescription handling, inlined sections, removed `getSectionWithCodeFences`).
Semantic tokens `src/main/java/.../languageserver/semantictokens/{BslDocSemanticTokensSupplier.java, CommentSemanticTokensSupplier.java, SemanticTokensHelper.java}`	Replaced AST/tokenizer parsing with DescriptionElement-driven processing; switched to `SimpleRange`; replaced `addTerminalNodeRange` with `addDescriptionElement`.
Tests `src/test/java/.../{context/computer/VariableSymbolTest.java, context/symbol/description/MethodDescriptionTest.java, diagnostics/MissingReturnedValueDescriptionDiagnosticTest.java, hover/MethodSymbolMarkupContentBuilderTest.java, providers/SemanticTokensProviderTest.java}`	Updated imports/assertions for new parser API (`SimpleRange`, `getLinks()`, `fields()`, `HyperlinkTypeDescription`); adjusted semantic token and diagnostic expectations.
CI workflow `.github/workflows/benchmark.yml`	Switched full clone to shallow clone (`--depth 1`) for SSL 3.1 download step.

Sequence Diagram(s)

sequenceDiagram
    actor Client
    participant LanguageServer
    participant Workspace as WorkspaceDB
    participant ParserLib as bsl-parser

    Client->>LanguageServer: Request hover / diagnostics / semantic tokens
    LanguageServer->>Workspace: Locate symbol & source tokens
    LanguageServer->>ParserLib: Description.create(tokens) / request description elements
    ParserLib-->>LanguageServer: Description, DescriptionElements, SimpleRange, Links, Fields
    LanguageServer->>LanguageServer: Build hover markup, diagnostics, semantic tokens
    LanguageServer-->>Client: Return hover / diagnostics / semantic tokens

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~45 minutes

Possibly related PRs

Переход на использование чтения описания методов и переменных bsl-parser #3753 — Same migration: remove in-repo description types and switch to bsl-parser descriptions.
Update bsl-parser dependency to version 0.29.0 #3651 — Dependency update for bsl-parser; related to the bumped parser version.
semanticTokens #3510 — Changes in semantic-tokens subsystem; overlaps with semantic token processing updates.

Suggested labels

hacktoberfest-accepted

Suggested reviewers

nixel2007

Poem

🐰 I nibbled old description trees,
Parser sprouts now sway in the breeze.
Factory hops and ranges small,
Links and fields replace it all,
A tidy burrow, code at ease. 🥕

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 9.52% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main objective: migrating to use bsl-parser for reading method and variable descriptions.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

📝 Generate docstrings

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 39d8831 and 27f2b6c.

📒 Files selected for processing (4)

.github/workflows/benchmark.yml
build.gradle.kts
src/main/java/com/github/_1c_syntax/bsl/languageserver/context/computer/VariableSymbolComputer.java
src/test/java/com/github/_1c_syntax/bsl/languageserver/context/computer/VariableSymbolTest.java

_{✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.}

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

github-actions · 2026-01-08T11:41:20Z

Test Results

2 817 files 2 817 suites 1h 3m 6s ⏱️
1 162 tests 1 162 ✅ 0 💤 0 ❌
10 458 runs 10 458 ✅ 0 💤 0 ❌

Results for commit b051209.

♻️ This comment has been updated with latest results.

Copilot

Pull request overview

This pull request migrates from internal method and variable description parsing to using the bsl-parser library (v0.30.0-rc.1). The change removes ~550 lines of duplicate parsing logic and delegates description reading to the upstream bsl-parser library.

Changes:

Removed internal description classes (MethodDescription, VariableDescription, TypeDescription, ParameterDescription, DescriptionReader) in favor of bsl-parser equivalents
Updated semantic token supplier to use new description element API instead of re-parsing with tokenizer
Removed "call options" section support (now merged with examples)
Updated all imports and API calls throughout the codebase

Reviewed changes

Copilot reviewed 35 out of 36 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
build.gradle.kts	Updated bsl-parser to 0.30.0-rc.1 and bsl-common-library to 0.9.2
DescriptionFormatter.java	Refactored to use new HyperlinkTypeDescription API; removed getCallOptionsSection method
BslDocSemanticTokensSupplier.java	Simplified to use getElements() API instead of re-tokenizing descriptions
SemanticTokensHelper.java	Added addDescriptionElement method for new description element type
CommentSemanticTokensSupplier.java	Updated to use SimpleRange instead of org.eclipse.lsp4j.Range
MissingReturnedValueDescriptionDiagnostic.java	Updated API calls: getLink() → getLinks(), parameters() → fields()
MissingParameterDescriptionDiagnostic.java	Updated API call: getLink() → getLinks()
LineLengthDiagnostic.java	Updated to use SimpleRange
VariableSymbolComputer.java	Updated to use VariableDescription.create() factory method
MethodSymbolComputer.java	Updated to use MethodDescription.create() factory method
Multiple symbol classes	Updated imports from internal to bsl-parser description classes
Test files	Updated expectations for new API behavior (examples as String, type ordering changes, new hyperlink detection)
MethodDescription.bsl	Moved "Варианты вызова" lines to "Пример" section reflecting parser changes

…escriptionFormatter.java Co-authored-by: Copilot <[email protected]>

theshadowco · 2026-01-12T14:26:16Z

@coderabbitai
проведи ревью реквеста, он готов

coderabbitai · 2026-01-12T14:26:35Z

@theshadowco: Конечно, провожу ревью изменений в PR #3753.

Обратите внимание, что в описании PR отсутствует номер задачи после "Closes" — рекомендую добавить ссылку на соответствующий issue.

🧠 Learnings used

Learnt from: CR
Repo: 1c-syntax/bsl-language-server PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-12-18T18:49:48.712Z
Learning: Applies to docs/{en/,}diagnostics/**/*.md : Update diagnostic documentation in both Russian and English with examples of problematic code and fixes

Learnt from: theshadowco
Repo: 1c-syntax/bsl-language-server PR: 3610
File: src/main/java/com/github/_1c_syntax/bsl/languageserver/folding/QueryPackageFoldingRangeSupplier.java:26-26
Timestamp: 2025-11-19T09:02:03.154Z
Learning: В проекте bsl-language-server используется кастомная версия ANTLR4 от 1c-syntax (io.github.1c-syntax:antlr4), которая включает базовый класс org.antlr.v4.runtime.Tokenizer с методами getAst() и getTokens(). SDBLTokenizer и BSLTokenizer наследуются от этого базового класса.

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In
@src/main/java/com/github/_1c_syntax/bsl/languageserver/semantictokens/BslDocSemanticTokensSupplier.java:
- Around line 26-27: Remove the unused import BSLDescriptionLexer from
BslDocSemanticTokensSupplier (the import at the top that reads
BSLDescriptionLexer); the class BslDocSemanticTokensSupplier no longer
references that type, so delete the import line and run your IDE's
optimize/imports or build to ensure no other unused imports remain.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2844181 and dee6e84.

⛔ Files ignored due to path filters (1)

src/test/resources/context/symbol/MethodDescription.bsl is excluded by !src/test/resources/**

📒 Files selected for processing (34)

build.gradle.kts
src/main/java/com/github/_1c_syntax/bsl/languageserver/context/computer/MethodSymbolComputer.java
src/main/java/com/github/_1c_syntax/bsl/languageserver/context/computer/VariableSymbolComputer.java
src/main/java/com/github/_1c_syntax/bsl/languageserver/context/symbol/AbstractVariableSymbol.java
src/main/java/com/github/_1c_syntax/bsl/languageserver/context/symbol/AnnotationParamSymbol.java
src/main/java/com/github/_1c_syntax/bsl/languageserver/context/symbol/AnnotationSymbol.java
src/main/java/com/github/_1c_syntax/bsl/languageserver/context/symbol/Describable.java
src/main/java/com/github/_1c_syntax/bsl/languageserver/context/symbol/IntBasedVariableSymbol.java
src/main/java/com/github/_1c_syntax/bsl/languageserver/context/symbol/MethodSymbol.java
src/main/java/com/github/_1c_syntax/bsl/languageserver/context/symbol/ParameterDefinition.java
src/main/java/com/github/_1c_syntax/bsl/languageserver/context/symbol/ShortBasedVariableSymbol.java
src/main/java/com/github/_1c_syntax/bsl/languageserver/context/symbol/VariableSymbol.java
src/main/java/com/github/_1c_syntax/bsl/languageserver/context/symbol/description/DescriptionReader.java
src/main/java/com/github/_1c_syntax/bsl/languageserver/context/symbol/description/MethodDescription.java
src/main/java/com/github/_1c_syntax/bsl/languageserver/context/symbol/description/ParameterDescription.java
src/main/java/com/github/_1c_syntax/bsl/languageserver/context/symbol/description/SourceDefinedSymbolDescription.java
src/main/java/com/github/_1c_syntax/bsl/languageserver/context/symbol/description/TypeDescription.java
src/main/java/com/github/_1c_syntax/bsl/languageserver/context/symbol/description/package-info.java
src/main/java/com/github/_1c_syntax/bsl/languageserver/context/symbol/variable/VariableDescription.java
src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/CommentedCodeDiagnostic.java
src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/DeprecatedMethodCallDiagnostic.java
src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/LineLengthDiagnostic.java
src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/MissingParameterDescriptionDiagnostic.java
src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/MissingReturnedValueDescriptionDiagnostic.java
src/main/java/com/github/_1c_syntax/bsl/languageserver/hover/DescriptionFormatter.java
src/main/java/com/github/_1c_syntax/bsl/languageserver/hover/VariableSymbolMarkupContentBuilder.java
src/main/java/com/github/_1c_syntax/bsl/languageserver/semantictokens/BslDocSemanticTokensSupplier.java
src/main/java/com/github/_1c_syntax/bsl/languageserver/semantictokens/CommentSemanticTokensSupplier.java
src/main/java/com/github/_1c_syntax/bsl/languageserver/semantictokens/SemanticTokensHelper.java
src/test/java/com/github/_1c_syntax/bsl/languageserver/context/computer/VariableSymbolTest.java
src/test/java/com/github/_1c_syntax/bsl/languageserver/context/symbol/description/MethodDescriptionTest.java
src/test/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/MissingReturnedValueDescriptionDiagnosticTest.java
src/test/java/com/github/_1c_syntax/bsl/languageserver/hover/MethodSymbolMarkupContentBuilderTest.java
src/test/java/com/github/_1c_syntax/bsl/languageserver/providers/SemanticTokensProviderTest.java

💤 Files with no reviewable changes (7)

src/main/java/com/github/_1c_syntax/bsl/languageserver/context/symbol/description/ParameterDescription.java
src/main/java/com/github/_1c_syntax/bsl/languageserver/context/symbol/description/DescriptionReader.java
src/main/java/com/github/_1c_syntax/bsl/languageserver/context/symbol/description/SourceDefinedSymbolDescription.java
src/main/java/com/github/_1c_syntax/bsl/languageserver/context/symbol/variable/VariableDescription.java
src/main/java/com/github/_1c_syntax/bsl/languageserver/context/symbol/description/TypeDescription.java
src/main/java/com/github/_1c_syntax/bsl/languageserver/context/symbol/description/package-info.java
src/main/java/com/github/_1c_syntax/bsl/languageserver/context/symbol/description/MethodDescription.java

🧰 Additional context used

📓 Path-based instructions (5)

src/main/java/**/*.java