Merge branch 'main' into feat/print-stylesheet

Author: delucis

.changeset/config.json

@@ -9,5 +9,5 @@
   "access": "public",
   "baseBranch": "main",
   "updateInternalDependencies": "patch",
-  "ignore": ["starlight-docs"]
+  "ignore": ["starlight-docs", "@example/*", "docs-i18n-tracker"]
 }

.github/labeler.yml

@@ -0,0 +1,11 @@
+# See https://github.com/actions/labeler
+
+'🚨 action':
+- .github/workflows/**
+
+i18n:
+  - src/content/docs/de/**/*
+  - src/content/docs/es/**/*
+  - src/content/docs/fr/**/*
+  - src/content/docs/it/**/*
+  - src/content/docs/ja/**/*

.github/workflows/pr-labeler.yml

@@ -0,0 +1,15 @@
+name: "Pull Request Labeler"
+on:
+- pull_request_target
+
+jobs:
+  triage:
+    permissions:
+      contents: read
+      pull-requests: write
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/labeler@v4
+      with:
+        repo-token: "${{ secrets.GITHUB_TOKEN }}"
+  

.github/workflows/release.yml

@@ -32,6 +32,7 @@ jobs:
       - name: Create Release Pull Request
         uses: changesets/action@v1
         with:
+          version: pnpm run version
           publish: pnpm changeset publish
           commit: '[ci] release'
           title: '[ci] release'

.npmrc

@@ -0,0 +1,2 @@
+prefer-workspace-packages=true
+link-workspace-packages=true

docs-i18n-tracker/.gitignore

@@ -0,0 +1,21 @@
+# build output
+dist/
+# generated types
+.astro/
+
+# dependencies
+node_modules/
+
+# logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+
+# environment variables
+.env
+.env.production
+
+# macOS-specific files
+.DS_Store

docs-i18n-tracker/README.md

@@ -0,0 +1,9 @@
+# docs-i18n-tracker
+
+This folder contains scripts for generating a single-page dashboard tracking translation progress of pages in the Starlight docs site.
+
+You can build the page locally by moving to this directory and running `pnpm build`.
+
+The page will be built to `dist/index.html` in this directory.
+
+The live version of this tracker is available at **<https://i18n.starlight.astro.build>**.

docs-i18n-tracker/build.ts

@@ -0,0 +1,19 @@
+import { TranslationStatusBuilder } from './lib/translation-status/builder';
+import { locales } from '../docs/astro.config.mjs';
+
+const translationStatusBuilder = new TranslationStatusBuilder({
+  pageSourceDir: '../docs/src/content/docs',
+  htmlOutputFilePath: './dist/index.html',
+  sourceLanguage: 'en',
+  targetLanguages: Object.values(locales)
+    .map((el) => el.lang)
+    .filter((lang) => lang !== 'en')
+    .sort(),
+  languageLabels: Object.values(locales)
+    .filter((loc) => loc.lang !== 'en')
+    .reduce((acc, curr) => ({ [curr.lang]: curr.label, ...acc }), {}),
+  githubRepo: process.env.GITHUB_REPOSITORY || 'withastro/starlight',
+  githubToken: process.env.GITHUB_TOKEN,
+});
+
+await translationStatusBuilder.run();

docs-i18n-tracker/lib/filter-warnings.cjs

@@ -0,0 +1,23 @@
+/**
+ * When using custom loaders like `tsm` to add TypeScript & module support to scripts,
+ * Node.js outputs a known set of warnings, which distract from the actual script output.
+ *
+ * By adding `--require=./scripts/lib/filter-warnings.cjs` to the `node` or `tsm` args,
+ * this script filters those known warnings (but not any others) from the output.
+ */
+
+// Remove Node's built-in `warning` listener which outputs all warnings to stderr
+process.removeAllListeners('warning');
+
+// Add our own version that skips known warnings
+process.on('warning', (warning) => {
+	let { name, message } = warning;
+	if (
+		name === 'ExperimentalWarning' &&
+		(message.indexOf('--experimental-loader') > -1 || message.indexOf('Custom ESM Loaders') > -1)
+	)
+		return;
+	if (name === 'DeprecationWarning' && message.indexOf('Obsolete loader hook') > -1) return;
+
+	console.warn(warning);
+});

