Update docs about validations #143
Conversation
| summary: Описание валидации и её настройки в приложениях ember-flexberry | ||
| --- | ||
|
|
||
| Практически неотъемлемой частью любого приложения, работающего с пользовательским вводом данных, является валидация этих данных. Валидация служит не только для предотвращения ошибок в приложении, но и для облегчения работы пользователя с приложением, предоставляя ему подсказки по ожидаемым форматам и ограничениям вводимых данных. |
There was a problem hiding this comment.
Второе предложение лучше начать с "Она"
|
|
||
| Практически неотъемлемой частью любого приложения, работающего с пользовательским вводом данных, является валидация этих данных. Валидация служит не только для предотвращения ошибок в приложении, но и для облегчения работы пользователя с приложением, предоставляя ему подсказки по ожидаемым форматам и ограничениям вводимых данных. | ||
|
|
||
| Валидация данных в приложениях на основе `Flexberry Ember` дополняет серверную валидацию, обычно реализуемую с помощью [бизнес-сервера объектов данных Flexberry ORM](fo_business-server.html). |
There was a problem hiding this comment.
после "серверную" не надо второй раз про валидацию
|
|
||
| ## Описание правил валидации | ||
|
|
||
| Способ описания правил валидации зависит от используемого в приложении аддона для валидации, это может быть [`ember-cp-validations`](#ember-cp-validations) или [`ember-validations`](#ember-validations). При генерации модели по её метаданным, также генерируется набор правил для её валидации, который зависит от различных параметров, указанных для атрибутов модели. |
There was a problem hiding this comment.
после "правил" убрать "валидации" достаточно второго упоминания
|
|
||
| ### ember-cp-validations | ||
|
|
||
| Аддон [`ember-cp-validations`](https://github.com/offirgolan/ember-cp-validations) имеет большой набор встроенных валидаторов гибко настраиваемых с помощью параметров, что позволяет описывать сложные правила валидации модели. |
|
|
||
| Аддон [`ember-cp-validations`](https://github.com/offirgolan/ember-cp-validations) имеет большой набор встроенных валидаторов гибко настраиваемых с помощью параметров, что позволяет описывать сложные правила валидации модели. | ||
|
|
||
| Чтобы реализвать валидацию модели с использованием аддона `ember-cp-validations`, необходимо использовать функцию `buildValidations`, предоставляемую этим аддоном, функция создаёт миксин, который нужно добавить к классу модели. |
| }); | ||
| ``` | ||
|
|
||
| Чтобы отключить валидацию в какой либо форме, необходимо установить `null` в значение свойства `validationModel` контроллера этой формы. |
There was a problem hiding this comment.
Для отключения валидации, какой-либо
|
|
||
| При необходимости можно установить в приложении оба аддона для валидации, и `ember-cp-validations`, и `ember-validations`, генерация моделей при этом будет выполнятся для аддона `ember-cp-validations`. | ||
|
|
||
| Если в приложении стауновен аддон `ember-validations`, и вы хотите дополнительно установить `ember-cp-validations`, выполните команду: |
There was a problem hiding this comment.
Если в приложении установлен... и требуется дополнительно ember-cp-validations, следует выполнить
| ember generate use-ember-cp-validations | ||
| ``` | ||
|
|
||
| При выполнении этой команды, в приложение будет установлен аддон `ember-cp-validations`, и добавлен сервис `validations` для совместимости аддонов. |
|
|
||
| При выполнении этой команды, в приложение будет установлен аддон `ember-cp-validations`, и добавлен сервис `validations` для совместимости аддонов. | ||
|
|
||
| Если в приложении стауновен аддон `ember-cp-validations`, и вы хотите дополнительно установить `ember-validations`, выполните команду: |
There was a problem hiding this comment.
Аналогично подобной фразе выше
| ember generate use-ember-validations | ||
| ``` | ||
|
|
||
| При выполнении этой команды, в приложение будет установлен аддон `ember-validations`, и добавлен сервис `validations` для совместимости аддонов. |
|
Я бы в первую очередь проверил актуальность этой документации, давно это было всё таки. |
WalkthroughВ данном изменении обновлены конфигурации боковых панелей документации Flexberry Ember. Основное изменение заключается в замене раздела "Model validation" на "Data validation" с соответствующими изменениями заголовка и URL. Удалены старые файлы, связанные с валидацией модели, и добавлен новый файл, который подробно описывает процесс валидации данных в приложениях на основе Flexberry Ember. Changes
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? 🪧 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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Outside diff range and nitpick comments (3)
pages/products/flexberry-ember/3.x/work-with-data/efd3_validations.ru.md (3)
12-14: Улучшение читаемости текстаПредлагаю следующие улучшения:
- Второе предложение начать со слова "Она"
- После слова "серверную" убрать повторное упоминание валидации
-Практически неотъемлемой частью любого приложения, работающего с пользовательским вводом данных, является валидация этих данных. Валидация служит не только для предотвращения ошибок в приложении, но и для облегчения работы пользователя с приложением, предоставляя ему подсказки по ожидаемым форматам и ограничениям вводимых данных. +Практически неотъемлемой частью любого приложения, работающего с пользовательским вводом данных, является валидация этих данных. Она служит не только для предотвращения ошибок в приложении, но и для облегчения работы пользователя с приложением, предоставляя ему подсказки по ожидаемым форматам и ограничениям вводимых данных. -Валидация данных в приложениях на основе `Flexberry Ember` дополняет серверную валидацию, обычно реализуемую с помощью [бизнес-сервера объектов данных Flexberry ORM](fo_business-server.html). +Валидация данных в приложениях на основе `Flexberry Ember` дополняет серверную проверку, обычно реализуемую с помощью [бизнес-сервера объектов данных Flexberry ORM](fo_business-server.html).
20-20: Устранение избыточности в текстеПредлагаю убрать слово "валидации" после "правил", так как оно избыточно в контексте.
-Способ описания правил валидации зависит от используемого в приложении аддона для валидации, это может быть [`ember-cp-validations`](#ember-cp-validations) или [`ember-validations`](#ember-validations). При генерации модели по её метаданным, также генерируется набор правил для её валидации, который зависит от различных параметров, указанных для атрибутов модели. +Способ описания правил зависит от используемого в приложении аддона для валидации, это может быть [`ember-cp-validations`](#ember-cp-validations) или [`ember-validations`](#ember-validations). При генерации модели по её метаданным, также генерируется набор правил для её валидации, который зависит от различных параметров, указанных для атрибутов модели.
70-70: Удаление избыточной разметкиСлово "raw" в разметке избыточно и может быть удалено.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (6)
- _data/sidebars/flexberry-ember-2_sidebar.yml (1 hunks)
- _data/sidebars/flexberry-ember-3_sidebar.yml (1 hunks)
- pages/products/flexberry-ember/2.x/work-with-data/efd2_model-validation.en.md (0 hunks)
- pages/products/flexberry-ember/2.x/work-with-data/efd2_model-validation.ru.md (0 hunks)
- pages/products/flexberry-ember/3.x/work-with-data/efd3_model-validation.ru.md (0 hunks)
- pages/products/flexberry-ember/3.x/work-with-data/efd3_validations.ru.md (1 hunks)
💤 Files with no reviewable changes (3)
- pages/products/flexberry-ember/2.x/work-with-data/efd2_model-validation.en.md
- pages/products/flexberry-ember/2.x/work-with-data/efd2_model-validation.ru.md
- pages/products/flexberry-ember/3.x/work-with-data/efd3_model-validation.ru.md
🧰 Additional context used
🪛 LanguageTool
pages/products/flexberry-ember/3.x/work-with-data/efd3_validations.ru.md
[uncategorized] ~90-~90: Пропущена запятая: «внимание, что».
Context: ...ndraw %} ``` Обратите внимание что для отображения ошибок валидации одного...(CHTO_COMMA)
[uncategorized] ~189-~189: Два глагола в личной форме подряд. Второй глагол должен быть в неопределённой форме: «будет выполниться»
Context: ...alidations, генерация моделей при этом будет выполнятся для аддонаember-cp-validations`. Есл...(Verb_and_Verb)
🔇 Additional comments (2)
_data/sidebars/flexberry-ember-3_sidebar.yml (1)
54-56: Изменения корректны, требуется проверка URL.Переименование раздела с "Model validation" на "Data validation" логично отражает более широкий охват темы валидации. Однако необходимо убедиться, что новый URL
/efd3_validations.htmlкорректно ведет на обновленную документацию.Выполните следующий скрипт для проверки существования файла документации:
✅ Verification successful
URL и файл документации корректны
Проверка подтвердила, что:
- Файл документации существует по пути
pages/products/flexberry-ember/3.x/work-with-data/efd3_validations.ru.md- URL в sidebar (
/efd3_validations.html) соответствует указанному в файле документации (permalink: ru/efd3_validations.html)- Заголовок в документации ("Валидация данных") соответствует указанному в sidebar
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Описание: Проверка наличия файла документации по валидации # Поиск файлов документации с именем validations fd "validations\.(ru|en)\.(md|html)$"Length of output: 112
Script:
#!/bin/bash # Проверка содержимого файла документации для подтверждения его актуальности cat pages/products/flexberry-ember/3.x/work-with-data/efd3_validations.ru.md | head -n 10Length of output: 377
_data/sidebars/flexberry-ember-2_sidebar.yml (1)
163-165: Подтвердите актуальность документации.Изменение корректно отражает переход от валидации моделей к более общей концепции валидации данных. Однако, учитывая комментарий в PR о необходимости проверки актуальности документации, рекомендуется:
- Убедиться, что новый URL
/efd3_validations.htmlсодержит актуальную информацию- Проверить, что все примеры кода и описания соответствуют текущей версии Flexberry Ember 2.x
✅ Verification successful
Let me gather more information about the new validation documentation to ensure it's properly linked and accessible.
Изменение корректно и актуально
Проверка показала, что:
- Новый файл документации
efd3_validations.ru.mdсуществует и содержит актуальную, подробную информацию о валидации данных- URL
/efd3_validations.htmlкорректно соответствует расположению файла документации- Содержимое включает актуальную информацию о валидации для Flexberry Ember 3.x, включая:
- Описание различных подходов к валидации
- Примеры использования ember-cp-validations
- Актуальные компоненты для отображения ошибок валидации
Изменение в sidebar полностью соответствует обновленной структуре документации.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Проверка существования и доступности файла документации # Описание: Проверяем наличие файла документации и связанных файлов # Поиск файлов документации с похожими именами fd -e md -e html "validations|validation" # Поиск ссылок на старую документацию rg -i "model.?validation"Length of output: 1196
Script:
#!/bin/bash # Проверка содержимого новой документации по валидации cat "pages/products/flexberry-ember/3.x/work-with-data/efd3_validations.ru.md" # Проверка наличия старой документации и её содержимого fd -e md -e html "model-validation"Length of output: 11326
|
|
||
| ## Одновременное использование ember-cp-validations и ember-validations | ||
|
|
||
| При необходимости можно установить в приложении оба аддона для валидации, и `ember-cp-validations`, и `ember-validations`, генерация моделей при этом будет выполнятся для аддона `ember-cp-validations`. |
There was a problem hiding this comment.
Исправление грамматики
Необходимо исправить форму глагола "выполнятся" на "выполняться".
-При необходимости можно установить в приложении оба аддона для валидации, и `ember-cp-validations`, и `ember-validations`, генерация моделей при этом будет выполнятся для аддона `ember-cp-validations`.
+При необходимости можно установить в приложении оба аддона для валидации, и `ember-cp-validations`, и `ember-validations`, генерация моделей при этом будет выполняться для аддона `ember-cp-validations`.📝 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.
| При необходимости можно установить в приложении оба аддона для валидации, и `ember-cp-validations`, и `ember-validations`, генерация моделей при этом будет выполнятся для аддона `ember-cp-validations`. | |
| При необходимости можно установить в приложении оба аддона для валидации, и `ember-cp-validations`, и `ember-validations`, генерация моделей при этом будет выполняться для аддона `ember-cp-validations`. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~189-~189: Два глагола в личной форме подряд. Второй глагол должен быть в неопределённой форме: «будет выполниться»
Context: ...alidations, генерация моделей при этом будет выполнятся для аддонаember-cp-validations`. Есл...(Verb_and_Verb)
| </form> | ||
| ``` | ||
|
|
||
| Обратите внимание что для отображения ошибок валидации одного свойства, в компоненте `{% raw %}{{flexberry-validationmessage}}{% endraw %}`, по умолчанию используется выражение `(v-get validationModel "lastName" "message")`. Таким образом будет отображена ошибка валидации только об одном не выполненном правиле валидации для этого свойства. Если необходимо выводить сразу все ошибки, можно использовать выражение `(v-get validationModel "lastName" "messages")`. |
There was a problem hiding this comment.
Исправление пунктуации
Необходимо добавить запятую после слова "внимание".
-Обратите внимание что для отображения ошибок валидации одного свойства
+Обратите внимание, что для отображения ошибок валидации одного свойства📝 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.
| Обратите внимание что для отображения ошибок валидации одного свойства, в компоненте `{% raw %}{{flexberry-validationmessage}}{% endraw %}`, по умолчанию используется выражение `(v-get validationModel "lastName" "message")`. Таким образом будет отображена ошибка валидации только об одном не выполненном правиле валидации для этого свойства. Если необходимо выводить сразу все ошибки, можно использовать выражение `(v-get validationModel "lastName" "messages")`. | |
| Обратите внимание, что для отображения ошибок валидации одного свойства, в компоненте `{% raw %}{{flexberry-validationmessage}}{% endraw %}`, по умолчанию используется выражение `(v-get validationModel "lastName" "message")`. Таким образом будет отображена ошибка валидации только об одном не выполненном правиле валидации для этого свойства. Если необходимо выводить сразу все ошибки, можно использовать выражение `(v-get validationModel "lastName" "messages")`. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~90-~90: Пропущена запятая: «внимание, что».
Context: ...ndraw %} ``` Обратите внимание что для отображения ошибок валидации одного...(CHTO_COMMA)
https://kollegoff.github.io/flexberry.github.io/ru/efd3_validations.html
Summary by CodeRabbit
Новые функции
Удаленные файлы