Skip to content
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.

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

Неверное описание переменной в цикле "Для каждого" #3276

Merged

Conversation

qtLex
Copy link
Contributor

@qtLex qtLex commented May 3, 2024

Описание

Как описание переменной бралось описание ближайшей переменной описанной в блоке Перем. Изменил поведение, как описание берется "висящий" комментарий в строке с первой строкой описания цикла

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

Задачи не было. Обсуждали в телеге. Примеры ошибки
image
image

Чеклист

Общие

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

Как описание переменной бралось описание ближайшей переменной описанной в блоке Перем.
Изменил поведение, как описание берется "висящий" комментарий в строке с первой строкой описания цикла
Copy link

coderabbitai bot commented May 3, 2024

Walkthrough

Внесены изменения в метод createDescription класса VariableSymbolComputer, чтобы он обрабатывал trailing comments для контекстов ForEachStatementContext и ForStatementContext. В тестах VariableSymbolTest были скорректированы утверждения и добавлены проверки диапазонов переменных. В файл variableSymbolTest.bsl добавлены циклы с методами и комментариями.

Changes

Файлы Описание изменений
src/.../VariableSymbolComputer.java Расширен метод createDescription для обработки trailing comments в контекстах ForEach и For.
src/.../VariableSymbolTest.java Изменены утверждения в методах тестов, добавлены проверки диапазонов переменных.
src/test/resources/context/symbol/variableSymbolTest.bsl Добавлены циклы с методами и комментариями для тестирования новых возможностей.

Poem

В коде нашем новый свет,
Циклы с комментариями — привет!
Тесты стали точнее вдвойне,
Переменные в порядке, как во сне.
Пусть код наш будет чист и ясен,
Как весенний день прекрасен! 🌸


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

sonarcloud bot commented May 3, 2024

@@ -229,6 +229,18 @@ private Optional<VariableDescription> createDescription(BSLParser.LValueContext
);
}

private Optional<VariableDescription> createDescription(BSLParser.ForEachStatementContext ctx) {
Copy link
Member

Choose a reason for hiding this comment

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

А обычный "для" и "пока" не надо обработать?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

"Для" не анализировался как место создания переменно или уходило в другую ветку. Нужно будет проверить и добавить по необходимости.
"Пока" для создания символов не интересно, так как не создает переменную. Там условие выполнения цикла.

@@ -229,6 +229,18 @@ private Optional<VariableDescription> createDescription(BSLParser.LValueContext
);
}

private Optional<VariableDescription> createDescription(BSLParser.ForEachStatementContext ctx) {
var trailingComments = Trees.getTrailingComment(documentContext.getTokens(), ctx.getStart());
Copy link
Member

Choose a reason for hiding this comment

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

Лучше вместо getStart() дёрнуть узел с переменной

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 68e8777 and c1ef968.
Files selected for processing (3)
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/context/computer/VariableSymbolComputer.java (1 hunks)
  • src/test/java/com/github/_1c_syntax/bsl/languageserver/context/computer/VariableSymbolTest.java (6 hunks)
  • src/test/resources/context/symbol/variableSymbolTest.bsl (1 hunks)
Additional comments not posted (9)
src/test/resources/context/symbol/variableSymbolTest.bsl (4)

60-62: Изменения соответствуют целям PR, обработка циклов без висячих комментариев корректно реализована.


64-66: Отлично, висячий комментарий для цикла корректно обрабатывается в соответствии с описанием PR.


68-70: Изменения соответствуют целям PR, обработка циклов без висячих комментариев корректно реализована.


72-74: Отлично, висячий комментарий для цикла корректно обрабатывается в соответствии с описанием PR.

src/test/java/com/github/_1c_syntax/bsl/languageserver/context/computer/VariableSymbolTest.java (3)

Line range hint 55-69: Обновление утверждений в тесте соответствует изменениям в обработке висячих комментариев. Дополнительные проверки диапазонов помогают обеспечить полноту валидации.


Line range hint 96-117: Обновление утверждений и добавление новых проверок диапазонов в тесте соответствуют изменениям в обработке описаний переменных.


Line range hint 127-138: Обновление утверждений в тесте соответствует изменениям в обработке висячих комментариев. Дополнительные проверки диапазонов помогают обеспечить полноту валидации.

src/main/java/com/github/_1c_syntax/bsl/languageserver/context/computer/VariableSymbolComputer.java (2)

232-242: Метод createDescription для ForEachStatementContext теперь корректно обрабатывает висячие комментарии, что соответствует целям PR.


244-254: Метод createDescription для ForStatementContext теперь корректно обрабатывает висячие комментарии, что соответствует целям PR.

@nixel2007 nixel2007 merged commit 6aa378b into 1c-syntax:develop Jun 3, 2024
17 of 18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants