@rmdes/indiekit-endpoint-github 1.0.0

package/lib/utils.js

@@ -0,0 +1,198 @@
+/**
+ * Truncate text with ellipsis
+ * @param {string} text - Text to truncate
+ * @param {number} [maxLength] - Maximum length
+ * @returns {string} - Truncated text
+ */
+export function truncate(text, maxLength = 80) {
+  if (!text || text.length <= maxLength) return text || "";
+  return text.slice(0, maxLength - 1) + "…";
+}
+
+/**
+ * Extract commits from push events
+ * @param {Array} events - GitHub events
+ * @returns {Array} - Formatted commits
+ */
+export function extractCommits(events) {
+  if (!Array.isArray(events)) return [];
+
+  return events
+    .filter((event) => event.type === "PushEvent")
+    .flatMap((event) =>
+      (event.payload?.commits || []).map((commit) => ({
+        sha: commit.sha.slice(0, 7),
+        message: truncate(commit.message.split("\n")[0]),
+        url: `https://github.com/${event.repo.name}/commit/${commit.sha}`,
+        repo: event.repo.name,
+        repoUrl: `https://github.com/${event.repo.name}`,
+        date: event.created_at,
+      })),
+    );
+}
+
+/**
+ * Extract PRs/Issues created from events
+ * @param {Array} events - GitHub events
+ * @returns {Array} - Formatted contributions
+ */
+export function extractContributions(events) {
+  if (!Array.isArray(events)) return [];
+
+  return events
+    .filter(
+      (event) =>
+        (event.type === "PullRequestEvent" || event.type === "IssuesEvent") &&
+        event.payload?.action === "opened",
+    )
+    .map((event) => {
+      const item = event.payload.pull_request || event.payload.issue;
+      return {
+        type: event.type === "PullRequestEvent" ? "pr" : "issue",
+        title: truncate(item?.title),
+        url: item?.html_url,
+        repo: event.repo.name,
+        repoUrl: `https://github.com/${event.repo.name}`,
+        number: item?.number,
+        date: event.created_at,
+      };
+    });
+}
+
+/**
+ * Format starred repos for display
+ * @param {Array} repos - Starred repositories
+ * @returns {Array} - Formatted repos
+ */
+export function formatStarred(repos) {
+  if (!Array.isArray(repos)) return [];
+
+  return repos.map((repo) => ({
+    name: repo.full_name,
+    description: truncate(repo.description, 120),
+    url: repo.html_url,
+    stars: repo.stargazers_count,
+    language: repo.language,
+    topics: repo.topics?.slice(0, 5) || [],
+  }));
+}
+
+/**
+ * Format user's own repositories for display
+ * @param {Array} repos - User repositories
+ * @returns {Array} - Formatted repos
+ */
+export function formatRepos(repos) {
+  if (!Array.isArray(repos)) return [];
+
+  return repos.map((repo) => ({
+    name: repo.name,
+    fullName: repo.full_name,
+    description: truncate(repo.description, 120),
+    url: repo.html_url,
+    stars: repo.stargazers_count,
+    forks: repo.forks_count,
+    language: repo.language,
+    topics: repo.topics?.slice(0, 5) || [],
+    isPrivate: repo.private,
+    isFork: repo.fork,
+    pushedAt: repo.pushed_at,
+    updatedAt: repo.updated_at,
+  }));
+}
+
+/**
+ * Extract activity on user's repos from other users
+ * @param {Array} events - Repository events
+ * @param {string} username - Owner username to exclude
+ * @returns {Array} - Formatted activity
+ */
+export function extractRepoActivity(events, username) {
+  if (!Array.isArray(events)) return [];
+
+  return events
+    .filter((event) => event.actor?.login !== username) // Exclude own activity
+    .map((event) => ({
+      type: event.type.replace("Event", "").toLowerCase(),
+      actor: event.actor?.login,
+      actorUrl: `https://github.com/${event.actor?.login}`,
+      actorAvatar: event.actor?.avatar_url,
+      repo: event.repo?.name,
+      repoUrl: `https://github.com/${event.repo?.name}`,
+      date: event.created_at,
+      detail: getEventDetail(event),
+    }));
+}
+
+/**
+ * Get human-readable detail for an event
+ * @param {object} event - GitHub event
+ * @returns {string} - Event description
+ */
+function getEventDetail(event) {
+  switch (event.type) {
+    case "WatchEvent": {
+      return "starred";
+    }
+    case "ForkEvent": {
+      return "forked";
+    }
+    case "PullRequestEvent": {
+      return `${event.payload?.action} PR #${event.payload?.number}`;
+    }
+    case "IssuesEvent": {
+      return `${event.payload?.action} issue #${event.payload?.number}`;
+    }
+    case "IssueCommentEvent": {
+      return "commented";
+    }
+    case "CreateEvent": {
+      return `created ${event.payload?.ref_type}`;
+    }
+    case "DeleteEvent": {
+      return `deleted ${event.payload?.ref_type}`;
+    }
+    case "PushEvent": {
+      return `pushed ${event.payload?.size} commit(s)`;
+    }
+    default: {
+      return event.type?.replace("Event", "").toLowerCase() || "activity";
+    }
+  }
+}
+
+/**
+ * Format date for display
+ * @param {string} dateString - ISO date string
+ * @param {string} [locale] - Locale for formatting
+ * @returns {string} - Formatted date
+ */
+export function formatDate(dateString, locale = "en") {
+  const date = new Date(dateString);
+  return date.toLocaleDateString(locale, {
+    year: "numeric",
+    month: "short",
+    day: "numeric",
+  });
+}
+
+/**
+ * Format relative time
+ * @param {string} dateString - ISO date string
+ * @returns {string} - Relative time string
+ */
+export function formatRelativeTime(dateString) {
+  const date = new Date(dateString);
+  const now = new Date();
+  const diffMs = now - date;
+  const diffMins = Math.floor(diffMs / 60_000);
+  const diffHours = Math.floor(diffMs / 3_600_000);
+  const diffDays = Math.floor(diffMs / 86_400_000);
+
+  if (diffMins < 1) return "just now";
+  if (diffMins < 60) return `${diffMins}m ago`;
+  if (diffHours < 24) return `${diffHours}h ago`;
+  if (diffDays < 7) return `${diffDays}d ago`;
+
+  return formatDate(dateString);
+}

