Новая диагностика "Зарезервированные имена параметров" #3187

AlexPCRus · 2023-11-23T06:22:01Z

Описание

Добавлена новая диагностика, проверяющая совпадение имен параметров методов с именами системных перечислений и т.п., задающихся списком

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

Чеклист

Общие

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

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

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

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

ghost · 2023-11-23T06:22:53Z

👇 Click on the image for a new way to code review

Legend

...a/com/github/_1c_syntax/bsl/languageserver/diagnostics/ReservedParameterNamesDiagnostic.java

...hub/_1c_syntax/bsl/languageserver/diagnostics/ReservedParameterNamesDiagnostic_en.properties

...hub/_1c_syntax/bsl/languageserver/diagnostics/ReservedParameterNamesDiagnostic_ru.properties

...st/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/ReservedParameterNamesTest.java

...a/com/github/_1c_syntax/bsl/languageserver/diagnostics/ReservedParameterNamesDiagnostic.java

docs/diagnostics/ReservedParameterNames.md

sonarqubecloud · 2023-11-24T06:58:25Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

100.0% Coverage
0.0% Duplication

docs/diagnostics/ReservedParameterNames.md

...hub/_1c_syntax/bsl/languageserver/diagnostics/ReservedParameterNamesDiagnostic_ru.properties

coderabbitai · 2024-06-04T06:14:45Z

Walkthrough

Изменения внедряют новый диагностический класс ReservedParameterNamesDiagnostic для проверки имен параметров методов на совпадение с зарезервированными словами. Если совпадение найдено, это отмечается как код с запахом. Были добавлены сообщения диагностики на английском и русском языках, а также тесты для проверки работы этой диагностики.

Changes

Файл	Описание изменений
docs/diagnostics/ReservedParameterNames.md	Добавлен новый диагностический файл с рекомендациями по избеганию зарезервированных имен параметров.
src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/ReservedParameterNamesDiagnostic.java	Добавлен класс для диагностики зарезервированных имен параметров, добавлены и изменены методы.
src/main/resources/com/github/_1c_syntax/bsl/languageserver/diagnostics/ReservedParameterNamesDiagnostic...	Добавлены диагностические сообщения на английском.
src/main/resources/com/github/_1c_syntax/bsl/languageserver/diagnostics/ReservedParameterNamesDiagnostic...	Добавлены диагностические сообщения на русском.
src/test/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/ReservedParameterNamesTest.java	Добавлены тесты для проверки работы диагностики зарезервированных имен параметров.

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.

coderabbitai

Actionable comments posted: 2

Outside diff range and nitpick comments (1)

src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/ReservedParameterNamesDiagnostic.java (1)

71-87: Методы корректно идентифицируют параметры с зарезервированными именами. Рассмотрите возможность кэширования результатов регулярного выражения для повышения производительности.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6e0e5a8 and 32fd2ca.

Files ignored due to path filters (2)

src/main/resources/com/github/_1c_syntax/bsl/languageserver/configuration/parameters-schema.json is excluded by !**/*.json
src/main/resources/com/github/_1c_syntax/bsl/languageserver/configuration/schema.json is excluded by !**/*.json

Files selected for processing (7)

docs/diagnostics/ReservedParameterNames.md (1 hunks)
docs/en/diagnostics/ReservedParameterNames.md (1 hunks)
src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/ReservedParameterNamesDiagnostic.java (1 hunks)
src/main/resources/com/github/_1c_syntax/bsl/languageserver/diagnostics/ReservedParameterNamesDiagnostic_en.properties (1 hunks)
src/main/resources/com/github/_1c_syntax/bsl/languageserver/diagnostics/ReservedParameterNamesDiagnostic_ru.properties (1 hunks)
src/test/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/ReservedParameterNamesTest.java (1 hunks)
src/test/resources/diagnostics/ReservedParameterNamesDiagnostic.bsl (1 hunks)

Files skipped from review due to trivial changes (4)

src/main/resources/com/github/_1c_syntax/bsl/languageserver/diagnostics/ReservedParameterNamesDiagnostic_en.properties
src/main/resources/com/github/_1c_syntax/bsl/languageserver/diagnostics/ReservedParameterNamesDiagnostic_ru.properties
src/test/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/ReservedParameterNamesTest.java
src/test/resources/diagnostics/ReservedParameterNamesDiagnostic.bsl

