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

fix(docs:styleguidist): Некостыльный @deprecated и другие фиксы для стайлгайда #4701

Merged
merged 3 commits into from
Apr 4, 2023

Conversation

eugpoloz
Copy link
Contributor

@eugpoloz eugpoloz commented Apr 4, 2023

Спасибо @SevereCloud за комментарий, я сходила потыкать эту штуку палкой и поняла, в чем был подвох с парсингом @deprecated!

  • вернула в dev-версию дефолтный propsParser, чтобы он подхватывал @deprecated (на проде все и так было почти хорошо),
  • прокинула описание, которое идет вместе с @deprecated, и обернула его в красивый блок, чтобы не нужно было писать в README.md эту информацию по второму кругу,
  • удалила костыль с deprecated.js 🎉

tl:dr; при депрекейте компонента достаточно добавить jsdoc-комментарий, ничего ни в какие конфиги больше добавлять не надо, ручками добавлять в Readme.md компонента описание а-ля "компонент устарел" тоже.

Пример:

/**
 * @see https://vkcom.github.io/VKUI/#/FormLayout
 * @deprecated v5.4.0
 *
 * Компонент устарел и будет удален в v6. Используйте
 * `<Form />` https://vkcom.github.io/VKUI/#/Form
 */
export const FormLayout = ({
Как оно зарендеритсяimage

А также:

  • поправила команду для рендера пропсов в dev-режиме в подсказке (была yarn styleguide:props), поигралась там с уровнем и текстом, чтобы prettier не добавлял {" "} и не переносил <code/> на новую строку
  • поправила иконки для рендера свойств и методов на view и hide: предыдущие были выбраны мной же методом ненаучного тыка и давно меня бесили

@eugpoloz eugpoloz added docs patch Автоматизация: PR продублируется в ветку последнего минорного релиза для выпуска патча labels Apr 4, 2023
@eugpoloz eugpoloz requested a review from a team as a code owner April 4, 2023 00:02
@eugpoloz eugpoloz self-assigned this Apr 4, 2023
@codesandbox-ci
Copy link

codesandbox-ci bot commented Apr 4, 2023

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.

Latest deployment of this branch, based on commit 72ff830:

Sandbox Source
VKUI TypeScript Configuration

@codecov
Copy link

codecov bot commented Apr 4, 2023

Codecov Report

Patch coverage has no change and project coverage change: -0.03 ⚠️

Comparison is base (c66c6cc) 78.02% compared to head (c29b635) 77.99%.

❗ Current head c29b635 differs from pull request most recent head 72ff830. Consider uploading reports for the commit 72ff830 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #4701      +/-   ##
==========================================
- Coverage   78.02%   77.99%   -0.03%     
==========================================
  Files         275      275              
  Lines        8442     8449       +7     
  Branches     2926     2929       +3     
==========================================
+ Hits         6587     6590       +3     
- Misses       1855     1859       +4     
Flag Coverage Δ
a11ytests ?
unittests 77.99% <ø> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 16 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@github-actions
Copy link
Contributor

github-actions bot commented Apr 4, 2023

👀 Styleguide deployed

See the styleguide for this PR at https://vkcom.github.io/VKUI/pull/4701/

SevereCloud
SevereCloud previously approved these changes Apr 4, 2023
styleguide/Components/Table/TableRenderer.js Outdated Show resolved Hide resolved
@eugpoloz eugpoloz force-pushed the eugpoloz/styleguidist-deprecated branch from c29b635 to 72ff830 Compare April 4, 2023 08:14
@eugpoloz eugpoloz merged commit c4d8ff1 into master Apr 4, 2023
@eugpoloz eugpoloz deleted the eugpoloz/styleguidist-deprecated branch April 4, 2023 08:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs patch Автоматизация: PR продублируется в ветку последнего минорного релиза для выпуска патча
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants