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.

Sign up for GitHub

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

Jump to bottom

tech: add plugin eslint-plugin-jsdoc to check jsdocs require #8387

Merged
merged 17 commits into from
Apr 1, 2025
Merged

tech: add plugin eslint-plugin-jsdoc to check jsdocs require #8387

merged 17 commits into from
Apr 1, 2025

Conversation

EldarMuhamethanov
Copy link
Contributor

Описание

Сейчас у многих свойств компонентов нет описания. Из-за этого в доке у этих свойств тоже нет описания. Нужно добавить описания так, где это нужно.

Изменения

  • Добавил eslint плагин eslint-plugin-jsdoc и настроил его, так чтобы он ругался на отсутствие jsdoc у свойств в типах и интерфейсах в папке src/components.
  • Прошелся по файлам, где были ошибки линтера и добавил где-надо описания. Также, в тех файлах, где это не нужно, добавил игнор правила

Release notes

@EldarMuhamethanov EldarMuhamethanov self-assigned this Mar 21, 2025
@EldarMuhamethanov EldarMuhamethanov requested a review from a team as a code owner March 21, 2025 08:52
@codesandbox-ci CodeSandbox CI
Copy link

codesandbox-ci bot commented Mar 21, 2025 •
edited
Loading

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.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Mar 21, 2025 •
edited
Loading

size-limit report 📦

Path Size
JS 405.54 KB (0%)
JS (gzip) 120.43 KB (0%)
JS (brotli) 98.96 KB (0%)
JS import Div (tree shaking) 1.56 KB (0%)
CSS 348.95 KB (0%)
CSS (gzip) 43.23 KB (0%)
CSS (brotli) 34.47 KB (0%)

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Mar 21, 2025 •
edited
Loading

e2e tests

⚠️ Some screenshots were failed. See Playwright Report.

Playwright Report

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Mar 21, 2025 •
edited
Loading

👀 Docs deployed

Commit d6fb4f0

andrey-medvedev-vk
andrey-medvedev-vk previously approved these changes Mar 21, 2025
View reviewed changes
Copy link
Contributor

@andrey-medvedev-vk andrey-medvedev-vk left a comment

Choose a reason for hiding this comment

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

💪

Не везде я уверен на счёт правок в словах, но оставил чтобы ещё над формулировкой подумать. Но это всё nit.

andrey-medvedev-vk
andrey-medvedev-vk previously approved these changes Mar 21, 2025
View reviewed changes
Copy link
Contributor

@andrey-medvedev-vk andrey-medvedev-vk left a comment

Choose a reason for hiding this comment

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

💅

SevereCloud
SevereCloud reviewed Mar 24, 2025
View reviewed changes
@BlackySoul
Copy link
Contributor

Мейби nit, но первое, что бросилось в глаза - часть описаний (которые уже были) с точкой на конце, а новые все без 🤔

@BlackySoul
Copy link
Contributor

А в рамках этого PRа поправишь старые формулировки?

@EldarMuhamethanov
Copy link
Contributor Author

Мейби nit, но первое, что бросилось в глаза - часть описаний (которые уже были) с точкой на конце, а новые все без 🤔

Добавил правило, которое проверяет наличие точки в конце jsdoc и заглавную букву в начале jsdoc

@BlackySoul
Copy link
Contributor

А в рамках этого PRа поправишь старые формулировки?

?

@EldarMuhamethanov
Copy link
Contributor Author

А в рамках этого PRа поправишь старые формулировки?

Кажется, что стоит это сделать в отдельном pr, так как в этом уже итак слишком много изменений

inomdzhon
inomdzhon reviewed Mar 28, 2025
View reviewed changes
Copy link
Contributor

@inomdzhon inomdzhon left a comment

Choose a reason for hiding this comment

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

Оставил комменты, на которых можно сразу нажать Apply suggestion

  1. Везде не стал отмечать, но с правилом на заглавные буквы есть следующие моменты, которые не учитывает:
  • латиница перел киррилицей (например, @derpracted текст, imageSize текст)
  • сокращения (например, т.к., см.)
  • ссылки (протокол http)
  • имена собственные (например, iOS)
  1. Выставление точки порой не корректно в списках
    image
    например

