@unicorncoder/ui-kit
v1.0.2
Published
---
Downloads
201
Readme
Documentação das Alterações Feitas e Planejamento
Resumo das Ações Feitas no Projeto
- Configuração Inicial do Rollup
- Configurado o
rollup.config.js
para suportar a construção do projeto. - Adicionados plugins essenciais:
@rollup/plugin-alias
: Para criar atalhos de importação.@rollup/plugin-node-resolve
e@rollup/plugin-commonjs
: Para resolver dependências de módulos.rollup-plugin-typescript
: Para compilar TypeScript.rollup-plugin-postcss
: Para processar arquivos CSS e LESS.rollup-plugin-dts
: Para gerar arquivos de declaração TypeScript.@svgr/rollup
: Para importar SVGs como componentes React.
- Configurado o
- Organização do Código
- Criado um diretório específico para cada componente, como
src/components/Button
, para isolar responsabilidades e melhorar a organização. - Adicionados aliases no Rollup para facilitar a importação de arquivos e pastas:
- Exemplo:
@components
aponta parasrc/components
.
- Exemplo:
- Criado um diretório específico para cada componente, como
- Configuração de Estilos
- Configurado o
rollup-plugin-postcss
para suportar arquivos.css
e.less
. - Habilitado o uso de LESS com a opção
javascriptEnabled: true
. - Configurado o plugin para gerar arquivos CSS separados.
- Configurado o
- Geração de Tipos TypeScript
- Adicionado o plugin
rollup-plugin-dts
para gerar arquivos.d.ts
no build final. - Configurado o Rollup para gerar os tipos no formato ESM.
- Adicionado o plugin
- Atualizações no
package.json
- Configurado os campos
main
emodule
para apontar para os arquivos gerados pelo Rollup:main
: Arquivo CommonJS.module
: Arquivo ES Module.
- Configurado os campos
- Ajustes no TypeScript
- Atualizado o
tsconfig.json
para incluir os novos diretórios e garantir que todos os arquivos sejam compilados corretamente.
- Atualizado o
- Testes e Verificações
- Planejado a configuração de testes para garantir a qualidade do código (ainda pendente).
- Verificado o funcionamento dos componentes após as mudanças.
To-Do List
Tarefas Concluídas
- [x] Mover o componente para uma pasta própria.
- [x] Atualizar o caminho de entrada no
rollup.config.js
. - [x] Ajustar o arquivo de estilos do componente.
- [x] Atualizar o arquivo de exportação principal (
src/index.ts
). - [x] Verificar e ajustar o
tsconfig.json
.
Tarefas Pendentes
- Configurar Testes
- Configurar uma ferramenta de testes (como Jest ou React Testing Library).
- Criar testes unitários para o componente
Button
. - Garantir cobertura de testes para os casos principais.
- Importar Componentes da Outra Biblioteca
- Identificar os componentes necessários na outra biblioteca.
- Importar e integrar esses componentes ao projeto atual.
- Testar o Componente
- Testar o componente manualmente para garantir que ele funcione como esperado.
- Verificar se os estilos estão sendo aplicados corretamente.
- Garantir que o componente seja responsivo e funcione em diferentes navegadores.
- Aplicar Acessibilidade
- Usar ferramentas como
@storybook/addon-a11y
ouaxe-core
para verificar a acessibilidade. - Garantir que o componente seja acessível para usuários com deficiência.
- Adicionar atributos ARIA e outras melhorias de acessibilidade, se necessário.
- Usar ferramentas como
Próximos Passos
- Priorizar as tarefas pendentes.
- Configurar o ambiente de testes e criar os primeiros testes unitários.
- Garantir que o componente esteja pronto para uso em produção com acessibilidade e testes completos.
- Aplicar práticas de acessibilidade (a11y) nos componentes.