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

Обновление документации по изменениям ORM 6.0.0 - 7.* #169

Open
wants to merge 12 commits into
base: master
Choose a base branch
from

Conversation

turbcool
Copy link
Contributor

No description provided.

@@ -27,14 +27,14 @@ lang: ru
Для работы детейлов в [расширенном редакторе ограничений в web](fa_advanced-limit-editor.html) при применении ограничения на [WOLV](fa_web-object-list-view.html), может потребоваться:
* [Задать детейлы в представление](fa_prop-order-limit-editor.html), если их ещё там нет.
* Задать [свойство AutoAddUsedInLimitationProperties](fa_prop-order-limit-editor.html), чтобы представление формировалось динамически.
* Определить механизм формирования динамического представления для детейлов через интерфейс ICSSoft.STORMNET.Windows.Forms.IViewGenerator (расположен в сборке ExternalLangDef). Например, в версии после 14.01.2015 можно в конфиг добавить следующую строчку:
* Определить механизм формирования динамического представления для детейлов через интерфейс ICSSoft.STORMNET.Windows.Forms.IViewGenerator (расположен в сборке ICSSoft.STORMNET.Business.ExternalLangDef). Например, в версии после 14.01.2015 можно в конфиг добавить следующую строчку:
Copy link
Contributor

Choose a reason for hiding this comment

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

Вероятно фразу "в версии после 14.01.2015" уже можно удалить.
И также написать альтернативный вариант, как такое сделать с помощью кода.

<container>
...
<register type="ICSSoft.STORMNET.Windows.Forms.IViewGenerator, ExternalLangDef" mapTo="NewPlatform.Flexberry.Web.Page.LimitEditorViewGenerator, NewPlatform.Flexberry.Web.LimitEditor" />
<register type="ICSSoft.STORMNET.Windows.Forms.IViewGenerator, ICSSoft.STORMNET.Business.ExternalLangDef" mapTo="NewPlatform.Flexberry.Web.Page.LimitEditorViewGenerator, NewPlatform.Flexberry.Web.LimitEditor" />
Copy link
Contributor

Choose a reason for hiding this comment

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

Надо перепроверить, актуален ли вариант, указанный в "mapTo".

@@ -10,17 +10,15 @@ lang: ru

Список библиотек, содержащих Runtime-компоненты [Flexberry ORM](fo_flexberry-orm.html):

* **ChangesToSqlBTMonitor.dll** - библиотека, содержащая классы для работы [сервиса записи SQL-скриптов изменения данных](fo_changes-sql-bt-monitor.html).
* **ExternalLangDef.dll** - библиотека, содержащая [расширение языка ограничений](fo_external-lang-def.html) для [задания ограничений](fo_limit-function.html) на зависимые объекты.
* **ChangesToSqlBTMonitor.dll** - библиотека, содержащая
Copy link
Contributor

@Anisimova2020 Anisimova2020 Jul 17, 2023

Choose a reason for hiding this comment

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

Что-то не до конца поправлено? Эта библиотека ещё есть?

@@ -64,12 +64,12 @@ __Примечание__: если в представление у поля д

### Сервис данных

По умолчанию для выгрузки в Excel используется сервис данных `DataServiceProvider.DataService`. Если требуется задать другой, отдельный сервис данных для выгрузки в Excel, то это может быть сделано в `Web.config` путем регистрации сервиса под именем `ExcelExportDataService` в `Unity`. Пример конфигурации, чтобы для выгрузки в Excel использовался сервис данных `IcsharpSoft.STORMNET.Business.DRDataService`:
По умолчанию для выгрузки в Excel используется сервис данных `DataServiceProvider.DataService`. Если требуется задать другой, отдельный сервис данных для выгрузки в Excel, то это может быть сделано в `Web.config` путем регистрации сервиса под именем `ExcelExportDataService` в `Unity`. Пример конфигурации, чтобы для выгрузки в Excel использовался сервис данных `ICSSoft.STORMNET.Business.DRDataService`:
Copy link
Contributor

Choose a reason for hiding this comment

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

Нужно перепроверить, что "По умолчанию для выгрузки в Excel используется сервис данных DataServiceProvider.DataService." Вообще нужно отметить, что DataServiceProvider.DataService ныне obsolete.
Также сейчас для сервисов данных регистрация в Юнити выглядит иначе.

…xberry.github.io into feature-232917-update-docs

