ontwik ui

Ontwik-Ui

Безголовный библиотека пользовательского интерфейса и генератор темы CLI

Питаться от:

• ? Turborepo-высокопроизводительная система сборки для Monorepos
• React - библиотека JavaScript для пользовательских интерфейсов
• ? TSUP - TypeScript Bundler Powered By Esbuild
• Сборник рассказов - компонента пользовательского интерфейса

А также несколько других инструментов предварительно настроены:

• TypeScript для проверки статического типа
• Изменения в управлении версиями и изменением изменений
• Действия GitHub для полностью автоматизированной публикации пакетов

Начиная

Док

Полезные команды

• yarn dev - запустите все пакеты локально и предварительный просмотр с помощью сборника рассказов
• yarn build - построить все пакеты, включая сайт сборника рассказов
• yarn lint - пролив все пакеты
• yarn changeset - генерировать набор изменений
• yarn clean - очистите все node_modules и dist Polds (запускает чистый скрипт каждого пакета)

Приложения и пакеты

Этот монорепо включает в себя следующие пакеты и приложения:

• apps/docs : сайт документации компонента с сборницей рассказов
• apps/public-docs : общественные документы, основанные на Nextra
• packages/ontwik-ui : Core React Components

Каждый пакет и приложение составляет 90% TypeScript. Рабочие пространства пряжи позволяет нам «поднимать» зависимости, которые разделяются между пакетами до корневого package.json . Это означает, что меньшие папки node_modules и лучший локальный опыт разработчиков. Чтобы установить зависимость для всего MonorePo, используйте флаг рабочих пространств -W с помощью yarn add .

Пакеты версий и публикации

Этот репозиторий использует изменения для управления версиями, созданием изменений и публикации в NPM. Это предварительно настроено, так что вы можете начать публиковать пакеты сразу.

Генерируя изменение

Чтобы сгенерировать валютно, запустите yarn changeset локально:

1. Какие пакеты вы хотели бы включить? - Это показывает, какие пакеты и измененные, а какие остались прежними. По умолчанию пакеты не включены. Нажмите space , чтобы выбрать пакеты, которые вы хотите включить в changeset .
2. Какие пакеты должны иметь серьезный удар? - Нажмите space , чтобы выбрать пакеты, для которых вы хотите установить версии.
3. Если вы делаете первую крупную версию, подтвердите, что вы хотите выпустить.
4. Напишите резюме для изменений.
5. Подтвердите, что набор изменений выглядит так, как и ожидалось.
6. Новый файл Markdown будет создан в папке changeset с резюме и списком включенных пакетов.

Выпуск

Когда вы подталкиваете свой код на GitHub, действие GitHub запустит сценарий release , определенный в root package.json :

turbo run build --filter=docs^... --filter=public-docs^... && changeset publish

Turborepo запускает сценарий build для всех опубликованных пакетов (за исключением Docs & Public-Docs) и публикует пакеты в NPM.