An Vscode extension to visualize the database schema in ERD from dbml or prisma file in your vscode.
- Create entity relations diagrams from your DBML/Prisma code
- Available in light and dark modes
Follow this article: https://juste.bocovo.me/preview-dbml-code-from-vscode
If you want to contribute to this project please read the contribution note
Si quieres empaquetar las extensiones y probarlas localmente en tu VS Code (instalando los VSIX), este repositorio incluye un script útil:
- Script:
scripts/package-and-install.sh
Requisitos previos
- Tener
yarnonpminstalado globalmente. Este repo puede usarse con Yarn (recomendado aquí) o con npm — no mezcles ambos gestores. - Tener disponible la CLI de VS Code
codeen el PATH para poder instalar los.vsixautomáticamente.
Uso recomendado (usar Yarn — coherente con este repositorio):
- Instalar dependencias con Yarn (genera
yarn.locksi falta):
yarn install- Ejecutar el script para empaquetar e instalar ambas extensiones (prisma + dbml):
bash ./scripts/package-and-install.sh allEl script también acepta prisma o dbml como argumento para empaquetar/instalar sólo uno de los paquetes.
Notas y consideraciones
-
vscedetecta la presencia de.yarnrcy preferiráyarnsi existe; por eso es importante usar un único gestor de paquetes en el repositorio. -
Durante el empaquetado
vscepuede preguntar por confirmaciones (por ejemplo licencia o activación). El script está pensado para automatizar el flujo (responde afirmativamente en el entorno donde lo ejecutamos). -
Si prefieres usar npm en lugar de Yarn:
- Elimina/renombra
.yarnrcyyarn.lockdel repo y ejecutanpm ci. - Actualiza los scripts que llamen explícitamente a
yarn run ...si es necesario.
- Elimina/renombra
-
Si ves advertencias sobre
can i use/browserslisto chunks grandes, son advertencias del build y no impiden la creación del.vsix.
Solución de problemas rápida
- Si
vscefalla indicando problemas con dependencias tiponpm listoyarn list, normalizanode_modulescon el gestor elegido (npm cioyarn install) y vuelve a ejecutar el script. - Si el empaquetado se queja por falta de
LICENSE,vscepreguntará; puedes añadir unLICENSEoLICENSE.mden el paquete correspondiente para evitar la confirmación interactiva.
Si quieres, puedo añadir un pequeño README dentro de scripts/ con estos pasos y/o crear automáticamente un LICENSE en packages/dbml-vs-code-extension para evitar el prompt — dime si lo haces y lo añado.
