ontwik ui

ONTWIK-UI

Uma biblioteca de interface do usuário sem cabeça e gerador de temas da CLI

Distribuído por:

• ? Turborepo-sistema de construção de alto desempenho para monorepos
• React - Biblioteca JavaScript para interfaces de usuário
• ? TSUP - Bundler datilografado alimentado por Esbuild
• Livro de histórias - ambiente de componente da interface do usuário alimentado por Vite

Bem como algumas outras ferramentas pré -configuradas:

• Datilografript para verificação de tipo estático
• Alterações para gerenciar versões e changelogs
• Ações do GitHub para publicação de pacotes totalmente automatizada

Começando

Documentos

Comandos úteis

• yarn dev - Execute todos os pacotes localmente e visualize com o Storybook
• yarn build - Construa todos os pacotes, incluindo o site do livro de histórias
• yarn lint - fiapos todos os pacotes
• yarn changeset - gerar uma mudança de alteração
• yarn clean - Limpe todos node_modules e pastas dist (executa o script limpo de cada pacote)

Aplicativos e pacotes

Este Monorepo inclui os seguintes pacotes e aplicativos:

• apps/docs : Site de documentação de componentes com livro de histórias
• apps/public-docs : Public Docums Powerd by Nextra
• packages/ontwik-ui : componentes do Core React

Cada pacote e aplicativo são 90% de digitação. Os espaços de trabalho do YARN nos permitem "içar" dependências compartilhadas entre os pacotes do root package.json . Isso significa pastas menores node_modules e uma melhor experiência de desenvolvimento local. Para instalar uma dependência para todo o Monorepo, use o sinalizador -W de espaços de trabalho com yarn add .

Pacotes de versão e publicação

Este repositório usa o Alterações para gerenciar versões, criar Changelogs e publicar no NPM. É pré -configurado para que você possa começar a publicar pacotes imediatos.

Gerando o changelog

Para gerar seu Changelog, execute yarn changeset localmente:

1. Quais pacotes você gostaria de incluir? - Isso mostra quais pacotes e mudou e quais permaneceram os mesmos. Por padrão, nenhum pacotes está incluído. Pressione space para selecionar os pacotes que você deseja incluir no changeset .
2. Quais pacotes devem ter um grande solavanco? - Pressione space para selecionar os pacotes para os quais você deseja aumentar as versões.
3. Se estiver fazendo a primeira versão principal, confirme que deseja lançar.
4. Escreva um resumo para as alterações.
5. Confirme que a troca parece esperada.
6. Um novo arquivo de marcação será criado na pasta changeset com o resumo e uma lista dos pacotes incluídos.

Liberação

Quando você empurra seu código para o Github, a ação do GitHub executará o script release definido no root package.json :

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

O Turborepo executa o script build para todos os pacotes publicáveis (excluindo documentos e documentos públicos) e publica os pacotes no NPM.