docs-i18n-tracker/lib/github-get.mjs

@@ -0,0 +1,33 @@
+import fetch from 'node-fetch';
+import pRetry, { AbortError } from 'p-retry';
+
+/**
+ * Fetch a URL from the GitHub API and resolve its JSON response.
+ * @param {{ url: string; githubToken?: string }} options
+ * @returns {Promise<any>}
+ */
+export async function githubGet({ url, githubToken = undefined }) {
+	return await pRetry(
+		async () => {
+			const headers = {
+				Accept: 'application/vnd.github.v3+json',
+			};
+			if (githubToken) {
+				headers.Authorization = `token ${githubToken}`;
+			}
+			const response = await fetch(url, { headers });
+			const json = await response.json();
+
+			if (!response.ok) {
+				throw new AbortError(
+					`GitHub API call failed: GET "${url}" returned status ${
+						response.status
+					}: ${JSON.stringify(json)}`
+				);
+			}
+
+			return json;
+		},
+		{ retries: 5 }
+	);
+}

docs-i18n-tracker/lib/output.mjs

@@ -0,0 +1,79 @@
+import dedent from 'dedent-js';
+import kleur from 'kleur';
+
+export const isCi = process.env.CI;
+
+/**
+ * @param {any} [message]
+ * @param  {...any} params
+ */
+export function debug(message, ...params) {
+  console.log(message, ...params);
+}
+
+/**
+ * @param {any} [message]
+ * @param  {...any} params
+ */
+export function warning(message, ...params) {
+  console.warn(kleur.yellow().bold(`*** WARNING: ${message}`), ...params);
+}
+
+/**
+ * @param {any} [message]
+ * @param  {...any} params
+ */
+export function error(message, ...params) {
+  console.error(kleur.red().bold(`*** ERROR: ${message}`), ...params);
+}
+
+/**
+ * Dedents the given markdown and replaces single newlines with spaces,
+ * while leaving new paragraphs intact.
+ */
+export function dedentMd(...markdown) {
+  return dedent(...markdown).replace(/(\S)\n(?!\n)/g, '$1 ');
+}
+
+/**
+ * Formats the given `template` based on `count`, picking the correct plural
+ * or singular form from the template.
+ *
+ * - If `count` is defined, it also prepends the template with `count`.
+ *   - Example: "broken link(s)" --> "1 broken link" / "2 broken links"
+ * - If `count` is undefined, it capitalizes the first letter.
+ *   - Example: "broken link(s)" --> "Broken link"
+ *
+ * Supported template syntax:
+ * - Use `(s)` to add a plural-only "s", e.g. "broken link(s)"
+ * - Use `|` to provide separate templates, e.g. "issue was|issues were"
+ *
+ * @param {number} count
+ * @param {string} template
+ */
+export function formatCount(count, template) {
+  /** @param {string} text */
+  const wrapWithCount = (text) => {
+    // If no count was given, we're outputting a single issue in annotations,
+    // so omit count and capitalize the first letter of the issue type description
+    if (count === undefined) return text[0].toUpperCase() + text.slice(1);
+
+    // Otherwise, prefix the issue type description with count
+    return `${count} ${text}`;
+  };
+
+  const usePlural = count !== undefined && count !== 1;
+  const templateParts = template.split('|');
+  const usedTemplate =
+    templateParts.length === 2 ? templateParts[usePlural ? 1 : 0] : template;
+  return wrapWithCount(usedTemplate.replace(/\(s\)/g, usePlural ? 's' : ''));
+}
+
+export default {
+  debug,
+  warning,
+  error,
+  dedentMd,
+  formatCount,
+  isCi,
+};