Comenzando 🚀

🟢🟢🟢 HACE UN FORK DEL PROYECTO 🔴🔴🔴 NO HAGAS UN CLONE Para mantener limpio el repositorio no esta permitido pushear a la rama main de este template.

Una vez tengas los archivos del template en tu propio repositorio ya puedes empezar:

$npm install
$npm run prepare

Setea tu configuracion

Archivo .npmrc

Debemos sabes a donde vamos a registrar nuestro package (debe ser un repositorio de gitlab) de ese repositorio, necesitamos el [ID_PROJECT] y un [TOKEN_PROJECT] generado desde la configuracion del mismo con permisos para leer y escribir. El [NOMBRE_LIBRERIA] debe ser recordado ya que debe coincidir con el "name" de nuestro package.json

@[NOMBRE_LIBRERIA]:registry=https://gitlab.com/api/v4/projects/[ID_PROJECT]/packages/npm/ //gitlab.com/api/v4/projects/[ID_PROJECT]/packages/npm/:_authToken=[TOKEN_PROJECT]

Archivo package.json Debemos editar la propiedad "name" de nuestro package.json y elegir un nombre respetando nuestro [NOMBRE_LIBRERIA] "name": "@[NOMBRE_LIBRERIA]/template-package"

Carpeta Package Es donde codearemos nuestro package, typescript hara una compilacion desde esta carpeta hacia otra llamada "dist" Esta carpeta "dist" es la que se publicara y esta especificada en la propiedad "files" de nuestro package.json, por eso mismo nuestro "main" en el package.json apunta a "dist/index.js"

Archivo index.ts en el root del proyecto Este archivo es unicamente para realizar pruebas mientras estamos desarrollando nuestro package, simulando consumirlo desde otro repositorio pero en realidad solo importamos el index desde la carpeta "package" o "dist"

🚩ATENCION se recomienda importar desde la carpeta "dist" ya que realmente es asi como quedara nuestro package final, para realizar pruebas mas certeras y reales.

Dependencias en package.json Tener en cuenta que todas las dependencias que no esten como devDependencies seran instaladas al momento de instalar nuestro package Elegir bien cuales corresponden a dev y cuales a prod.

Versionado automatico ✔️✔️✔️✔️ (recomendado)

usar una de las siguientes formas de commit para incrementar la version correspondiente del package:

git commit -m "patch - descripcion"
git commit -m "minor - descripcion"
git commit -m "major - descripcion"

Cuando ejecutemos un [git push]... ANTES incrementara automaticamente la version del package.json, y luego se realizara el push del codigo nuevo y luego la paquetizacion y registro en gitlab segun nuestro archivo .npmrc

Versionado Manual ❌❌❌❌ (no recomendado)