Additional context used

Markdownlint

docs/diagnostics/ReservedParameterNames.md

4-4: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

docs/en/diagnostics/ReservedParameterNames.md

6-6: Expected: 1; Actual: 2
Multiple consecutive blank lines

Additional comments not posted (2)

src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/ReservedParameterNamesDiagnostic.java (2)

54-60: Конфигурация диагностики корректно обрабатывает входные данные и устанавливает регулярное выражение. Отличная работа!

62-69: Проверка на пустой шаблон перед выполнением диагностики улучшает производительность. Хорошее решение!

docs/diagnostics/ReservedParameterNames.md

docs/en/diagnostics/ReservedParameterNames.md

theshadowco · 2024-07-10T17:47:42Z

/rebase

coderabbitai

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 32fd2ca and 245220a.

Files selected for processing (3)

src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/ReservedParameterNamesDiagnostic.java (1 hunks)
src/main/resources/com/github/_1c_syntax/bsl/languageserver/diagnostics/ReservedParameterNamesDiagnostic_ru.properties (1 hunks)
src/test/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/ReservedParameterNamesTest.java (1 hunks)

Files skipped from review due to trivial changes (1)

src/main/resources/com/github/_1c_syntax/bsl/languageserver/diagnostics/ReservedParameterNamesDiagnostic_ru.properties

Additional comments not posted (8)

src/test/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/ReservedParameterNamesTest.java (4)

40-44: Метод testEmpty выглядит хорошо.

Метод проверяет отсутствие диагностик при отсутствии настроенных зарезервированных слов.

46-60: Метод testPositive выглядит хорошо.

Метод корректно настраивает зарезервированное слово и проверяет наличие диагностик.

62-73: Метод testNegative выглядит хорошо.

Метод тестирует различные несоответствующие зарезервированные слова и проверяет отсутствие диагностик.

35-39: Структура тестового класса выглядит хорошо.

Структура класса ясна и соответствует лучшим практикам.

src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/ReservedParameterNamesDiagnostic.java (4)

62-69: Метод check выглядит хорошо.

Метод проверяет, что шаблон зарезервированных слов не пуст перед продолжением.

71-76: Метод visitMethod выглядит хорошо.

Метод корректно извлекает параметры для проверки.

78-87: Метод checkParameterName выглядит хорошо.

Метод проверяет имена параметров на соответствие шаблону зарезервированных слов.

47-49: Структура класса выглядит хорошо.

Структура класса ясна и соответствует лучшим практикам.

coderabbitai · 2024-07-10T18:02:16Z

...a/com/github/_1c_syntax/bsl/languageserver/diagnostics/ReservedParameterNamesDiagnostic.java

+  @Override
+  public void configure(Map<String, Object> configuration) {
+
+    var incomingMask = (String) configuration.getOrDefault("reservedWords", RESERVED_WORDS_DEFAULT);
+
+    this.reservedWords = CaseInsensitivePattern.compile("^" + incomingMask.trim() + "$");
+  }


Добавьте проверку на пустую строку.

Метод настройки должен дополнительно проверять, что шаблон зарезервированных слов не пуст.

- this.reservedWords = CaseInsensitivePattern.compile("^" + incomingMask.trim() + "$"); + if (!incomingMask.trim().isEmpty()) { + this.reservedWords = CaseInsensitivePattern.compile("^" + incomingMask.trim() + "$"); + }

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

@Override

public void configure(Map<String, Object> configuration) {

var incomingMask = (String) configuration.getOrDefault("reservedWords", RESERVED_WORDS_DEFAULT);

this.reservedWords = CaseInsensitivePattern.compile("^" + incomingMask.trim() + "$");

}

@Override

public void configure(Map<String, Object> configuration) {

var incomingMask = (String) configuration.getOrDefault("reservedWords", RESERVED_WORDS_DEFAULT);

if (!incomingMask.trim().isEmpty()) {

this.reservedWords = CaseInsensitivePattern.compile("^" + incomingMask.trim() + "$");

}

}