bsl-language-server
bsl-language-server copied to clipboard
Published
20 hours ago •
1c-syntax
1c-syntax
Feauture/logical or in join query section
Описание
Связанные задачи
#1561
Чеклист
Общие
- [ *] Ветка PR обновлена из develop
- [ *] Отладочные, закомментированные и прочие, не имеющие смысла участки кода удалены
- [ *] Изменения покрыты тестами
- [ *] Обязательные действия перед коммитом выполнены (запускал команду
gradlew precommit)
Для диагностик
- [* ] Описание диагностики заполнено для обоих языков (присутствуют файлы для обоих языков, для русского заполнено все подробно, перевод на английский можно опустить)
Дополнительно
При описании логики были неудобства с работой Visiter на вложенных соединениях, из за чего принято решение собирать и обрабатывать явно все соединения на уровне посещения запроса.
Также возможно было бы эффективнее сначала фильтровать поток условий на наличии оператора "ИЛИ" и только потом на операции над различными полями, но тогда пришлось бы вызывать метод получения всех операторов "ИЛИ" у узла 2 раза.
## Walkthrough
Добавлена новая диагностика, выявляющая использование логического оператора ИЛИ (OR) в условиях соединения (JOIN) SQL-запросов, если ИЛИ применяется к разным полям. Внесены сопутствующие изменения: документация на русском и английском языках, локализационные файлы, тесты и примеры кода для проверки работы диагностики.
## Changes
| Файл/Группа файлов | Краткое описание изменений |
|------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| docs/diagnostics/LogicalOrInJoinQuerySection.md,<br>docs/en/diagnostics/LogicalOrInJoinQuerySection.md | Добавлена документация по новой диагностике, описывающая проблему, примеры и рекомендации по исправлению. |
| src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/LogicalOrInJoinQuerySectionDiagnostic.java | Реализован новый диагностический класс для поиска использования ИЛИ в условиях JOIN по разным полям. |
| src/main/resources/com/github/_1c_syntax/bsl/languageserver/diagnostics/LogicalOrInJoinQuerySectionDiagnostic_en.properties,<br>src/main/resources/com/github/_1c_syntax/bsl/languageserver/diagnostics/LogicalOrInJoinQuerySectionDiagnostic_ru.properties | Добавлены локализационные файлы с сообщениями диагностики на русском и английском языках. |
| src/test/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/LogicalOrInJoinQuerySectionDiagnosticTest.java | Добавлен тестовый класс, проверяющий корректность выявления диагностики в различных сценариях. |
| src/test/resources/diagnostics/LogicalOrInJoinQuerySectionDiagnostic.bsl | Добавлен тестовый BSL-файл с примерами запросов, содержащих ИЛИ в условиях JOIN для тестирования диагностики. |
## Sequence Diagram(s)
```mermaid
sequenceDiagram
participant User
participant BSL_LanguageServer
participant LogicalOrInJoinQuerySectionDiagnostic
User->>BSL_LanguageServer: Запускает анализ кода с SQL-запросами
BSL_LanguageServer->>LogicalOrInJoinQuerySectionDiagnostic: Передаёт контекст запроса
LogicalOrInJoinQuerySectionDiagnostic->>LogicalOrInJoinQuerySectionDiagnostic: Анализирует условия JOIN на наличие ИЛИ по разным полям
LogicalOrInJoinQuerySectionDiagnostic-->>BSL_LanguageServer: Возвращает найденные диагностики
BSL_LanguageServer-->>User: Показывает предупреждения о найденных ИЛИ в JOIN
Poem
В запросах JOIN нашёлся ИЛИ,
По разным полям вдруг пробежал!
Диагностика тут, чтоб не были унылы,
Индексы спасём — и тормозов не стало!
Пусть код летит, как быстрый кролик,
Без ИЛИ в JOIN — наш главный ролик!((\
( -.-)
o_(")(")
<!-- walkthrough_end -->
<!-- announcements_start -->
> [!NOTE]
> <details>
> <summary>⚡️ AI Code Reviews for VS Code, Cursor, Windsurf</summary>
>
> CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
> Learn more [here](http://coderabbit.ai/ide).
>
> </details>
---
> [!NOTE]
> <details>
> <summary>⚡️ Faster reviews with caching</summary>
>
> CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure `Review - Disable Cache` at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the `Data Retention` setting under your Organization Settings.
> Enjoy the performance boost—your workflow just got faster.
>
> </details>
<!-- announcements_end -->
<!-- internal state start -->
<!-- DwQgtGAEAqAWCWBnSTIEMB26CuAXA9mAOYCmGJATmriQCaQDG+Ats2bgFyQAOFk+AIwBWJBrngA3EsgEBPRvlqU0AgfFwA6NPEgQAfACgjoCEYDEZyAAUASpETZWaCrKNwSPbABsvkCiQBHbGlcSHFcLzpIACIAMRI0PGx/AHovfCJ4BjRffD54LCF8AsggynlEUXF8DGjIOUhsSr4AGRIJGoAWbsgACltIMwBmToB2AEYASnRaWn9ESuR4Zl58KTYMXGR/L2oogkhYTFovAqJIdMzs3wB5O3xuZWqMZAB3dQRC4qwyl3sq+A1RAaGCwDwMI4YUjIZweU4YADW+3wKAWwUG4wArAA2cYaNxgyBKRAMCjwbjPSAYfA0ZAQnKRKHSSBkJjYTaUKLvXCwMKEgBqSHUeR41BoFCwrzBkryCLOkG5vPIiBo9CKBUQABoFQgIRdkXyPEoGEKamEUSQAB7cU4miLyJg+KroDD0VYMaQwnyQdUvdChHkeX7yCRC0KRKReEFwVBobirNB67TMZAHRDLG3wABm8kDFwyWRd9AzFDWHkhJ3l+CzChWkUtPu+Cld6kBL3xBgAgrNWzUGbJtXnEjyRbQkAwmot0Dwaex4Dl+BTlvAAF7UNtcAqt/uQLPwLzi+V5lX+NDMfg1pgt57ILMivO8aSsjzVw0xO51B5PEUCEh3/yMGCDBylCi5PG2yBmmOWZZpymy7vAJBeLQwKQAAEvgrztJQg4IG8+DePQ/hBPAAEFB0IHnHmbAjvQBz+LgZLYeg3rRB+YFUAQFCQVgaBUooHi4O8HralKWS8swaDyGgMHOn+e4mqysgdu41h2AUDBeNgxKNNwtB7KmFovMkgmEgIVAYHqqAThQ/jwYqb5KJGDz1BZELav4zBrAur5KAI2DnMctYbKqYAEaETBKNqQVMFIVCkBegGYNCCofGEISoQAIvORDUiqhbEqS5I3ugAGrKGSj0P+9Q0ryDjxnkqoXMl2BoNColpUouDaJE9A2JO85YLQ+ATiF65mkFDzPAuACiUKnIgvKMZgiC7M8HYAMrYA1FDiKByxtcy+5aSeexvr6PClh6CzypchYxTUY6UnuB6UPKV7pkonEQdGhJllQ3pEPgC6oAcZCQh6b7up68pBWObV5eIDCQTWd3XJAdzNk9EGpTyJQXb8iFLFgeaRSQAhoJUHb6MY4BQGQ9CvsOhCkOQnFREwrDsFwvD8MIAJSDIDoCVQqjqFoOg0yYUAxksMK8XgLNkE8HMsCFXBUK89iOJJfwNGTotqJo2i6GAhi06YBjDcjKTw7l+D5TbLQFtcNwUAAkhgABS3wAIrBC4G0AjUGjMLQHAGNEUcGBYkCdu7xDK+z9AOE4fyvvSTKIEYnZUiQWt24jBUjY47BhOovUxM7Vw5G7ns+wU/vlEHYhtnURwyCQZAzJVILu6EhVkr+MJEjlRcMOa+C+Dy1BEiQNBiKmhJNC+NZ5mjC6Y1+nEir0AAGgAYIIA2CAH3v0z402V7Y0CiX6d1FOVKUAdE79Rpjw7SOHPARCwKcP9bHyWeTR5SY0TKWBYo9ZJ2VCHuJCKEUBfBKI+Mc2RaSMEwJdbC8E8x3xUJTDwkkMCHRCvYWQKoSDnizKWc8wD9quitNIbUkQ0BjlAgcLM3hfAkhWkwmopA+DBhZJaUQeA2zlzYFqIsM4aCbHnL4dIwF5RIAcNIV+RIS4kM0s4bMRNAGhExlfXsfo4yZgNNBWC0DIASByMEFGb5EBng8LA5CpUPDUhgbsIgpBaDRSXk+VxCDxREJ8PIKay4VxRAKAcd2AA5LGRihaQA2r7FoLIoQFFUQSN+CMP6FgcF4jKfhpBT1DKBLMnjvGohUYkxAmZcB7XOJjZBWQDKBJRJUbgzgzqCM6btOkLA1DkHoA5AAqjE92Nw4mdhaKk7e412xJOwgDIRZ4bRHR8E0ZaNBHLv0dvUEgRxQx5C4DUDwUpOQY3uCTQkDi2AITgeo5k7iwhkgKXwDBlBSwUGiu4sEfBzkAS3kNbMFiy7OPgYxb+/DkCfLyLeEUCQ9RbwYDZOyIkpF8TxhQFOsBMLyi6sHLAr5MYlGVE1C6hibxqOtqXeCOREAon8JzDY8D/A2kTPKMlURfT9M2NoDAIC7AOR5QgjoXhSnnCiZQNg8Ntk0BWHkZwuYVCRGBEYGwf44LXXNBeBScj7DdVdM4eBQVh6hF4ImJGzJqqCLCcwVc8yilrQNAYx6CSEGNiQf4FBrTYSXTWPASq/o3wMw7LHTsr1vo3wODg0Quwo1+lfFabgjUogim4NgAQto0nhCJkYKAMT87qNGuwR1L0PAsMqlwPe1tEC212UjOt1cWleDrt7P2AdZAt3WmHPec8SRD1hqPHJezqoEtbqBDetx1KIJ+J2+JVLI7RwMBAMARha0pDIPWkdjaUjNtdh7dtjdO3drbKHcOS7ogx0sPHRObM9gpx1kqxKmdoQ5zzgXBtxcS3YIrlEaI+6FwAHI7hAY9UBr2NxYlgcEZUVuZpeiAdbYehuGAm6B0JZMdulN9nd0rXQPuA9pBFWHtOQuuSJ4zyIwvABeYV6JTzHvO4fa5lcVxp8T1WBKU4xKMk1JhNVGgmyfbPZrxnB+io40dMoEmM2D7RfEo3Gb7ZCwI+KQ2DCS4IfgQzAxCy6IDIfK3c1DGjiFOCuJR9DhEwtkq3SMA59QsKPCiDh3puEvF4UyAR86GETkpOICRPziyWVPJUIiSAESJQUQiVCqlyN7NqaIHR1wvDKooKQABsm+1Kb9LUzAArQLMG8OINZ9zkKSJw1lhdOMJr2DOJEMr9A/VSolDuO1q4DR71idl3YK9El5j42kzI5ApHDX4gGV5/C3xiYlGcFSmmNFl3KoG5kVpVmqpQBs06DS3zKOCCckbAKPBVdQCvRmvE6vzScYhFxvQxJ6mGk8mkLyoWUB2TurIkwgv8EDNxHUFyTvIDO+gUkDtkBFYPOSBr4Liaceq0CUSupeRjchW897ImkaEe1gUlUI8mVqwZlEPcDYGi1NOPUo8hJBFRJRBDkrDWOldO2QJ/pzBBlcjSnvMZEypkzL3tqRFvIHJ8Wk0QBrzTUEeBKHmClbrniDhRGgDogaoaUH/IQyGe3mTZGBw0LLHZuzX2Cal3Cwnx4KDisgLlapL5y5xlebqW4ZPMakfjrmroR7pntfGhCDZyIlPlPMRi2AxDJEp0GedDkWsyvnHKihKaqB/HvhtkUjP2ZP3KKKYCh01UGDi4t+CGktI6QZckSG/hQWWWZAcaseqFxEGwCt+EzJTUhEuparIzIdgPp1bapc9q1yUiCnRx+r4p2QBO1xu3QIOzmBvZG+ZhlHJxqZzVmsybU2Mz4BmrNhY5ziGkPmyAMTTl9FJpCBKlaR7kALgX7qlJdYImGq8LA5b2PhUgF5aCshYYYGFkoOeLRBNRASYfEKOK9FdS2RACgBgFISSAoFIIQJXNAFITmFITIHkTNFIAAfXGAYGwIMz5UtBSAEFWjSBahz0oDim3QxyyCbRdlrhQw7WbkJWyg+wYA0CQOsQjnAOvTjgTlZhVkfTTlCUvAv0Py7A/WHVoIni0QgT3iQzbVQ3Qy7VYK/QYD7Q7lwywCiVLFoBD0iWuQ8AACENpUkWgKCEog4KA4p/URAxBfprJdgIErQZF4E95OxSDloxANpMpjCWhBR0wuI2CZC+0gpYwMB3Ee8HIaIWFqA+ICgfUdt1BURpwyZ7A2BvR4tP5XwCh1d5kFxKg4p1AHNu8moDg+NtRHgKB8iq9vt2QJd759wSiOoeQXQWR8pJImpidxFV5+ARt7UMA8ASB5szcKN8wrh+A4oyQdJGNQwgiVC+0aJcU6J2kVMWJfALpekAFFQSg+JBEHdXCQRYgEVExeQtjnBcBtQUjoYFhq9CRZdrwcYGhXCqAJ1zhx9k15h0wb4qEWBMEkjBN+4EJI1II8AqROEhFHwbob4goGJ+UeJUs+QHYpcMAxUJVP9isoc358pLIYEbsUJjj7wwRH4XpxQogviYYEcUBQhKhnAIRrURQRpUVnw7F14GDp0OJqB7x8AkQFkZozjdwCJXRLkuS2NUdoU3xK0jFEo+JsjCwZsCsqIUQcF1CDVFVSBRjDgkJqjP954ViJ8kAABZLEtZWIAkxAGaa0b4tsPtAlCgQYo6GsPiT460qknQtEkpZkLyACGeIlEbMcXEsQRreoYWJ0d4jYhQLSZgEmVwopaE0tEqXYowqEm0iaEUhkxRfaNeG5eeOrCJIRD0OgHiEYowG4OKBkU3aQ83FbWRWBZAAmedODJMv5OEDk0U1jOFAJYHRTafP0f3cVeUOnbExrSRcpNqYbKiEkitZAFNGRcQBcdIxATIrwbYJCHvColJHgNXPIDXCtEUho71LIJo8nZSIwOfOOBfEqGNTTFfYAxKDfXaNNbfTNbNffPNFdY/ItHfbNOQ5ABQjkpQ5gjDeDDAEI8eMI2YQwifaA2A+AjARA5A1AlgdAj4LA3A/Awg7qYg0grwcgqEVqaEKgygGg8eegmuZDeuYC1Q0C8CijTg5AvtByPMO8HwPFUCH8wsZYxQCOSAXQCfTiieKwZwSoaAfwDweY9QFQ3oXw/w4S7iSgDQFQgAYRqBoEtAilwEtEmD7V6H+hmOZG0ysTDBFG4toEmEvXzSgJgLgP5RSHmAIhgOkGQuYFQswIEBwLwIINkCIJILIN2AIsoJsJIvlKdkAqYOPRYNovUOwLIA0FWGqIP0QB4OjnDQEKTh71Tl1lEKSiznfRv39USt0TfwAooqAsipAueDosdliowHitLCKukE0Jw1/DwygvoHZC+hgpsvgvsuKTL2crQIwNgHQq8qwrQBwv8ssKfGCooFIoozrT3kcNvH3CND/AyVTFeCMkhWkGrVCqNM9EOiYrSjzGsS0g8GiBAxsDA07PyGQHHSahKEg1iXh1qCkRrXUJiUcWOraNOpsQuqQ0gCurAxKAgygxiRgybMJWiFfkfnYCYlnNLAqjbOuA6zojjJPDOGQFOCRCROBzHTVIkQcRSjKLMXngBDYUJHHy3mqO5P+Q+CevBozz+GbJ+nPL4IjXFEXx1VjSAO5qTWtE334BfN3wnnfIkILRRFfWrwtEFqfK308FFpzVbGkAAG5+ikS+ICqHKBrCrKAkqQSzlOpCbDqEpMaoQ3gcN8NaAwDl1V0jBYLbKECdanK60hq0KPKMLvLfLcL8KG8grqDQryKW1yq0MT01D2DsCKBsB6rt4kqUqr00q70hDtYRCX1xDs5JCCqFEcgHVKQXbIY39qp+oboMEAr/aEoxMYR2qhS+BVT2CnUNyVTl5R9UZ2yabvw/sFM51M9WaZ9IBgSlA9xlQwgtq9bdoiY9r1CDqFgjr2M3wibDoYhAA8EEAEYQQAXhBAAGEEAAEQQAYRBAA2EEAFYQdeyAQAPhBAB+EEPu3s3sACEQU+7eoG4+A+MDQAJhBIBd7ABBEEAG4QU+l+wADhA/7IAP7T7D7AAWED/vXuPr/sAHkQOoXoTKcmsQKIYGsUkUbu166YIKD69gr6tgH6paQkIhO5aII+U+wAZhA/7ABxEEPo/sAC4QEBx+k+V+oBkB8ByB9emBwAURBIBAB2EE3vPu3tPo/s3rgcBpQZKEER5VANBFQDf2W1mMJBLvTAwXUtpMhQttrvR3N0XpSkWkwhJhRBXm4lnw5qvJxhvLWr5pKgFoTyanTVfL31kSSqMBP3IFtogPtoMEdtpFwEQusRcrcpGs9rGp8uwr8rwvLsIpmsDvUODoPSooqpoqqvUOgBCAYu4MsqTsEOTlTuyvTuSgkNzgKp8cYGcP/MUIirDqiuSfYNSZVGas7jaqDQserIWqzwREOmWtKcphhQ0oZn/M8NOjEGqqRjqdwD7V6UcUPAiWGU5wqYSaqcqrbBGayCWoHoijUoROnFFwaxKbMonx8d6B0p1HEiKR2sFlacdnliazuL6T0RWTECRJIG/lgAHliYCQTM2DURKY4V2j+SsTenrPucDEfiDoUFsmkBTRFLTEeBNAUnsEcshnSIsnakAlEEokNFIgNUuKkQZguAySkXpDePFBnCCJ+iE3QFuZKnoz4nKWCHgk7CsHdgNVkGhxFCAJKMJZqBNEqGVFi0JBKbIAcHmGBc0zVKYAhcefkFrPECBeHNK2ZOSDRWZDH3brsCaCXvQdg0JUSTOsDXXEpo8EfB5ZRv5pzI8DZSFq11zwvM5vAmjWbssfjTNahKFvsaVvFszqgGUrKZ7joGrXmaPUWaSeWZSZCHkywD3m8ZCD8ZQPdvcs8swtCYmvCb9qieaBifYLicYIWZUNPRqBWYYDGfSbQD3k/NUpeGDzEBFGtoDfCtzfDuitqZCCOYje6fkMDeUMbZqZkLGbLagAOtoj9fDgn2V3RpVFbY9T/In07eovzbArDfqcssgLXS8Zsp8b6tL1dvmqub3XraDbzYjpkI0FwoTo5vSvvSaiyufQzgzvyu/KujoBMgn0AHwQU+r+3eyhv+m+m+wAGRBAACEEPs3q/r/r4cADEQP+wAORBAAiEF/p3s3vk2JkYkUAMJ8ROb1A+irYASCl82GJHltSwCKOUGnhVS73XPKJRFWH0ODIcQ2yCmpA2C0VwBMjUW1ciEXiKUr21SCj4k5gzSagEHwCngSFfwJIQSSPlHOV+0YH1v5VTphAAmpAwDAAiVLCx2qPV3lgQTZjh1/CEi7kI5yGZBpRIWTxbxFPlYa0iCzFCBFQcgY9ZDWmffo5YEc+oGfdwFkEeAq3jFS3ehYDWQbBy2JnRNujVb6EPhPjPlQb+zATB0gUr3xLgVh0eKN35Yj0zyL20m9NNIaw1ENW1VVYotFOC/sE6UiPxRBTgg2ejI83Q95D9UfyiBw1hS7qn3dy2DUWhn0IAlw7QTzEESChVDyHuItekGK3qHBMeyt2ewYmSCJW30fYgRSN+d+xBFUo696fZWlyOADDFYboICnnsFxUIjnhoxZFsi7POSwGpvUiBzCxB3AXuqq8sRhw9VS4SUR1WpK77J4nsUcRDL9QZEwiiH0MEhRB6QCp0/a0H3JdUmTSqCiCGLZze18jVIlMoDlhZBec0HZvDTMYdeXysbX1dfluFsVrfKcY/KgCsEfZ64rXaurTfY/a/Z/YA6A5A/A6g9g5fvg8nZKCjfXZjYLucqDr3bKsqcPabePdwrLd4MgPNmljSUZmdMVmTpyeZW5j8DQC1mvb1n/2UDFmNkljNgMCV+ZXUGwMDUQCjvaEQiwloAIO6l2lNkV7pkgExE94AAYBBMRxhRgswABOAADizHGBIAACYGBMQswhghgo+I/A+veWEGB9ISAvePQI/Og0BMQI/6ApZ3faBOhA/A/aBg/OgsxMQGBy/A+0AvfxhsQvfA+GBS/Ohk+I/sRYIhhRhu+hhMRg+SBA/cRXeLYoALfcAreUJbfQx846Bar8+zYgA= -->
<!-- internal state end -->
<!-- tips_start -->
---
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.
<details>
<summary>❤️ Share</summary>
- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai)
- [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai)
- [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai)
- [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
</details>
<details>
<summary>🪧 Tips</summary>
### Chat
There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai?utm_source=oss&utm_medium=github&utm_campaign=1c-syntax/bsl-language-server&utm_content=3471):
- Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- `I pushed a fix in commit <commit_id>, please review it.`
- `Explain this complex logic.`
- `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 explain this code block.`
- `@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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.`
- `@coderabbitai read src/utils.ts and explain its main purpose.`
- `@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.`
### Support
Need help? Create a ticket on our [support page](https://www.coderabbit.ai/contact-us/support) for assistance with any issues or questions.
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)
- `@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 generate docstrings` to [generate docstrings](https://docs.coderabbit.ai/finishing-touches/docstrings) for this PR.
- `@coderabbitai generate sequence diagram` to generate a sequence diagram of the changes in this 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.
### Other keywords and placeholders
- Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed.
- Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description.
- Add `@coderabbitai` anywhere in the PR title to generate the title automatically.
### CodeRabbit Configuration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit.
- Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback.
- Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
</details>
<!-- tips_end -->
![coderabbitai[bot] avatar](https://avatars.githubusercontent.com/in/347564?v=4 "Published by a pub.dev verified publisher"){kind=small}