```csharp
IUnityContainer container = UnityFactory.CreateContainer();
IUnityContainer container = UnityFactory.CreateContainer(); //UnityFactory is deprecated. Inject IUnityContainer (or IServiceProvider) instead.
Copy link
Contributor

Choose a reason for hiding this comment

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

Мне кажется, что само упоминание UnityFactory в этом месте нужно вырезать в коде. То есть в коде показать, как правильно, без factory, а в комментарии указать, что ранее использовалось UnityFactory, но ныне этот класс устарел.

IDataService dataService = container.Resolve<IDataService>("DRDataService");
dataService.CustomizationString = DataServiceProvider.DataService.CustomizationString;
```
dataService.CustomizationString = DataServiceProvider.DataService.CustomizationString; // DataServiceProvider is deprecated; inject IDataService instead
Copy link
Contributor

Choose a reason for hiding this comment

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

Аналогично: код меняем на то, что ныне правильно.

@@ -35,15 +35,15 @@ Setting `DRDataService` via the configuration file :

<unity xmlns="http://schemas.microsoft.com/practices/2010/unity">
<container>
<register name="DRDataService" type="ICSSoft.STORMNET.Business.IDataService, ICSSoft.STORMNET.Business" mapTo="ICSSoft.STORMNET.Business.DRDataService, ICSSoft.STORMNET.Business.DRDataService">
<register name="DRDataService" type="ICSSoft.STORMNET.Business.IDataService, ICSSoft.STORMNET.Business" mapTo="ICSSoft.STORMNET.Business.DRDataService, ICSSoft.STORMNET.Business.MSSQLDataService">
Copy link
Contributor

Choose a reason for hiding this comment

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

Сейчас сервисы данных иначе регистрируются

@@ -15,9 +15,9 @@ lang: ru
Экземпляр DRDataService можно получить через [UnityFactory](fo_unity-factory.html), выполнив следующий код:

```csharp
IUnityContainer container = UnityFactory.CreateContainer();
IUnityContainer container = UnityFactory.CreateContainer(); // UnityFactory устарел. Вместо него используйте внедрение зависимостей (инжектите IUnityContainer/IServiceProvider или напрямую нужные зависимости).
Copy link
Contributor

Choose a reason for hiding this comment

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

Код нужно написать по-новому.

IDataService dataService = container.Resolve<IDataService>("DRDataService");
dataService.CustomizationString = DataServiceProvider.DataService.CustomizationString;
dataService.CustomizationString = DataServiceProvider.DataService.CustomizationString; // DataServiceProvider устарел; вместо него используйте внедрение зависимостей.
Copy link
Contributor

Choose a reason for hiding this comment

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

Код нужно написать по-новому.

var lcs = LoadingCustomizationStruct.GetSimpleStruct(typeof(СтрокаЗаказа), СтрокаЗаказа.Views.СтрокаЗаказаE);
lcs.LimitFunction = FunctionBuilder.BuildEquals<СтрокаЗаказа>(x => x.Заказ, заказ);
var строкиЗаказа = DataServiceProvider.DataService.LoadObjects(lcs);
var строкиЗаказа = DataServiceProvider.DataService.LoadObjects(lcs); // DataServiceProvider устарел; вместо него используйте внедрение зависимостей
Copy link
Contributor

Choose a reason for hiding this comment

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

Код нужно новый. Потому что прикладные проекты часто просто копируют.

Copy link
Contributor

Choose a reason for hiding this comment

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

Непонятно, почему у данного файла изменена только английская версия.

@@ -78,9 +78,9 @@ public virtual ICSSoft.STORMNET.DataObject[] OnUpdateЗаказ(АСУ_Скла

ICSSoft.STORMNET.Business.LoadingCustomizationStruct lcs = ICSSoft.STORMNET.Business.LoadingCustomizationStruct.GetSimpleStruct(typeof(ТоварНаСкладе),"Tavernacle");
lcs.LimitFunction = lf;
ICSSoft.STORMNET.DataObject[] objs = ICSSoft.STORMNET.Business.DataServiceProvider.DataService.LoadObjects(lcs);
ICSSoft.STORMNET.DataObject[] objs = ICSSoft.STORMNET.Business.DataServiceProvider.DataService.LoadObjects(lcs); // DataServiceProvider is deprecated; inject IDataService instead
Copy link
Contributor

Choose a reason for hiding this comment

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

Нужно переписать без использования DataServiceProvider.DataService.

@@ -189,7 +189,7 @@ private static DataObject[] changeOrderStatusPaid(IIS.Shop.Order UpdatedObject)
sortColumns.Add(new ColumnsSortDef("Storehouse.Number", SortOrder.Asc));
lcs.ColumnsSort = sortColumns.ToArray();

DataObject[] objs = DataServiceProvider.DataService.LoadObjects(lcs);
DataObject[] objs = DataServiceProvider.DataService.LoadObjects(lcs); // DataServiceProvider устарел; вместо него используйте внедрение зависимостей
Copy link
Contributor

Choose a reason for hiding this comment

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

Нужно переписать код на правильный вариант.

@@ -210,7 +210,7 @@ private static DataObject[] changeOrderStatusPaid(IIS.Shop.Order UpdatedObject)
{
...

DataObject[] objs = DataServiceProvider.DataService.LoadObjects(lcs);
DataObject[] objs = DataServiceProvider.DataService.LoadObjects(lcs); // DataServiceProvider устарел; вместо него используйте внедрение зависимостей
Copy link
Contributor

Choose a reason for hiding this comment

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

Переписать код нужно


## Пример

```csharp
ExternalLangDef externalLangDef = ExternalLangDef.LanguageDef;

