@franelfers/github-contributions

Utilidad para obtener estadísticas de contribuciones de GitHub de un usuario. Permite consultar el total de contribuciones y el desglose por año en un rango de fechas configurables.

Setup

npm install @franelfers/github-contributions

Uso

getContributions(user, from, to)

Función que obtiene las estadísticas de contribuciones de GitHub para un usuario en un rango de años.

import getContributions from "@franelfers/github-contributions"

// Obtener contribuciones de 2020 a 2023
const stats = await getContributions("torvalds", 2020, 2023)

// Resultado
console.log(stats.totalContributions) // Total de contribuciones
console.log(stats[2020]) // Contribuciones en 2020
console.log(stats[2021]) // Contribuciones en 2021

Parámetros

• user: string - Nombre de usuario de GitHub
• from: number - Año de inicio (inclusive)
• to: number - Año de fin (inclusive)

Retorna

Promise que resuelve a un objeto con:

• totalContributions: number - Total de contribuciones en el rango
• [year: number]: number - Contribuciones para cada año

Ejemplo:

const stats = await getContributions("octocat", 2020, 2023)

// Resultado
{
  totalContributions: 5000,
  2020: 1000,
  2021: 1200,
  2022: 1300,
  2023: 1500
}

Ejemplo completo

import getContributions from "@franelfers/github-contributions"

async function analyzeUserContributions() {
  try {
    const stats = await getContributions("linus", 2019, 2024)
    
    console.log(`Total contribuciones: ${stats.totalContributions}`)
    
    for (let year = 2019; year <= 2024; year++) {
      console.log(`${year}: ${stats[year]} contribuciones`)
    }
  } catch (error) {
    console.error("Error obteniendo estadísticas:", error)
  }
}

analyzeUserContributions()

Características

• ✅ Obtiene estadísticas reales de GitHub
• ✅ Desglose por año en un rango configurable
• ✅ Retorna total de contribuciones y valores individuales
• ✅ Basado en Promise para integración moderna
• ✅ Soporte para cualquier usuario público de GitHub