tech: add plugin eslint-plugin-jsdoc to check jsdocs require
#8387
Conversation
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. |
size-limit report 📦
|
e2e tests |
👀 Docs deployed
Commit ffad473 |
packages/vkui/src/components/PanelHeaderContext/PanelHeaderContext.tsx
Outdated
Show resolved
Hide resolved
|
Мейби |
|
А в рамках этого |
| expanded: boolean; | ||
| /** | ||
| * Колбэк для изменения состояния аккордеона |
There was a problem hiding this comment.
Вопрос на обсуждение - насколько уместно называть это "колбэк", все-таки это больше разговорный термин? Мейби "обработчик"? Функция-обработчик?
There was a problem hiding this comment.
Прошелся везде, где нашел "колбэк", "коллбэк", "callback" и заменио на обработчик
| * Режим отображения компонента: | ||
| * | ||
| * - `"sheet"`: отображение снизу экрана, подходит для мобильных устройств | ||
| * - `"menu"`: отображение в виде поповера, относительно якорного элемента |
There was a problem hiding this comment.
"попап", "поповер" тоже сомнения, что звучит понятно. Всплывающее окно (элемент)?
There was a problem hiding this comment.
Везде, где нашел "попап", "поповер" и заменил на Всплывающее окно (элемент
| isCancelItem: boolean; | ||
| }) => (event: React.MouseEvent) => void; | ||
|
|
||
| export type ActionSheetContextType<T extends Element = Element> = { | ||
| /** | ||
| * Обработчик клика по элементу |
There was a problem hiding this comment.
Здесь и в остальных случаях слово "клик", возможно, нужно заменить на "нажатие"?
There was a problem hiding this comment.
Заменил везде "клик" на "нажатие"
| immediateAction: ActionType<T> | undefined; | ||
| /** | ||
| * Флаг, указывающий нужно ли автоматически закрывать ActionSheet |
There was a problem hiding this comment.
| * Флаг, указывающий нужно ли автоматически закрывать ActionSheet | |
| * Флаг, указывающий, нужно ли автоматически закрывать ActionSheet |
Или перефразировать?
| selectable?: boolean; | ||
| /** | ||
| * Отключает элемент |
There was a problem hiding this comment.
Тут непонятно назначение. Чуть выше для Accordion описывался как "Блокировка взаимодействия с компонентом". Возможно, следует выбрать какое-то одно описание и везде его придерживаться.
There was a problem hiding this comment.
Прошелся по свойствам, и так где есть свойство disabled поменял описание на "Блокировка взаимодействия с компонентом"
| @@ -1,4 +1,5 @@ | |||
| 'use client'; | |||
| /* eslint-disable jsdoc/require-jsdoc */ | |||
There was a problem hiding this comment.
А почему тут игнор? На самом деле здесь из jsdoc ниже нужно у свойств убрать все @ignore и заменить более-менее понятным описанием
There was a problem hiding this comment.
Убрал тут игноры и добавил описаний
…ove descriptions of props
Добавил правило, которое проверяет наличие точки в конце jsdoc и заглавную букву в начале jsdoc |
Описание
Сейчас у многих свойств компонентов нет описания. Из-за этого в доке у этих свойств тоже нет описания. Нужно добавить описания так, где это нужно.
Изменения
eslintплагин eslint-plugin-jsdoc и настроил его, так чтобы он ругался на отсутствие jsdoc у свойств в типах и интерфейсах в папкеsrc/components.Release notes