Какие хорошие компоненты, если никто не может понять, как их найти и использовать их?
Реагистрация побуждает вас создавать модульные приложения с компонентами. Модульность приносит всевозможные преимущества, включая улучшенную повторное использование. Но, когда вы стремитесь поделиться и повторно использовать компонент, вам лучше удостовериться, что это легко открыть, понимать и использовать и использовать. Вам нужно документировать компоненты.
Сегодня современные инструменты могут помочь автоматизировать некоторые рабочие процессы документации и превратить потребление компонентной документации в богатый, визуальный и даже интерактивный опыт. Некоторые инструменты даже объединяют такие документы в качестве неотъемлемой части самого рабочего процесса составляющих компонентов.
Для достижения красивой компонентной документации, не работая слишком усердно, я собрал некоторые из лучших и самых популярных инструментов для документирования компонентов реагирования. Не стесняйтесь комментировать и добавлять свои собственные идеи и инструменты.
1. Немного
Платформа для общих компонентов.
Bit.dev – Поиск и выберите компоненты по размеру пакета, зависимости, этикетки и превью снимков
Бит Больше, чем просто инструмент документации для компонентов. Это инструмент с открытым исходным кодом, который позволяет инкапсулировать компоненты со всеми своими файлами и зависимостями, и запустить их в разных приложениях вне коробки.
Bit.Dev Платформа позволяет совместно использовать и сотрудничать на компонентах в ваших приложениях. Все ваши общие компоненты обнаруживаются для вашей команды, чтобы найти и использовать в своих проектах и легко поделиться своими собственными компонентами.
Компоненты, которые вы делитесь на Bit.Dev Обнаружено в вашей команде общего компонента Hub. Вы можете искать компоненты по контексту, размер пучка или даже зависимости. Вы можете быстро просмотреть результаты, основанные на визуальных снимках фактически визуализированных компонентов и выбирают глазами.
→ Исследуйте компоненты на Bit.dev
Когда вы переходите в одну из веб-страниц вашей компоненты, вы обнаружите, что бит представляет компонент на живой игровой площадке, чтобы вы могли играть с ним, прежде чем выбрать его в своем приложении. Если у вас есть JSDOCS или файл .md в рамках кода, бит будет анализировать и представить эти документы. Если компоненты включают в себя файлы тестирования единиц, бит будет запускать их в изоляцию и представить результаты как часть документации для каждого компонента.
Когда нашел компонент, который вы любите использовать, просто используйте NPM или пряжу, чтобы установить его. Вы даже можете использовать бит для разработки и обновления компонентов непосредственно из любого потребляющего приложения, поэтому ваша команда может сотрудничать и строить вместе.
При совместном использовании компонентов вам не нужно настроить более репозитории или инструменты, не нужно ревертировать или изменить свой код, и тот же центр, где вы обмениваетесь компонентами, где они становятся документированными и обнаруженными, в значительной степени из коробки Отказ
2. Статьгор и стильгидист
Статья книги и стильгидиста являются слишком прекрасными проектами, которые помогают разрабатывать компоненты в изоляции во время визуально рендеринга и документирования их.
Статья книги
Статьгор * * Это среда разработки для компонентов пользовательских интерфейсов. Это позволяет просматривать библиотеку компонентов, просматривать различные состояния каждого компонента и интерактивно разработать и тестировать компоненты. При создании библиотеки, StoreBook – это аккуратный способ визуализации и компонентов документов, а разные дополнения облегчают интеграцию в ваши различные инструменты и рабочие процессы. Вы можете даже повторно использовать истории в модуль-тестах для подтверждения нюансированной функциональности.
Стильгидист
Стильгидист Это среда разработки продуктов реагирования с помощью гида живого стиля. Он обеспечивает горячую перезагрузку DEV Server и руководство по живуру, в котором перечислены компонентные пропиты и показывают редактируемые примеры использования на основе файлов .md. Он поддерживает ES6, Flow и Teadncript и работает с созданием приложения React из коробки. Автоматически сгенерированные документы для использования могут помочь функции STYLEGUIDIST в качестве портала документации для различных компонентов вашей команды.
- Также проверьте Ui zoo по Ном Эльбом Отказ
3. CodeSandbox, Stackblitz & Friends
Компонентные игровые площадки аккуратный способ играть с компонентами и узнать, как они работают. Когда вы можете объединить их как часть вашей документации (или в рамках вашего рабочего процесса для всех общих компонентов ), игровые площадки помогают вам быстро узнать, как работает код и решить, хотите ли вы использовать компонент.
CodeSandbox.
CodeSandbox Это онлайн-редактор для быстрого создания и воспроизведения – с небольшими проектами, такими как компоненты. После создания чего-то интересного вы можете показать это другим, просто разделяя URL. CodeSandbox содержит просмотр в прямом эфире, чтобы показать результат кода, когда вы печатаете, и у вас есть расширения, созданные для интеграции в ваши разные инструменты и ваш рабочий процесс разработки.
Stackblitz является «онлайн-IDE для веб-приложений», работающих на Visual Studio Code. Многое, как CodeSnadbox, Stackblitz – это онлайн IDE, где вы можете создавать угловые и реагировать проекты, которые сделаны совместно с помощью ссылки URL. Как код кодовой бумаги, это автоматически заботится установки зависимостей, компиляции, объединения и горячей перегрузки по мере их типа. Посмотри.
→ Найти больше Компонентные игровые площадки для реагирования : 11 React UI Компонентные игровые площадки на 2019 год * Полезные онлайн-игровые площадки и редакторы для ваших компонентов UI * Blog.bitsrc.io
- Также см.: React-Cosmos | реагировать
4. Докс
Докс
Докз Упрощает создание веб-сайтов документации GTABSY-Document для вашего кода. Он основан на MDX (* Markdown + JSX) *, чтобы использовать MECKONDOND для компонентной документации. По сути, вы можете написать файл .mdx в любом месте вашего проекта, и docz будет оптимизировать процесс превращения его в портал документации вашего собственного дизайна, развернутого для NetLify. Полезно верно? Pedronauck/DOCZ * ✍🏻✍🏻 Это никогда не было так легко документировать ваши вещи! – Pedronauck/docz * github.com
5. MDX-DOCS.
MDX-DOCS.
MDX-Docs Позволяет документировать и разработать компоненты React с MDX и Next.js. Вы можете смешать Markdown с Inline JSX для рендеринга в реагированных компонентах. Указание записи, поскольку вы обычно будете использовать синтаксис импорта ES для использования пользовательских компонентов в вашем документе. Встроенные компоненты Render Render Beged Code Code Blocks как Previews с редактируемым кодом, питается от реагировать Отказ
6. Rect docgen.
React Docgen Является ли CLI и Toolbox для извлечения информации из файлов React Component для целей генерации документации. Использует AST-типы и @ Babel/Parser Чтобы разбирать источник в AST и предоставляет способы обработки этой АСТ для извлечения желаемой информации. Выходное значение/возвращаемое значение – это объект JSON BLOB/JavaScript. Он обеспечивает реализацию по умолчанию для компонентов реагирования, определенные через RACT.CREATECLASS, Определения классов ES2015 или функции (компоненты без гражданства). Функциональный и мощный. rectjs/raction-docgen * CLI и Toolbox для извлечения информации из файлов ACV-компонента для целей генерации документации… * * github.com
Оригинал: “https://dev.to/giteden/6-tools-for-documenting-your-react-components-like-a-pro-1gml”