ExternalLangDef externalLangDef = ExternalLangDef.LanguageDef; // Использование ExternalLangDef.LanguageDef является устаревшим. Вместо него используйте конструктор (new ExternalLangDef(dataService)).
Copy link
Contributor

Choose a reason for hiding this comment

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

Код нужно переписать.

@@ -33,7 +33,7 @@ Expression is Empty/is nonempty can be applied to:
If you have a class with a property `Кредит` `СуммаКредита` real type, the translation in [LINQProvider|LinqProvider) it will be presented as follows:

``` csharp
var ds = (SQLDataService)DataServiceProvider.DataService;
var ds = (SQLDataService)DataServiceProvider.DataService; // DataServiceProvider is deprecated; inject IDataService instead
Copy link
Contributor

Choose a reason for hiding this comment

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

код нужно переписать.

@@ -31,7 +31,7 @@ lang: ru
Если имеется класс `Кредит` со свойством `СуммаКредита` вещественного типа, то при переводе в [LINQProvider|LinqProvider) оно будет представляться следующим образом:

``` csharp
var ds = (SQLDataService)DataServiceProvider.DataService;
var ds = (SQLDataService)DataServiceProvider.DataService; // DataServiceProvider устарел; вместо него используйте внедрение зависимостей
Copy link
Contributor

Choose a reason for hiding this comment

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

Переписать.

@@ -48,10 +48,10 @@ ctrlКлиент.LimitFunction = onlyPermKlients;

Дополнительно, необходимо отображать только работающих `КредитныхИнспекторов`.

1.Построить ограничения, испльзуя LINQ-провайдер:
1.Построить ограничения, испльзуя LINQ-провайдер:
Copy link
Contributor

Choose a reason for hiding this comment

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

Можно сразу опечатку поправить. "испОльзуя "


