@raonasp/sharepoint-service

Introduction

En este proyecto crearemos y mantendremos los diferentes servicios de SharePoint y Graph para consumir desde desarrollos basados en SharePoint Framework

Antes de empezar

Para poder desarrollar, hace falta lo siguiente

• Instalad Node.js 16 o 18
• Clonad el proyecto
• Cread una rama basada en dev (no se podrá hacer push en la rama dev ni en la rama master)
• Cambiad a la rama que os créeis
• Ejecutad npm install

Con esto ya se puede comenzar a desarrollar 😄

Pruebas

Para probar la librería de manera local en vuestro proyecto de SPFx, ejecutad lo siguiente:

En la carpeta raíz de la librería

• Ejecutar npm run build o npm run watch(este último sirve para mantener el compilador de TypeScript en marcha mientras hacéis cambios)
• Ejecutar npm link

En la carpeta raíz del proyecto de SPFx

• Ejecutar npm link @raonasp/sharepoint-service

Con esto, se os creará un symlink de la librería al proyecto. Si habéis usado el script watch cualquier cambio que hagáis en la librería se reflejará automáticamente en vuestro proyecto. Si no, tendréis que usar el script build cada vez que cambiéis algo.

Publicación

Una vez vuestro código funcione correctamente, haced push a la rama dev y un pull request a la rama master. El pull request se revisará para comprobar que se mantiene un orden y coherencia en el código y, si se aprueba, una pipeline de DevOps publicará automáticamente el código en npm.

IMPORTANTE

Antes de hacer el pull request a la rama master, aseguraos de subir la versión del paquete en el archivo package.json. Si la versión no cambia, la publicación a npm no funcionará (y si el revisor del código se da cuenta, os echará el pull request para atrás 😋)

Compatibilidad

Esta librería sólo es compatible con la versión 1.18.0 de SPFx. Si la queréis usar en un proyecto anterior a esta versión, por favor, actualizad la versión del proyecto a la 1.18.0.