j38-lib

Librería compartida de utilidades JavaScript para los proyectos web del Ayuntamiento de Vitoria-Gasteiz.

Diseñada como un conjunto modular reutilizable, con soporte para ES Modules, Rollup, despliegue por entornos y versionado automático desde package.json.

🚀 Instalación

Desde npm (cuando esté publicada):

npm install @txukyt/j38-lib

Desde GitHub directamente:

npm install github:txukyt/j38-lib

🧩 Uso

En un entorno JavaScript moderno (ESM):

import { hello, showVersion } from '@txukyt/j38-lib';

hello('Ane'); // Hola, Ane
showVersion(); // Inicializando la libreria j38-lib de J38 con la versión: ${version}

En entorno HTML/WordPress:

<script src="/http/comun/mjs/j38-lib.iife.js"></script>
<script>
  VGLib.hello('Igor');
  VGLib.showVersion();
</script>

🛠️ Desarrollo

Clona el repositorio:

git clone https://github.com/txukyt/j38-lib.git
cd j38-lib
npm install

Construir la librería:

npm run build

Genera:

• dist/j38-lib.iife.js → para navegadores
• dist/dev/dev.js → para navegadores
• dist/esm/index.js → para uso con import

⚙️ Despliegue automático por entorno

Usamos archivos .env para definir rutas por entorno:

# .env.dev
DEPLOY_PATH=D:/DEV-WAS8/website/serverX/http/comun/libs/vg

Ejecutar despliegue:

npm run deploy:dev
npm run deploy:desa
npm run deploy:pre
npm run deploy:prod

Esto:

• Compila la librería
• Copia los bundles a la ruta indicada en .env.[entorno]

📁 Estructura del proyecto

j38-lib/
├── dist/                 # Archivos generados por Rollup
├── src/                  # Código fuente
│   ├── components/
│   └── index.js          # Punto de entrada
├── scripts/
│   └── deploy.js         # Script de despliegue
├── .env.dev              # Rutas por entorno
├── rollup.config.js      # Configuración de build
└── package.json

🔧 Alias configurados

• @ apunta a src/
• @pkg apunta a package.json (para importar la versión desde el código)

Ejemplo:

import pkg from '@pkg';
console.log(pkg.version);

✅ Requisitos

• Node.js 18 o superior
• npm 8+
• Entornos preparados con rutas específicas de despliegue

📦 Publicación en npm

Cuando esté listo para publicar:

npm login
npm publish --access=public

📄 Licencia

MIT — © David Mora