```csharp
var ds = (SQLDataService) DataServiceProvider.DataService;
var ds = (SQLDataService) DataServiceProvider.DataService; // DataServiceProvider устарел; вместо него используйте внедрение зависимостей
Copy link
Contributor

Choose a reason for hiding this comment

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

Переписать.

@@ -81,7 +81,7 @@ private void CustomToolbarButtonClickHandler(object sender, ToolBarBtnEventArgs
{
var objects = eventArgs.PrimaryKeys.Select(x => new Город { __PrimaryKey = Guid.Parse(x) })
.Cast<DataObject>().ToArray();
DataServiceProvider.DataService.LoadObjects(objects, Город.Views.ГородL, true);
DataServiceProvider.DataService.LoadObjects(objects, Город.Views.ГородL, true); // DataServiceProvider устарел; вместо него используйте внедрение зависимостей
Copy link
Contributor

Choose a reason for hiding this comment

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

Переписать.

// Помечаем пришедший объект на удаление (в данном примере это будет адрес медицинского учреждения).
args.DataObj.SetStatus(ICSSoft.STORMNET.ObjectStatus.Deleted);
try
{ // Пытаемся удалить (дальнейшая обработка происходит в Бизнес-сервере АдресБС.cs).
// Если во время удаления произойдет ошибка, мы сможем ее обработать в блоке catch.
// Если АдресБС.cs найдет учреждения, ссылающиеся на удаляемый адрес, он кинет ConfirmAdresDeletingException.
ICSSoft.STORMNET.Business.DataServiceProvider.DataService.UpdateObject(args.DataObj);
ICSSoft.STORMNET.Business.DataServiceProvider.DataService.UpdateObject(args.DataObj); // DataServiceProvider устарел; вместо него используйте внедрение зависимостей
Copy link
Contributor

Choose a reason for hiding this comment

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

Переписать.

@@ -150,7 +150,7 @@ public virtual ICSSoft.STORMNET.DataObject[] OnUpdateАдрес(IIS.MedicalInsti
if (UpdatedObject.GetStatus() == ObjectStatus.Deleted)
{
//Получим список учреждений ссылающихся на удаляемый адрес
var ds = (SQLDataService)DataServiceProvider.DataService;
var ds = (SQLDataService)DataServiceProvider.DataService; // DataServiceProvider устарел; вместо него используйте внедрение зависимостей
Copy link
Contributor

Choose a reason for hiding this comment

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

Переписать.

@@ -287,7 +287,7 @@ protected override void Preload()
return deletingAdres;
}).ToArray<Адрес>();
//Удаляем. (Дальнейшая обработка происходит в АдресБС)
DataServiceProvider.DataService.UpdateObjects(ref deletingAdreses);
DataServiceProvider.DataService.UpdateObjects(ref deletingAdreses); // DataServiceProvider устарел; вместо него используйте внедрение зависимостей
Copy link
Contributor

Choose a reason for hiding this comment

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

Переписать.

// ...

protected void Application_Start(object sender, EventArgs e)
{
// Инициализация сервиса аудита
AuditSetter.InitAuditService(BridgeToDS.GetDataService());
IServiceProvider serviceProvider; // Используйте внедрение зависимостей чтобы получить IServiceProvider; вместо IServiceProvider можно использовать IUnityContainer
Copy link
Contributor

Choose a reason for hiding this comment

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

Нужно написать так, чтобы было понятно, откуда IServiceProvider serviceProvider;, а то такой фрагмент кода нерабочий.

// ...

protected void Application_Start(object sender, EventArgs e)
{
// Инициализация сервиса аудита
AuditSetter.InitAuditService(BridgeToDS.GetDataService());
IServiceProvider serviceProvider; // Используйте внедрение зависимостей чтобы получить IServiceProvider; вместо IServiceProvider можно использовать IUnityContainer
var IAuditService = serviceProvider.GetService<IAuditService>(BridgeToDS.GetDataService());
Copy link
Contributor

Choose a reason for hiding this comment

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

Нужно перепроверить, а существует ли вообще класс BridgeToDS. Тут вероятно нужно тоже через Unity резолвить.

@@ -25,7 +25,7 @@ lang: ru
Отдельной строкой идёт изменение [первичного ключа объекта](fo_primary-keys-objects.html) (такая строка формируется при изменении детейла или мастера). Доступно два режима отображения этих строчек: они совсем не отображаются или они скрываются в древовидную структуру (второй вариант был реализован в [старой версии аудита](efs_audit.html)). По умолчанию реализуется первый вариант, но это можно изменить следующей инициализацией:

```csharp
AuditService.Current.ShowPrimaryKey = true;
AuditService.Current.ShowPrimaryKey = true; // AuditService.Current удалён в ORM версии 8.0. Используйте внедрение зависимостей для инжекта IAuditService.
Copy link
Contributor

Choose a reason for hiding this comment

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

Переписать на корректный вариант.

@@ -71,7 +71,7 @@ AuditService.Current.ShowPrimaryKey = true;
Чтобы отключить отображение записей, содержащих [первичные ключи](fo_primary-keys-objects.html) [мастеров](fd_master-association.html) и [детейлов](fo_detail-associations-properties.html), можно выполнить следующую настройку:

```csharp
AuditService.Current.ShowPrimaryKey = false;
AuditService.Current.ShowPrimaryKey = false; // AuditService.Current удалён в ORM версии 8.0. Используйте внедрение зависимостей для инжекта IAuditService.
Copy link
Contributor

Choose a reason for hiding this comment

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

Аналогично.

```
##### В запросе с использованием LCS
```c#
var ldef = ExternalLangDef.LanguageDef; // Использование ExternalLangDef.LanguageDef является устаревшим. Вместо него используйте конструктор (new ExternalLangDef(dataService)).
Copy link
Contributor

Choose a reason for hiding this comment

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

Переписать

@@ -66,17 +67,18 @@ dobj.GetStatus();//Для того чтобы статус объекта был
``` csharp
dobj.DisableInitDataCopy(); // запрещаем инициализацию копии данных
ICSSoft.STORMNET.Business.DataServiceProvider.DataService.LoadObject(view, dobj, false, false); // дочитка объекта данных
// DataServiceProvider устарел; вместо него используйте внедрение зависимостей
Copy link
Contributor