EldarMuhamethanov and others added 4 commits March 28, 2025 15:48
@EldarMuhamethanov
fix: fix comments
4acff6b
@EldarMuhamethanov @inomdzhon
Apply suggestions from code review
0b40b8f 
Co-authored-by: Inomdzhon Mirdzhamolov <i.mirdzhamolov@vk.team>
@EldarMuhamethanov @inomdzhon
Update packages/vkui/src/components/WriteBarIcon/WriteBarIcon.tsx
12262e5 
Co-authored-by: Inomdzhon Mirdzhamolov <i.mirdzhamolov@vk.team>
@EldarMuhamethanov
fix: improve rule
bbf22d1
@EldarMuhamethanov
Copy link
Contributor Author

Оставил комменты, на которых можно сразу нажать Apply suggestion

  1. Везде не стал отмечать, но с правилом на заглавные буквы есть следующие моменты, которые не учитывает:
  • латиница перел киррилицей (например, @derpracted текст, imageSize текст)
  • сокращения (например, т.к., см.)
  • ссылки (протокол http)
  • имена собственные (например, iOS)
  1. Выставление точки порой не корректно в списках

Нашел настройку благодаря которой можно добавить исключения - слова после которых не будет форсироваться заглавная буква

  • В этом кейса текст после названия параметра или после директивы(@depprecated) является отдельным описанием, поэтому там форсируется заглавная буква - в целом звучит логично
  • Сокращения добавил в исключения
  • по ссылка прошелся и добавил перед ними "см." - теперь норм
  • с именами собственными сложнее, пришлось переформулировать описание, чтобы было норм
  1. С этим к сожалению не придумал как бороться. Возможно стоит смириться, так как мест не так много

@EldarMuhamethanov
fix: fix formatting
dcfbeba
@EldarMuhamethanov
Merge branch 'master' into e.muhamethanov/add-prop-jsdoc-require
10bda4a 
# Conflicts:
#	packages/vkui/src/components/ModalRoot/useModalManager.tsx
#	packages/vkui/src/components/RootComponent/RootComponent.tsx
@EldarMuhamethanov
fix: fix jsdoc
3a1efbe
inomdzhon
inomdzhon previously approved these changes Apr 1, 2025
View reviewed changes
Copy link
Contributor

@inomdzhon inomdzhon left a comment

Choose a reason for hiding this comment

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

🥇 🙏

andrey-medvedev-vk
andrey-medvedev-vk reviewed Apr 1, 2025
View reviewed changes
Copy link
Contributor

@andrey-medvedev-vk andrey-medvedev-vk left a comment

Choose a reason for hiding this comment

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

Ещё чуть-чуть 👌 🙂

@EldarMuhamethanov @andrey-medvedev-vk
Apply suggestions from code review
d6fb4f0 
Co-authored-by: Andrey Medvedev <andrey.medvedev@vk.team>
andrey-medvedev-vk
andrey-medvedev-vk approved these changes Apr 1, 2025
View reviewed changes
Copy link
Contributor

@andrey-medvedev-vk andrey-medvedev-vk left a comment

Choose a reason for hiding this comment

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

💪 🔥 💅

@EldarMuhamethanov EldarMuhamethanov added this to the v7.3.0 milestone Apr 1, 2025
@EldarMuhamethanov EldarMuhamethanov merged commit c2de58f into master Apr 1, 2025
27 checks passed
@EldarMuhamethanov EldarMuhamethanov deleted the e.muhamethanov/add-prop-jsdoc-require branch April 1, 2025 15:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@inomdzhon inomdzhon inomdzhon approved these changes

@andrey-medvedev-vk andrey-medvedev-vk andrey-medvedev-vk approved these changes

@SevereCloud SevereCloud Awaiting requested review from SevereCloud

@BlackySoul BlackySoul Awaiting requested review from BlackySoul

Assignees

@EldarMuhamethanov EldarMuhamethanov

Labels
technical task
Projects
VKUI
Status: ✅ Done
Milestone
v7.3.0
Development

Successfully merging this pull request may close these issues.
5 participants
@EldarMuhamethanov @BlackySoul @inomdzhon @SevereCloud @andrey-medvedev-vk