Skip to content

docs(icons-gallery): align README with actual stack (Vite + Vitest)#561

Open
isaquebock wants to merge 2 commits into
mainfrom
docs/icons-gallery-readme
Open

docs(icons-gallery): align README with actual stack (Vite + Vitest)#561
isaquebock wants to merge 2 commits into
mainfrom
docs/icons-gallery-readme

Conversation

@isaquebock
Copy link
Copy Markdown
Collaborator

Summary

O apps/icons-gallery/README.md ainda descrevia o toolchain antigo (Vue CLI, Jest, src/icons.json, vue.config.js, public/index.html) — divergiu do estado real do projeto após a migração para Vite + Vitest e do consumo do catálogo via @aziontech/icons/catalog. Este PR realinha o doc.

Mudanças

  • Build: Vite (era "Vue CLI"). Referência a vite.config.js; removidas menções a vue.config.js.
  • Tests: Vitest + jsdom (era "Jest + Vue Test Utils"). Referência a vitest.config.js; removidos babel.config.js e jest.config.js da estrutura.
  • Origem dos ícones: @aziontech/icons/catalog (não há src/icons.json local). Seção "Adding New Icons" reescrita para apontar a fluxo correto via pnpm --filter @aziontech/icons build.
  • Estrutura do projeto: lista apenas arquivos que de fato existem (index.html na raiz, não em public/; sem babel.config.js).
  • Scripts: adicionado test:unit:watch; nota sobre publish rodar azion deploy --local --debug (não publica em npm).
  • Contagem de ícones: ajustada para o snapshot atual do catálogo (ai: 88, pi: 314).
  • Badges: adicionado Vite ao topo.

Test plan

  • Confirmado que todos os arquivos listados na "Project Structure" existem.
  • Scripts conferidos contra package.json.
  • Snippets de configuração refletem o conteúdo real de vite.config.js e vitest.config.js.
  • Contagens de ícones verificadas em packages/icons/dist/catalog.json.

The README still described the pre-migration toolchain (Vue CLI, Jest,
src/icons.json, vue.config.js, public/index.html). Updates it to match
the current project:

- Build: Vite (not Vue CLI); references vite.config.js, removes vue.config.js
- Tests: Vitest + jsdom (not Jest + Vue Test Utils); references
  vitest.config.js, removes babel/jest configs
- Icons source: @aziontech/icons/catalog (not src/icons.json); rewrites
  the 'Adding New Icons' section accordingly
- Project structure now lists files that actually exist (index.html
  at root, no public/index.html, no babel.config.js)
- Adds test:unit:watch and notes the publish script targets Azion, not npm
- Updates icon counts to current catalog snapshot (ai: 88, pi: 314)
@isaquebock isaquebock requested a review from a team as a code owner May 20, 2026 20:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant