docs(core): README atualizado com estrutura real + gitignore + env.example

This commit is contained in:
pulse-agent
2026-05-19 21:47:32 -03:00
parent bbdb68a6de
commit 154e233d6d
3 changed files with 137 additions and 45 deletions
+14
View File
@@ -0,0 +1,14 @@
# @pulse-libs/core — ambiente de desenvolvimento
# Copiar como .env e preencher os valores
# NPM Registry (para publish)
NPM_TOKEN= # token de publish no registry.npmjs.org
# CI/CD
NODE_ENV=production
SKIP_ZOD=true # skip validador snapshot em CI se necessário
# GitHub Actions (auto-preenchido pelo runner)
GITHUB_TOKEN=
GITHUB_REPOSITORY=
NODE_VERSION=20
+35
View File
@@ -0,0 +1,35 @@
# @pulse-libs/core — gitignore
node_modules/
dist/
coverage/
.tsup/**/*.tmp*
# Testes
.vitest/
coverage/
# Env
.env
.env.*
!.env.example
# OS
.DS_Store
Thumbs.db
# Editor
.idea/
.vscode/
*.swp
*.swo
# Logs
*.log
npm-debug.log*
# Git
.git/
!.gitignore
# CI/temp
.github/
+88 -45
View File
@@ -1,68 +1,111 @@
# @pulse-libs/core # @pulse-libs/core — Biblioteca Universal Atomizada
> Biblioteca universal componentizada — React · Vue · Hooks · Utils · Validators > **React · Hooks · Utils · Validators** em um único pacote
> Um único pacote. Todos os projetos. > `npm install @pulse-libs/core`
--- ---
## 📐 Estrutura atômica ## 📐 Estrutura real do projeto
``` ```
@pulse-libs/core @pulse-libs/core
├── types/ Tipos TypeScript compartilhados (zero deps) ├── src/
├── utils/ Funções puras — date, str, num, classnames, debounce, throttle │ ├── types/ → Result / AsyncState / Paginated / SortConfig (zero deps)
├── validators/ Schemas Zod reutilizáveis (email, password, uuid, phone) │ ├── utils/ → date, str, num, cn, debounce, throttle, storage, arr, obj (zero deps)
├── hooks/ React hooks — useToggle, useAsync, useDebounce, useLocalStorage │ ├── validators/ → Zod schemas: email, password, uuid, url, phone, CPF/CNPJ
├── components/ Componentes atômicos React — Button, Input, Alert, Card, Spinner │ ├── hooks/ → useToggle, useAsync, useDebounce, useLocalStorage, useMedia, useInterval, useOnClickOutside, useClipboard, useFetch
├── composable-vue/ Composables Vue 3 ├── components/ → Button, Input, Alert, Card (+Header/Title/Body), Spinner (React)
├── composables/ Composables genéricos (agnósticos de framework) │ └── index.ts → barrel export principal
├── lib/ Helpers third-party (sem duplicar lógica) ├── tests/ → vitest + jsdom — 57 testes, 100% passando
── constants/ Constantes comuns (status codes, mensagens, etc) ── dist/ → ESM + CJS + DTS + sourcemaps (gerado por tsup v8)
├── Dockerfile → multi-stage Node 20 Alpine
├── __docs__/ → guias de deploy, docker, arquitetura
└── package.json → sub-exports por camada
``` ```
## 🚀 Instalação ## 📦 Imports por camada
```bash
npm install @pulse-libs/core zod react vue
```
```tsx ```tsx
// React — utilitários + componentes // ── Root barrel
import { Button, Input, useAsync, date, cn } from '@pulse-libs/core'; import { Button, useAsync, date, cn } from '@pulse-libs/core';
// Validadores // ── Sub-exports (tree-shakeable)
import { emailSchema, passwordSchema, safeParse } from '@pulse-libs/core/validators'; import { Button, Input, Alert } from '@pulse-libs/core/components';
import { useToggle, useDebounce } from '@pulse-libs/core/hooks';
// Vue — composables import { cn, date, str, num, storage } from '@pulse-libs/core/utils';
import { useToggle, useLocalStorage } from '@pulse-libs/core/vue'; import { emailSchema, safeParse } from '@pulse-libs/core/validators';
``` import type { Result, AsyncState } from '@pulse-libs/core/types';
## 📦 Sub-exports
```ts
import { Button } from '@pulse-libs/core/react';
import { useFetch } from '@pulse-libs/core/hooks';
import { cn, date } from '@pulse-libs/core/utils';
``` ```
## 🏗️ Filosofia atômica ## 🏗️ Filosofia atômica
| Camada | Exemplo | Depende de | Uma camada **nunca importa de uma camada de nível inferior**:
|--------|---------|------------|
| **Utils** | `cn()`, `debounce()`, `date.format()` | zero |
| **Types** | `Result<T>`, `AsyncState<T>` | zero |
| **Validators** | `emailSchema`, `uuidSchema` | utils, types, zod |
| **Hooks** | `useAsync()`, `useDebounce()` | utils, types, react |
| **Components** | `Button`, `Input`, `Alert` | utils, validators |
> **Regra de ouro**: uma camada nunca importa de uma camada de nível inferior. ```
> Utils não sabe que Hooks existem. Hooks não sabe que Components existem. utils ← zero deps
types ← zero deps
validators ← usa utils, types, zod
hooks ← usa utils, types, react
components ← usa utils, validators
```
### Convenções de código
| Regra | Por quê |
|-------|---------|
| `className` sempre no topo dos props | Tailwind merge via `cn()` |
| `...rest` sempre por último | Não mata props nativas |
| Funções puras em `utils/` | Testáveis sem setup |
| Schema Zod é a **única** fonte de verdade | Sem validação duplicada |
| DTS arquivos declarados (`--dts`) | Imports no TS dos consumidores |
| `flat(2)` nunca `flat(Infinity)` | Quebra DTS generate |
## 🔄 Versionamento ## 🔄 Versionamento
- `1.0.0-beta.x` — desenvolvimento, API pode mudar | Fase | Tag | Significado |
- `1.0.0` — primeiro release estável, API congelada |------|-----|-------------|
| alpha | `1.0.0-alpha.x` | API instável |
| beta | `1.0.0-beta.x` | feature-complete, API pode mudar |
| stable | `1.0.0` | API congelada, sem breaking em minor |
## 🚀 Comandos
```bash
npm run build # tsup ESM+CJS+DTS+sourcemaps
npm run build:esm # ESM only
npm run build:cjs # CJS only
npm test # vitest run (57 testes)
npm test:w # vitest watch mode
npm run coverage # relatorio de cobertura
npm run typecheck # tsc --noEmit
npm run lint # eslint (se configurado)
npm run dev # tsup --watch
npm run clean # rm -rf dist coverage .tsup
npm run release # bumpp + git push --follow-tags
```
## 🐳 Docker
```bash
# Build image
docker build -t pulse-libs/core:1.0.0-beta.1 .
# Ou com docker-compose
docker compose build
# Test local
docker compose run core npm test
```
## 📚 Documentação adicional
- [`__docs__/docker/build-guide.md`](__docs__/docker/build-guide.md) — Guia de build e publish Docker
- [`__docs__/docker/architecture.md`](__docs__/docker/architecture.md) — Arquitetura da biblioteca
## 🤝 Contribuir ## 🤝 Contribuir
Ver [CONTRIBUTING.md](CONTRIBUTING.md). - Issues com tag `[bug]`, `[feat]`, `[docs]`
- PRs devem Rodar `npm test` + `npm run typecheck` antes
- Cada camada nova precisa de pelo menos 1 teste unitário
- Breaking changes só em major version (`2.0.0`, `3.0.0`, …)
- Sem duplicação de lógica — extrair para utils antes de adicionar