-
Notifications
You must be signed in to change notification settings - Fork 44
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
Некоторое количество исправлений по коду #355
Conversation
ОбзорWalkthroughЭтот pull request содержит множество небольших изменений в проекте SonarQube 1C (BSL) Community Plugin. Основные модификации включают обновление Changes
Sequence DiagramsequenceDiagram
participant Plugin
participant SonarQube
participant BSLLanguageServer
Plugin->>SonarQube: Регистрация плагина
SonarQube-->>Plugin: Подтверждение
Plugin->>BSLLanguageServer: Инициализация диагностики
BSLLanguageServer-->>Plugin: Загрузка правил
Possibly related PRs
Poem
✨ Finishing Touches
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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 using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
There was a problem hiding this 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
🧹 Nitpick comments (2)
src/main/java/com/github/_1c_syntax/bsl/sonar/ext_issues/RuleDefinitionsContainer.java (1)
71-74
: Улучшение структуры кода!Изменение логики условного блока делает код более понятным и лучше группирует связанные операции. Положительное условие
if (enabled)
яснее выражает намерение кода, чем предыдущий вариант с ранним возвратом.Для дополнительного улучшения читаемости, можно добавить комментарий, объясняющий, почему создание репозитория происходит только при
enabled = true
:+ // Создаем репозиторий правил только если соответствующий репортер включен if (enabled) { repository = context.createRepository(repositoryKey, BSLLanguage.KEY).setName(repositoryName); loadRules(); repository.done(); }
src/main/java/com/github/_1c_syntax/bsl/sonar/BSLCommunityProperties.java (1)
110-112
: Проверьте форматирование билдераФорматирование вызовов билдера отличается от остальных подобных вызовов в файле. Рекомендуется придерживаться единого стиля.
Предлагаемый вариант форматирования:
- .onQualifiers(Qualifiers.PROJECT) - .multiValues(true) - .build(), + .onQualifiers(Qualifiers.PROJECT) + .multiValues(true) + .build(),
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (3)
.idea/encodings.xml
is excluded by!**/*.xml
.travis.yml
is excluded by!**/*.yml
jitpack.yml
is excluded by!**/*.yml
📒 Files selected for processing (16)
.gitignore
(1 hunks)README.md
(1 hunks)docs/en/index.md
(2 hunks)docs/index.md
(5 hunks)src/main/java/com/github/_1c_syntax/bsl/sonar/BSLCommunityProperties.java
(3 hunks)src/main/java/com/github/_1c_syntax/bsl/sonar/BSLHighlighter.java
(3 hunks)src/main/java/com/github/_1c_syntax/bsl/sonar/PropertyDefinitionUtils.java
(1 hunks)src/main/java/com/github/_1c_syntax/bsl/sonar/ext_issues/QualityProfilesContainer.java
(1 hunks)src/main/java/com/github/_1c_syntax/bsl/sonar/ext_issues/RuleDefinitionsContainer.java
(1 hunks)src/main/java/com/github/_1c_syntax/bsl/sonar/language/BSLLanguageServerRuleDefinition.java
(1 hunks)src/main/resources/org/sonar/l10n/communitybsl_ru.properties
(1 hunks)src/test/java/com/github/_1c_syntax/bsl/sonar/BSLCoreSensorTest.java
(1 hunks)src/test/java/com/github/_1c_syntax/bsl/sonar/BSLHighlighterTest.java
(1 hunks)src/test/java/com/github/_1c_syntax/bsl/sonar/IssuesLoaderTest.java
(1 hunks)src/test/java/com/github/_1c_syntax/bsl/sonar/LanguageServerDiagnosticsLoaderSensorTest.java
(2 hunks)src/test/java/com/github/_1c_syntax/bsl/sonar/ext_issues/RuleDefinitionTest.java
(3 hunks)
✅ Files skipped from review due to trivial changes (4)
- src/main/resources/org/sonar/l10n/communitybsl_ru.properties
- src/main/java/com/github/_1c_syntax/bsl/sonar/language/BSLLanguageServerRuleDefinition.java
- src/test/java/com/github/_1c_syntax/bsl/sonar/ext_issues/RuleDefinitionTest.java
- src/main/java/com/github/_1c_syntax/bsl/sonar/BSLHighlighter.java
🧰 Additional context used
🪛 LanguageTool
docs/en/index.md
[typographical] ~37-~37: If you want to indicate numerical ranges or time ranges, consider using an en dash.
Context: ...| 0.7.0...1.10.0 | 11 | | 7.4 - 7.8 | 0.1.0...0.6.0 | 8 ...
(DASH_RULE)
🔇 Additional comments (18)
src/main/java/com/github/_1c_syntax/bsl/sonar/ext_issues/QualityProfilesContainer.java (1)
99-103
: Улучшение читаемости кода за счет позитивного условия!Изменение структуры условного блока делает код более понятным и легким для восприятия. Использование позитивного условия
if (isEnabled)
вместо отрицательного улучшает читаемость и соответствует лучшим практикам написания кода.src/main/java/com/github/_1c_syntax/bsl/sonar/PropertyDefinitionUtils.java (1)
24-24
: Корректное применение аннотации @UtilityClass и документацииХорошее решение использовать аннотацию @UtilityClass от Lombok для утилитного класса. Документация на русском языке четко описывает назначение класса.
Also applies to: 29-32
src/main/java/com/github/_1c_syntax/bsl/sonar/BSLCommunityProperties.java (2)
26-26
: Правильное применение аннотации @UtilityClassКорректное использование аннотации @UtilityClass от Lombok для утилитного класса, что соответствует общему подходу в проекте.
Also applies to: 36-37
45-48
: Улучшение читаемости объявлений константРазбиение длинных строк объявления констант на несколько строк улучшает читаемость кода.
.gitignore (2)
8-14
: Правильное добавление шаблонов игнорирования!Добавлены необходимые шаблоны для игнорирования файлов IDE, включая SonarLint и другие конфигурационные файлы.
17-20
: Корректная настройка игнорирования файлов сборки!Добавлены и структурированы шаблоны для игнорирования файлов Gradle и артефактов сборки.
Also applies to: 25-25
README.md (1)
21-27
: Отличное обновление матрицы совместимости!Матрица версий обновлена и отформатирована для лучшей читаемости. Добавлена информация о совместимости с новыми версиями SonarQube.
docs/en/index.md (2)
31-37
: Актуализация версионной матрицы в английской документации!Обновлена информация о совместимости версий, сохраняя согласованность с основной документацией.
🧰 Tools
🪛 LanguageTool
[typographical] ~37-~37: If you want to indicate numerical ranges or time ranges, consider using an en dash.
Context: ...| 0.7.0...1.10.0 | 11 | | 7.4 - 7.8 | 0.1.0...0.6.0 | 8 ...(DASH_RULE)
78-78
: Улучшение безопасности в примере использования!Изменен протокол с HTTP на HTTPS в примере конфигурации, что соответствует современным требованиям безопасности.
docs/index.md (3)
24-24
: Улучшение форматирования списка возможностей!Исправлено форматирование маркированного списка для лучшей читаемости.
34-40
: Корректное обновление матрицы версий!Добавлена актуальная информация о совместимости версий с улучшенным форматированием таблицы.
146-146
: Улучшение документации по интеграции с АПК!Добавлены кавычки в заголовок раздела и улучшено описание свойств конфигурации.
Also applies to: 157-157, 175-177
src/test/java/com/github/_1c_syntax/bsl/sonar/LanguageServerDiagnosticsLoaderSensorTest.java (2)
40-41
: Улучшение: Константы переведены в статические.Перевод констант
BASE_PATH
иBASE_DIR
в статические улучшает код, так как эти значения не зависят от состояния экземпляра класса.
57-58
: Улучшение: Переименование переменной согласно конвенции.Переименование
FILE_NAME
вfileName
соответствует общепринятым соглашениям об именовании в Java для локальных переменных.src/test/java/com/github/_1c_syntax/bsl/sonar/IssuesLoaderTest.java (1)
50-52
: Улучшение: Константы переведены в статические.Перевод констант в статические и использование
getAbsoluteFile()
улучшает код:
- Константы теперь принадлежат классу, а не экземпляру
getAbsoluteFile()
обеспечивает корректное разрешение путей независимо от текущей директорииsrc/test/java/com/github/_1c_syntax/bsl/sonar/BSLCoreSensorTest.java (2)
52-55
: Улучшение: Константы переведены в статические и добавлена версия SonarQube.Изменения улучшают код:
- Константы теперь принадлежат классу, а не экземпляру
- Версия SonarQube вынесена в константу
SONAR_VERSION
, что упрощает поддержку кода
60-60
: Улучшение: Переменная context стала локальной.Перенос переменной
context
в методtestDescriptor
улучшает инкапсуляцию, так как контекст используется только в этом методе.src/test/java/com/github/_1c_syntax/bsl/sonar/BSLHighlighterTest.java (1)
53-55
: Улучшение: Константы переведены в статические.Перевод констант
BASE_PATH
,BASE_DIR
иFILE_NAME
в статические улучшает код:
- Значения теперь принадлежат классу, а не экземпляру
- Изменения согласуются с аналогичными улучшениями в других тестовых классах
No description provided.