astro-contributors 0.5.0

package/CHANGELOG.md

@@ -0,0 +1,53 @@
+# astro-contributors
+
+## 0.5.0
+
+### Minor Changes
+
+- [#70](https://github.com/trueberryless-org/astro-contributors/pull/70) [`3788107`](https://github.com/trueberryless-org/astro-contributors/commit/37881073106047c17d1a17a87776244f322e7f40) Thanks [@trueberryless](https://github.com/trueberryless)! - Rename package from starlight-contributor-list to astro-contributors
+
+## 0.4.0
+
+### Minor Changes
+
+- [`0d1841f`](https://github.com/trueberryless-org/astro-contributors/commit/0d1841f3df224c12523384487a4f88fdc7950f45) Thanks [@trueberryless](https://github.com/trueberryless)! - Remove unnecessary dependencies, peer dependencies and dev dependencies
+
+### Patch Changes
+
+- [#66](https://github.com/trueberryless-org/astro-contributors/pull/66) [`5014fc1`](https://github.com/trueberryless-org/astro-contributors/commit/5014fc1506028ebbc6f6ea129c7d0a9965cb90ee) Thanks [@trueberryless](https://github.com/trueberryless)! - Fine tune package metadata
+
+## 0.3.2
+
+### Patch Changes
+
+- [#60](https://github.com/trueberryless-org/astro-contributors/pull/60) [`ad2c493`](https://github.com/trueberryless-org/astro-contributors/commit/ad2c4933a3a049916d17d5fabba5f204fa8ac376) Thanks [@trueberryless](https://github.com/trueberryless)! - Fix keyboard focus accessibility issues.
+
+## 0.3.1
+
+### Patch Changes
+
+- [#51](https://github.com/trueberryless-org/astro-contributors/pull/51) [`57dc151`](https://github.com/trueberryless-org/astro-contributors/commit/57dc15123e9f0132b29ce9e47e0fb8dc91f2be49) Thanks [@trueberryless-org](https://github.com/apps/trueberryless-org)! - Setups trusted publishing using OpenID Connect (OIDC) authentication — no code changes.
+
+## 0.3.0
+
+### Minor Changes
+
+- [#24](https://github.com/trueberryless-org/astro-contributors/pull/24) [`368e54d`](https://github.com/trueberryless-org/astro-contributors/commit/368e54d14c5277bbfce227f835715532bd5067c8) Thanks [@trueberryless](https://github.com/trueberryless)! - Add `ignore` parameter option
+
+## 0.2.1
+
+### Patch Changes
+
+- [#19](https://github.com/trueberryless-org/astro-contributors/pull/19) [`4f439a3`](https://github.com/trueberryless-org/astro-contributors/commit/4f439a38bed4c3bbdde1891c65c37066fa033363) Thanks [@trueberryless](https://github.com/trueberryless)! - Update to Starlight 0.32
+
+## 0.2.0
+
+### Minor Changes
+
+- [#9](https://github.com/trueberryless-org/astro-contributors/pull/9) [`128f46c`](https://github.com/trueberryless-org/astro-contributors/commit/128f46cca2b8c98abade03e5a3dee64970b367ae) Thanks [@trueberryless](https://github.com/trueberryless)! - Adds support for Astro v5, drops support for Astro v4.
+
+  ⚠️ **BREAKING CHANGE:** The minimum supported version of Starlight is now `0.30.0`.
+
+  Please follow the [upgrade guide](https://github.com/withastro/starlight/releases/tag/%40astrojs/starlight%400.30.0) to update your project.
+
+  Note that the [`legacy.collections` flag](https://docs.astro.build/en/reference/legacy-flags/#collections) is not supported by this plugin and you should update your collections to use Astro's new Content Layer API.

package/README.md

@@ -0,0 +1,15 @@
+# `astro-contributors`
+
+Display a list of all contributors to your project
+
+## Documentation
+
+Want to get started immediately?
+
+Check out the `astro-contributors` getting started guide.
+
+## License
+
+Licensed under the MIT license, Copyright © trueberryless.
+
+See [LICENSE](/LICENSE) for more information.

package/components/ContributorList.astro

@@ -0,0 +1,15 @@
+---
+import { getAllContributors } from "../libs/getContributors";
+import FacePile from "./FacePile.astro";
+
+export interface Props {
+  githubRepo?: `${string}/${string}`;
+  ignore?: string[];
+}
+
+const { githubRepo = "withastro/docs", ignore } = Astro.props as Props;
+
+const contributors = await getAllContributors(githubRepo, ignore);
+---
+
+<FacePile {contributors} />

package/components/FacePile.astro

@@ -0,0 +1,87 @@
+---
+import type { Contributor } from "../libs/getContributors";
+
+export interface Props {
+  contributors: Contributor[];
+}
+
+const { contributors } = Astro.props as Props;
+---
+
+<!-- Thanks to @5t3ph for https://smolcss.dev/#smol-avatar-list! -->
+<div>
+  <ul class="avatar-list">
+    {
+      contributors.map((item) => (
+        <li>
+          <a href={`https://github.com/${item.login}`}>
+            <img
+              alt={item.login}
+              title={item.login}
+              width="3rem"
+              height="3rem"
+              src={`https://avatars.githubusercontent.com/u/${item.id}?s=64`}
+              loading="lazy"
+            />
+          </a>
+        </li>
+      ))
+    }
+  </ul>
+</div>
+
+<style>
+  .avatar-list {
+    --avatar-size: 3rem;
+    --avatar-overlap: -0.125em;
+    --avatar-row-spacing: 0.125em;
+    --avatar-outline-width: 1px;
+    --avatar-outline-offset: 0.08em;
+
+    display: flex;
+    flex-wrap: wrap;
+    list-style: none;
+    padding: 0rem;
+    font-size: var(--avatar-size);
+  }
+
+  .avatar-list li {
+    position: relative;
+    --avatar-row-margin: calc(
+      var(--avatar-outline-offset) + var(--avatar-outline-width) +
+        var(--avatar-row-spacing) / 2
+    );
+    margin: var(--avatar-row-margin) var(--avatar-overlap)
+      var(--avatar-row-margin) 0;
+  }
+
+  .avatar-list li:has(:focus-visible) {
+    z-index: 10;
+    transform: scale(1.1);
+  }
+
+  .avatar-list img,
+  .avatar-list a {
+    display: block;
+    border-radius: 50%;
+    width: var(--avatar-size);
+    height: var(--avatar-size);
+    /* Hide alt/title if Avatar image fails to load. */
+    text-decoration: none;
+    color: transparent;
+  }
+
+  .avatar-list img {
+    width: 100%;
+    height: 100%;
+    object-fit: cover;
+    background-color: var(--sl-color-accent);
+    /* Indicates the contributor image boundaries for forced colors users, transparent is changed to a solid color */
+    outline: 1px solid transparent;
+  }
+
+  .avatar-list a:focus-visible {
+    outline: 2px solid var(--sl-color-accent);
+    outline-offset: var(--avatar-outline-offset);
+  }
+</style>

package/index.ts

@@ -0,0 +1 @@
+export { default as ContributorList } from "./components/ContributorList.astro";

package/libs/getContributors.ts

@@ -0,0 +1,105 @@
+import { cachedFetch } from "./util-server";
+
+export interface Contributor {
+  login: string;
+  id: number;
+  contributions: number;
+}
+
+interface Commit {
+  author: {
+    login: string;
+    id: number;
+  };
+  commit: {
+    message: string;
+  };
+}
+
+const printError = (e: Error) =>
+  console.warn(
+    `[error]  /src/util/getContributors.ts\n         ${e?.message ?? e}`
+  );
+
+async function recursiveFetch(endpoint: string, page = 1) {
+  try {
+    const queryParam = endpoint.includes("?") ? "&" : "?";
+    const pageSize = 100;
+    const url = `https://api.github.com/${endpoint}${queryParam}per_page=${pageSize}&page=${page}`;
+
+    const token = import.meta.env.PUBLIC_GITHUB_TOKEN;
+
+    const res = await cachedFetch(
+      url,
+      {
+        method: "GET",
+        headers: {
+          Authorization:
+            token && `Basic ${Buffer.from(token, "binary").toString("base64")}`,
+          "User-Agent": "astro-docs/1.0",
+        },
+      },
+      { duration: "15m" }
+    );
+
+    const data = await res.json();
+
+    if (!res.ok) {
+      throw new Error(
+        `Request to fetch endpoint failed. Reason: ${res.statusText}
+         Message: ${data?.message}`
+      );
+    }
+
+    // Fetch more data recursively if there are more than GitHub’s per-page response limit.
+    if (data.length === pageSize) {
+      const rest = await recursiveFetch(endpoint, page + 1);
+      data.push(...rest);
+    }
+
+    return data;
+  } catch (e) {
+    printError(e as Error);
+    return [];
+  }
+}
+
+export async function getAllContributors(repo: string, ignore: string[] = []) {
+  const endpoint = `repos/${repo}/contributors`;
+  const contributors: Contributor[] = await recursiveFetch(endpoint);
+
+  return contributors.filter(({ login }) => !ignore.includes(login));
+}
+
+export async function getTranslationContributors(
+  paths: string[],
+  repo: string
+) {
+  const ignoredCommitKeywords =
+    /(en-only|typo|broken link|i18nReady|i18nIgnore)/i;
+  const contributors: Contributor[] = [];
+
+  for (const path of paths) {
+    const endpoint = `repos/${repo}/commits?path=${path}`;
+    const commits: Commit[] = await recursiveFetch(endpoint);
+
+    for (const { author, commit } of commits) {
+      if (ignoredCommitKeywords.test(commit.message) || !author) continue;
+      const contributor = contributors.find(
+        (contributor) => contributor.id === author.id
+      );
+
+      if (!contributor) {
+        contributors.push({
+          id: author.id,
+          login: author.login,
+          contributions: 1,
+        });
+        continue;
+      }
+      contributor.contributions += 1;
+    }
+  }
+
+  return contributors.sort((a, b) => b.contributions - a.contributions);
+}

package/libs/util-server.ts

@@ -0,0 +1,45 @@
+/*
+	This file contains server-side utilities using features that don't work in a browser.
+	Do not import this file from a hydrated client-side component.
+*/
+
+export type CachedFetchOptions = {
+  duration?: string;
+  verbose?: boolean;
+};
+
+export async function cachedFetch(
+  url: string,
+  fetchOptions = {},
+  { duration = "5m", verbose = false }: CachedFetchOptions = {}
+) {
+  let status = 200;
+  let statusText = "OK";
+  let buffer: Buffer | undefined;
+
+  try {
+    const response = await fetch(url, fetchOptions);
+    status = response.status;
+    statusText = response.statusText;
+    if (!response.ok) {
+      throw new Error(`Bad response for ${url} (${status}): ${statusText}`);
+    }
+    const arrayBuffer = await response.arrayBuffer();
+    buffer = Buffer.from(arrayBuffer);
+  } catch (e: unknown) {
+    const error = e as Error;
+    const msg: string = error?.message || error.toString();
+    const matches = msg.match(/^Bad response for (.*) \(.*?\): (.*)$/);
+    status = parseInt(matches?.[2] || "") || 404;
+    statusText = matches?.[3] || msg;
+  }
+
+  return {
+    ok: status >= 200 && status <= 299,
+    status,
+    statusText,
+    body: buffer,
+    json: () => buffer && JSON.parse(buffer.toString()),
+    text: () => buffer?.toString(),
+  };
+}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "astro-contributors",
+  "version": "0.5.0",
+  "description": "Display a list of all contributors to your project",
+  "keywords": [
+    "starlight",
+    "docs",
+    "contributors",
+    "component"
+  ],
+  "homepage": "https://astro-contributors.trueberryless.org/",
+  "bugs": {
+    "url": "https://github.com/trueberryless-org/astro-contributors/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/trueberryless-org/astro-contributors.git",
+    "directory": "packages/astro-contributors"
+  },
+  "license": "MIT",
+  "author": "trueberryless <trueberryless@gmail.com> (https://trueberryless.org)",
+  "type": "module",
+  "exports": {
+    ".": "./index.ts",
+    "./package.json": "./package.json"
+  },
+  "peerDependencies": {
+    "astro": "^5.0.0"
+  },
+  "engines": {
+    "node": ">=22.12.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}