create-vue-prime-starter
v0.1.4
Published
Gerador de aplicacoes Vue 3 + PrimeVue com scaffold oficial do Vue e uma base pronta para temas, layouts, HttpClient, stores e tratamento de erros.
Maintainers
Readme
create-vue-prime-starter
Gerador de aplicacoes Vue 3 + PrimeVue publicado no npm.
Ele parte do scaffold oficial do Vue (create-vue) e adiciona uma base pronta
para temas, layouts, HttpClient, stores Pinia e tratamento centralizado de
erros.
Visao Geral
O pacote cria um projeto novo em ./<nome-do-projeto> e executa este fluxo:
- cria a base com
create-vue; - sobrepoe o template do pacote;
- instala as dependencias mais recentes disponiveis.
Como Usar
1. Executar localmente no repositorio
A partir desta pasta do projeto:
# Modo interativo
node bin/index.mjs
# Informando o nome direto
node bin/index.mjs minha-app
# Sem prompts (CI / scripts)
node bin/index.mjs minha-app --install
node bin/index.mjs minha-app --no-install2. Usar o pacote publicado no npm
Depois de publicar, rode o gerador via npx:
npx create-vue-prime-starter minha-app3. Testar sem publicar
Para validar a versao local do pacote sem publicar:
cd packages/create-vue-prime-app
npm link
create-vue-prime-starter minha-appOpcoes
| Opcao | Descricao |
| -------------- | ------------------------------------- |
| <nome> | Nome/pasta do projeto a ser criado |
| --install | Roda a instalacao automaticamente |
| --no-install | Pula a instalacao de dependencias |
| -h, --help | Mostra a ajuda |
O Que e Gerado
- Vue 3 + Composition API + TypeScript (strict) + Vite
- PrimeVue 4 +
@primeuix/themescom 4 paletas, modo escuro e tamanho de fonte - Pinia (+ persisted state), Vue Router com guard de autenticacao
- Camada HTTP (
HttpClient, interceptors, services) + normalizacao de erros ErrorDialogglobal eThemeSwitcher- Tailwind CSS 4 +
tailwindcss-primeui
No modo interativo, a selecao de features representa recursos prontos do
template, como cliente HTTP, stores Pinia, seletor de paleta, tratamento global
de erros e fluxo de login protegido. Dependencias como axios, pinia e
vue-router sao resolvidas automaticamente pelo gerador conforme os recursos
necessarios.
As versoes das dependencias sao resolvidas no momento da criacao para pegar as
versoes mais recentes disponiveis. O template template/package.json define
quais pacotes sao instalados.
Estrutura do Gerador
packages/create-vue-prime-app/
bin/index.mjs # CLI (cria base com create-vue, aplica o template, substitui {{PROJECT_NAME}})
template/ # Aplicacao base que e sobreposta na base oficial do Vue
package.json # Metadados + binComo o template funciona
- Arquivos
_gitignoree_env.examplesao renomeados para.gitignoree.env.exampleao aplicar o template. - O token
{{PROJECT_NAME}}e substituido pelo nome informado em todos os arquivos de texto.
Para evoluir o template, basta editar os arquivos em template/. Se precisar
alterar a base oficial do Vue ou a limpeza de arquivos residuais, isso fica em
bin/index.mjs.
Publicacao no npm
O pacote comeca em 0.1.0 para marcar o reinicio da publicacao no npm.
Passo a passo
- Entre na conta do npm:
npm login- Quando for subir uma nova versao, aumente o numero do pacote:
npm version patch- Publique no npm:
npm publishPara lancamentos maiores, use npm version minor ou npm version major.