package/locales/en.json

@@ -0,0 +1,38 @@
+{
+  "github": {
+    "title": "GitHub",
+    "activity": "GitHub activity",
+    "viewAll": "View all",
+    "error": {
+      "noUsername": "No GitHub username configured. Add a username in your Indiekit configuration."
+    },
+    "featured": {
+      "title": "Featured Projects",
+      "none": "No featured repositories configured"
+    },
+    "commits": {
+      "title": "Recent commits",
+      "none": "No recent commits"
+    },
+    "stars": {
+      "title": "Recently starred",
+      "none": "No starred repositories"
+    },
+    "contributions": {
+      "title": "PRs & Issues",
+      "none": "No recent contributions"
+    },
+    "repos": {
+      "title": "My repositories",
+      "none": "No repositories found"
+    },
+    "activity": {
+      "title": "Activity on my repos",
+      "none": "No recent activity from others"
+    },
+    "widget": {
+      "description": "View your GitHub activity, commits, stars, and contributions.",
+      "view": "View activity"
+    }
+  }
+}

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@rmdes/indiekit-endpoint-github",
+  "version": "1.0.0",
+  "description": "GitHub activity endpoint for Indiekit. Display commits, stars, contributions, and featured repositories.",
+  "keywords": [
+    "indiekit",
+    "indiekit-plugin",
+    "indieweb",
+    "github",
+    "activity"
+  ],
+  "homepage": "https://github.com/rmdes/indiekit-endpoint-github",
+  "bugs": {
+    "url": "https://github.com/rmdes/indiekit-endpoint-github/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/rmdes/indiekit-endpoint-github.git"
+  },
+  "author": {
+    "name": "Ricardo Mendes",
+    "url": "https://rmendes.net"
+  },
+  "license": "MIT",
+  "engines": {
+    "node": ">=20"
+  },
+  "type": "module",
+  "main": "index.js",
+  "exports": {
+    ".": "./index.js"
+  },
+  "files": [
+    "assets",
+    "includes",
+    "lib",
+    "locales",
+    "views",
+    "index.js"
+  ],
+  "dependencies": {
+    "@indiekit/error": "^1.0.0-beta.25",
+    "express": "^5.0.0"
+  },
+  "peerDependencies": {
+    "@indiekit/indiekit": ">=1.0.0-beta.25"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/views/activity.njk

@@ -0,0 +1,22 @@
+{% extends "document.njk" %}
+
+{% block content %}
+  {% if error %}
+    {{ prose({ text: error.message }) }}
+  {% elif activity and activity.length > 0 %}
+    <ul class="github-list">
+      {% for item in activity %}
+      <li class="github-list__item github-activity">
+        <img src="{{ item.actorAvatar }}" alt="{{ item.actor }}" class="github-activity__avatar" width="32" height="32">
+        <div class="github-activity__content">
+          <a href="{{ item.actorUrl }}" target="_blank" rel="noopener">{{ item.actor }}</a>
+          <span class="github-activity__detail">{{ item.detail }}</span>
+          <a href="{{ item.repoUrl }}" target="_blank" rel="noopener">{{ item.repo }}</a>
+        </div>
+      </li>
+      {% endfor %}
+    </ul>
+  {% else %}
+    {{ prose({ text: __("github.activity.none") }) }}
+  {% endif %}
+{% endblock %}

package/views/commits.njk

@@ -0,0 +1,21 @@
+{% extends "document.njk" %}
+
+{% block content %}
+  {% if error %}
+    {{ prose({ text: error.message }) }}
+  {% elif commits and commits.length > 0 %}
+    <ul class="github-list">
+      {% for commit in commits %}
+      <li class="github-list__item">
+        <code class="github-sha"><a href="{{ commit.url }}" target="_blank" rel="noopener">{{ commit.sha }}</a></code>
+        <span class="github-commit__message">{{ commit.message }}</span>
+        <small class="github-meta">
+          <a href="{{ commit.repoUrl }}" target="_blank" rel="noopener">{{ commit.repo }}</a>
+        </small>
+      </li>
+      {% endfor %}
+    </ul>
+  {% else %}
+    {{ prose({ text: __("github.commits.none") }) }}
+  {% endif %}
+{% endblock %}

package/views/contributions.njk

@@ -0,0 +1,24 @@
+{% extends "document.njk" %}
+
+{% block content %}
+  {% if error %}
+    {{ prose({ text: error.message }) }}
+  {% elif contributions and contributions.length > 0 %}
+    <ul class="github-list">
+      {% for item in contributions %}
+      <li class="github-list__item">
+        {{ badge({
+          color: "green" if item.type === "pr" else "blue",
+          text: "PR" if item.type === "pr" else "Issue"
+        }) }}
+        <a href="{{ item.url }}" target="_blank" rel="noopener">{{ item.title }}</a>
+        <small class="github-meta">
+          <a href="{{ item.repoUrl }}" target="_blank" rel="noopener">{{ item.repo }}#{{ item.number }}</a>
+        </small>
+      </li>
+      {% endfor %}
+    </ul>
+  {% else %}
+    {{ prose({ text: __("github.contributions.none") }) }}
+  {% endif %}
+{% endblock %}

package/views/github.njk

@@ -0,0 +1,155 @@
+{% extends "document.njk" %}
+
+{% block content %}
+  {% if error %}
+    {{ prose({ text: error.message }) }}
+  {% else %}
+    {# Featured Projects #}
+    {% if featured and featured.length > 0 %}
+    <section class="github-section">
+      <h2>{{ __("github.featured.title") }}</h2>
+      <div class="github-featured">
+        {% for repo in featured %}
+        <article class="github-featured__repo">
+          <h3 class="github-featured__name">
+            <a href="{{ repo.url }}" target="_blank" rel="noopener">{{ repo.fullName }}</a>
+            {% if repo.isPrivate %}
+            {{ badge({ color: "blue", text: "Private" }) }}
+            {% endif %}
+          </h3>
+          {% if repo.description %}
+          <p class="github-featured__desc">{{ repo.description }}</p>
+          {% endif %}
+          <div class="github-featured__meta">
+            {% if repo.language %}
+            <span class="github-lang">{{ repo.language }}</span>
+            {% endif %}
+            <span>{{ repo.stars }} stars</span>
+            {% if repo.forks > 0 %}
+            <span>{{ repo.forks }} forks</span>
+            {% endif %}
+          </div>
+          {% if repo.commits and repo.commits.length > 0 %}
+          <details class="github-featured__commits">
+            <summary>Recent commits ({{ repo.commits.length }})</summary>
+            <ul class="github-commit-list">
+              {% for commit in repo.commits %}
+              <li>
+                <code><a href="{{ commit.url }}" target="_blank" rel="noopener">{{ commit.sha }}</a></code>
+                <span>{{ commit.message }}</span>
+                <small>by {{ commit.author }}</small>
+              </li>
+              {% endfor %}
+            </ul>
+          </details>
+          {% endif %}
+        </article>
+        {% endfor %}
+      </div>
+    </section>
+    {% endif %}
+
+    {# Recent Commits #}
+    <section class="github-section">
+      <h2>{{ __("github.commits.title") }}</h2>
+      {% if commits and commits.length > 0 %}
+      <ul class="github-list">
+        {% for commit in commits %}
+        <li class="github-list__item">
+          <code class="github-sha"><a href="{{ commit.url }}" target="_blank" rel="noopener">{{ commit.sha }}</a></code>
+          <span class="github-commit__message">{{ commit.message }}</span>
+          <small class="github-meta">
+            <a href="{{ commit.repoUrl }}" target="_blank" rel="noopener">{{ commit.repo }}</a>
+          </small>
+        </li>
+        {% endfor %}
+      </ul>
+      {% else %}
+      {{ prose({ text: __("github.commits.none") }) }}
+      {% endif %}
+    </section>
+
+    {# Recently Starred #}
+    <section class="github-section">
+      <h2>{{ __("github.stars.title") }}</h2>
+      {% if stars and stars.length > 0 %}
+      <ul class="github-list github-list--grid">
+        {% for star in stars %}
+        <li class="github-list__item github-star">
+          <a href="{{ star.url }}" class="github-star__name" target="_blank" rel="noopener">{{ star.name }}</a>
+          {% if star.description %}
+          <p class="github-star__desc">{{ star.description }}</p>
+          {% endif %}
+          <small class="github-meta">
+            {% if star.language %}
+            <span class="github-lang">{{ star.language }}</span>
+            {% endif %}
+            <span class="github-star__count">{{ star.stars }} stars</span>
+          </small>
+        </li>
+        {% endfor %}
+      </ul>
+      {% else %}
+      {{ prose({ text: __("github.stars.none") }) }}
+      {% endif %}
+    </section>
+
+    {# PRs & Issues #}
+    {% if contributions and contributions.length > 0 %}
+    <section class="github-section">
+      <h2>{{ __("github.contributions.title") }}</h2>
+      <ul class="github-list">
+        {% for item in contributions %}
+        <li class="github-list__item">
+          {% if item.type == "pr" %}
+          {{ badge({ color: "green", text: "PR" }) }}
+          {% else %}
+          {{ badge({ color: "purple", text: "Issue" }) }}
+          {% endif %}
+          <a href="{{ item.url }}" target="_blank" rel="noopener">{{ item.title }}</a>
+          <small class="github-meta">
+            <a href="{{ item.repoUrl }}" target="_blank" rel="noopener">{{ item.repo }}#{{ item.number }}</a>
+          </small>
+        </li>
+        {% endfor %}
+      </ul>
+    </section>
+    {% endif %}
+
+    {# My Repositories #}
+    <section class="github-section">
+      <h2>{{ __("github.repos.title") }}</h2>
+      {% if repositories and repositories.length > 0 %}
+      <ul class="github-list github-list--grid">
+        {% for repo in repositories %}
+        <li class="github-list__item github-repo">
+          <a href="{{ repo.url }}" class="github-repo__name" target="_blank" rel="noopener">
+            {{ repo.name }}
+          </a>
+          {% if repo.isPrivate %}
+          {{ badge({ color: "gray", text: "Private" }) }}
+          {% endif %}
+          {% if repo.isFork %}
+          {{ badge({ color: "purple", text: "Fork" }) }}
+          {% endif %}
+          {% if repo.description %}
+          <p class="github-repo__desc">{{ repo.description }}</p>
+          {% endif %}
+          <small class="github-meta">
+            {% if repo.language %}
+            <span class="github-lang">{{ repo.language }}</span>
+            {% endif %}
+            <span class="github-repo__stars">{{ repo.stars }} stars</span>
+            {% if repo.forks > 0 %}
+            <span class="github-repo__forks">{{ repo.forks }} forks</span>
+            {% endif %}
+          </small>
+        </li>
+        {% endfor %}
+      </ul>
+      {% else %}
+      {{ prose({ text: __("github.repos.none") }) }}
+      {% endif %}
+    </section>
+  {% endif %}
+{% endblock %}

package/views/stars.njk

@@ -0,0 +1,26 @@
+{% extends "document.njk" %}
+
+{% block content %}
+  {% if error %}
+    {{ prose({ text: error.message }) }}
+  {% elif stars and stars.length > 0 %}
+    <ul class="github-list github-list--grid">
+      {% for star in stars %}
+      <li class="github-list__item github-star">
+        <a href="{{ star.url }}" class="github-star__name" target="_blank" rel="noopener">{{ star.name }}</a>
+        {% if star.description %}
+        <p class="github-star__desc">{{ star.description }}</p>
+        {% endif %}
+        <small class="github-meta">
+          {% if star.language %}
+          <span class="github-lang">{{ star.language }}</span>
+          {% endif %}
+          <span class="github-star__count">{{ star.stars }} stars</span>
+        </small>
+      </li>
+      {% endfor %}
+    </ul>
+  {% else %}
+    {{ prose({ text: __("github.stars.none") }) }}
+  {% endif %}
+{% endblock %}