Choose a reason for hiding this comment

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

Переписать.

@@ -85,15 +87,15 @@ dobj.EnableInitDataCopy();// возвращаем инициализацию к
ТипОбъекта dobj_forLoading = new ТипОбъекта();
dobj_forLoading.SetExistingPrimaryKey(dobj.__PrimaryKey);
// view - требуемое представление. Его состав зависит от задачи.
ICSSoft.STORMNET.Business.DataServiceProvider.DataService.LoadObject(view, dobj_forLoading);
ICSSoft.STORMNET.Business.DataServiceProvider.DataService.LoadObject(view, dobj_forLoading); // DataServiceProvider устарел; вместо него используйте внедрение зависимостей
Copy link
Contributor

Choose a reason for hiding this comment

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

Переписать.

```

{% include note.html content="Если при вызове метода `LoadObject` явно не указать [представление](fd_view-definition.html), то будут вычитываться все собственные поля объекта и ссылки на мастера без собственных полей мастеров. При этом детейлы объекта вычитываться **не будут**." %}

Чтобы дочитать объект таким образом, необходимо использовать перегрузку метода `LoadObject` без параметра типа `View`. К примеру, подойдет самая простая перегрузка:

```csharp
ICSSoft.STORMNET.Business.DataServiceProvider.DataService.LoadObject(dobj_forLoading);
ICSSoft.STORMNET.Business.DataServiceProvider.DataService.LoadObject(dobj_forLoading); // DataServiceProvider устарел; вместо него используйте внедрение зависимостей
Copy link
Contributor

Choose a reason for hiding this comment

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

Переписать.

```csharp
using ICSSoft.STORMNET.Business;
var DS = DataServiceProvider.DataService as SQLDataService; // DataServiceProvider устарел; вместо него используйте внедрение зависимостей
Copy link
Contributor

Choose a reason for hiding this comment

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

Переписать.

@@ -40,7 +40,7 @@ cdbm.CustomMasterAttribute = new RandomStringGenerator().Generate(200);
cdbo.CustomDBMasterClass = cdbm;
cdbo.CustomOwnAttribute = new RandomStringGenerator().Generate(200);

IDataService dataService = DataServiceProvider.DataService;
IDataService dataService = DataServiceProvider.DataService; // DataServiceProvider устарел; вместо него используйте внедрение зависимостей
Copy link
Contributor

Choose a reason for hiding this comment

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

Переписать.

@@ -8,6 +8,7 @@ lang: ru
---

# AuditSetter
> AuditSetter отсутствует в ORM v8.0. Необходимо самостоятельно регистрировать IAuditService через механизм внедрения зависимостей.
Copy link
Contributor

Choose a reason for hiding this comment

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

Нужно написать, как теперь правильно.

@@ -129,7 +129,7 @@ Now when I try to create the report in the audit database will be created corres
AuditService.Current.RatifyAuditOperation(
Copy link
Contributor

Choose a reason for hiding this comment

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

Нужно переписать

@@ -82,7 +82,7 @@ finally
AuditService.Current.RatifyAuditOperation(
Copy link
Contributor

Choose a reason for hiding this comment

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

Переписать

@@ -105,7 +105,7 @@ finally
};

// Записываем операцию аудита в базу и запоминаем ID созданной записи
Guid? auditOperationId = AuditService.Current.WriteCustomAuditOperation(auditParams, true);
Guid? auditOperationId = AuditService.Current.WriteCustomAuditOperation(auditParams, true); // AuditService.Current удалён в ORM версии 8.0. Используйте внедрение зависимостей для инжекта IAuditService.
Copy link
Contributor

Choose a reason for hiding this comment

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

Переписать

@@ -127,7 +127,7 @@ finally
AuditService.Current.RatifyAuditOperation(
Copy link
Contributor

Choose a reason for hiding this comment

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

Переписать


// Инициализация сервиса аудита
AuditSetter.InitAuditService(DataServiceProvider.DataService);
IUnityContainer container; // контейнер необходимо получить через внедрение зависимостей; вместо IUnityContainer можно использовать IServiceProvider
Copy link
Contributor

Choose a reason for hiding this comment

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

Нужен код получения контейнера

Copy link

coderabbitai bot commented Oct 25, 2024

Important

Review skipped

More than 25% of the files skipped due to max files limit. The review is being skipped to prevent a low-quality review.

71 files out of 153 files are above the max files limit of 75. Please upgrade to Pro plan to get higher limits.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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>, please review it.
    • 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 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 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 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 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 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants