forlogic-core 2.0.8 → 2.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.css +1 -1
- package/dist/index.css.map +1 -1
- package/dist/index.d.ts +1 -0
- package/dist/index.esm.js +1 -1
- package/dist/index.js +1 -1
- package/dist/tailwind/index.esm.js +4 -0
- package/dist/tailwind/index.js +4 -0
- package/dist/utils/load-fonts.d.ts +1 -0
- package/docs/WORKSPACE_KNOWLEDGE.md +119 -254
- package/docs/design-system/README.md +1 -1
- package/package.json +1 -1
- package/docs/ICON_MIGRATION_GUIDE.md +0 -177
- package/docs/PUBLISH.md +0 -168
package/docs/PUBLISH.md
DELETED
|
@@ -1,168 +0,0 @@
|
|
|
1
|
-
# 📦 Como Publicar a Biblioteca forlogic-core
|
|
2
|
-
|
|
3
|
-
> **Nota:** Para documentação de uso e instalação da biblioteca, consulte [README.md](../README.md)
|
|
4
|
-
|
|
5
|
-
## Configuração Inicial
|
|
6
|
-
|
|
7
|
-
A biblioteca está configurada para ser publicada no NPM como `forlogic-core`.
|
|
8
|
-
|
|
9
|
-
### Arquivos de Configuração
|
|
10
|
-
|
|
11
|
-
- `package.json` - Configuração principal com campos de biblioteca
|
|
12
|
-
- `rollup.config.js` - Configuração de build
|
|
13
|
-
- `tsconfig.json` - Configuração TypeScript unificada
|
|
14
|
-
- `.npmignore` - Arquivos excluídos da publicação (inclui `docs/` - não publicada no NPM)
|
|
15
|
-
- `README.md` - Documentação principal (copiada para dist/)
|
|
16
|
-
|
|
17
|
-
## Comandos Disponíveis
|
|
18
|
-
|
|
19
|
-
### 1. Build da Biblioteca
|
|
20
|
-
|
|
21
|
-
```bash
|
|
22
|
-
npm run build:lib
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
### 2. Teste de Publicação (Dry Run)
|
|
26
|
-
|
|
27
|
-
```bash
|
|
28
|
-
npm publish --dry-run
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
### 3. Release Automatizado (Recomendado)
|
|
32
|
-
|
|
33
|
-
**Script JavaScript**
|
|
34
|
-
|
|
35
|
-
```bash
|
|
36
|
-
# Release patch (1.0.0 → 1.0.1)
|
|
37
|
-
node scripts/publish.js patch
|
|
38
|
-
|
|
39
|
-
# Release minor (1.0.0 → 1.1.0)
|
|
40
|
-
node scripts/publish.js minor
|
|
41
|
-
|
|
42
|
-
# Release major (1.0.0 → 2.0.0)
|
|
43
|
-
node scripts/publish.js major
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
### 4. Publicação Manual (Legado)
|
|
47
|
-
|
|
48
|
-
```bash
|
|
49
|
-
# Incrementar versão e publicar manualmente
|
|
50
|
-
npm version patch # 1.0.0 → 1.0.1
|
|
51
|
-
npm version minor # 1.0.0 → 1.1.0
|
|
52
|
-
npm version major # 1.0.0 → 2.0.0
|
|
53
|
-
|
|
54
|
-
# Publicar versão atual
|
|
55
|
-
npm publish
|
|
56
|
-
```
|
|
57
|
-
|
|
58
|
-
## Processo de Release Automatizado
|
|
59
|
-
|
|
60
|
-
### Scripts Automatizados
|
|
61
|
-
|
|
62
|
-
Os scripts `scripts/publish/release.js` e `scripts/publish/release.sh` executam automaticamente:
|
|
63
|
-
|
|
64
|
-
1. **Verificação**: Confere se não há mudanças pendentes no Git
|
|
65
|
-
2. **Build**: Executa `npm run build:lib` com Rollup
|
|
66
|
-
3. **Versão**: Incrementa versão no `package.json`
|
|
67
|
-
4. **Publicação**: Publica no NPM
|
|
68
|
-
5. **Tags**: Envia tags para o GitHub
|
|
69
|
-
|
|
70
|
-
### Processo Manual (Legado)
|
|
71
|
-
|
|
72
|
-
1. **Build**: Executa `npm run build:lib` com Rollup
|
|
73
|
-
2. **Geração**: Cria arquivos CJS, ESM e declarações TypeScript
|
|
74
|
-
3. **Publicação**: Usa `npm publish` diretamente
|
|
75
|
-
|
|
76
|
-
## Estrutura da Publicação
|
|
77
|
-
|
|
78
|
-
```
|
|
79
|
-
dist/
|
|
80
|
-
├── index.js # CommonJS
|
|
81
|
-
├── index.esm.js # ES Modules
|
|
82
|
-
├── index.d.ts # TypeScript declarations
|
|
83
|
-
├── index.css # CSS da biblioteca
|
|
84
|
-
├── package.json # Configuração da lib
|
|
85
|
-
└── README.md # Documentação
|
|
86
|
-
```
|
|
87
|
-
|
|
88
|
-
## Documentação para Usuários
|
|
89
|
-
|
|
90
|
-
A documentação completa está **consolidada no README.md** e disponível publicamente no repositório GitHub:
|
|
91
|
-
|
|
92
|
-
- **[📖 README.md](../README.md)** - Guia completo (~350 linhas)
|
|
93
|
-
- ✅ Regras críticas e checklist
|
|
94
|
-
- ✅ Quick start CRUD
|
|
95
|
-
- ✅ Migrations e RLS
|
|
96
|
-
- ✅ Troubleshooting
|
|
97
|
-
- ✅ Referência rápida
|
|
98
|
-
|
|
99
|
-
### ⚙️ Documentação no Pacote NPM
|
|
100
|
-
|
|
101
|
-
O `README.md` é incluído no pacote NPM publicado (`dist/README.md`) e contém toda a documentação necessária em um único arquivo otimizado para leitura por IA e desenvolvedores.
|
|
102
|
-
|
|
103
|
-
#### Documentações Modulares
|
|
104
|
-
|
|
105
|
-
Algumas features possuem documentação detalhada em arquivos específicos para desenvolvimento local:
|
|
106
|
-
|
|
107
|
-
- `lib/crud/components/CUSTOM_FIELDS.md` - Campos customizados do BaseForm
|
|
108
|
-
- `lib/qualiex/places/README.md` - Sistema de gestores de locais
|
|
109
|
-
|
|
110
|
-
**Importante:** Essas documentações **não são publicadas no NPM**. O conteúdo consolidado está no `README.md` principal que é copiado para `dist/README.md`.
|
|
111
|
-
|
|
112
|
-
## Verificação antes da Publicação
|
|
113
|
-
|
|
114
|
-
1. ✅ Build bem-sucedido (`npm run build:lib`)
|
|
115
|
-
2. ✅ Dry-run sem erros (`npm publish --dry-run`)
|
|
116
|
-
3. ✅ Versão correta no `package.json`
|
|
117
|
-
4. ✅ README atualizado
|
|
118
|
-
5. ✅ Changelog documentado (se aplicável)
|
|
119
|
-
|
|
120
|
-
## Troubleshooting
|
|
121
|
-
|
|
122
|
-
### Erro de Permissão NPM
|
|
123
|
-
|
|
124
|
-
```bash
|
|
125
|
-
npm login
|
|
126
|
-
```
|
|
127
|
-
|
|
128
|
-
### Build Falha
|
|
129
|
-
|
|
130
|
-
Verifique se todas as dependências estão instaladas:
|
|
131
|
-
|
|
132
|
-
```bash
|
|
133
|
-
npm install
|
|
134
|
-
```
|
|
135
|
-
|
|
136
|
-
### Rollup Errors
|
|
137
|
-
|
|
138
|
-
Confirme que o `rollup.config.js` está correto e que o `lib/index.ts` existe e exporta tudo necessário.
|
|
139
|
-
|
|
140
|
-
### CSS Import Issues
|
|
141
|
-
|
|
142
|
-
Se houver erro ao importar CSS, use:
|
|
143
|
-
|
|
144
|
-
```tsx
|
|
145
|
-
import 'forlogic-core/index.css';
|
|
146
|
-
```
|
|
147
|
-
|
|
148
|
-
O CSS é extraído para `index.css` durante o build da biblioteca.
|
|
149
|
-
|
|
150
|
-
# Comandos Disponíveis
|
|
151
|
-
|
|
152
|
-
## Instalar a última versão do forlogic-core
|
|
153
|
-
|
|
154
|
-
```bash
|
|
155
|
-
npm i forlogic-core@latest
|
|
156
|
-
```
|
|
157
|
-
|
|
158
|
-
## Build do projeto
|
|
159
|
-
|
|
160
|
-
```bash
|
|
161
|
-
npm run build
|
|
162
|
-
```
|
|
163
|
-
|
|
164
|
-
## Limpar cache do NPM
|
|
165
|
-
|
|
166
|
-
```bash
|
|
167
|
-
npm cache clean --force
|
|
168
|
-
```
|