style(format): format source

Author: JamieMason

package-lock.json

@@ -5,6 +5,7 @@
     "@astrojs/check": "^0.9.6",
     "@astrojs/starlight": "^0.37.4",
     "astro": "^5.16.16",
+    "rehype-external-links": "^3.0.0",
     "satori-astro": "^0.3.3",
     "satori-html": "^0.3.2",
     "sharp": "^0.34.5",

pnpm-lock.yaml

@@ -1,18 +1,18 @@
 ---
-import StarlightHead from "@astrojs/starlight/components/Head.astro";
-import { buildSchemas } from "../lib/schema";
+import StarlightHead from '@astrojs/starlight/components/Head.astro';
+import { buildSchemas } from '../lib/schema';
 
-const siteUrl = "https://jamiemason.github.io";
+const siteUrl = 'https://jamiemason.github.io';
 
 // Access the page ID from Starlight's route data
-const pageId = Astro.locals.starlightRoute?.id || "";
+const pageId = Astro.locals.starlightRoute?.id || '';
 
 // Use dynamic OG image for docs pages, fallback to static for FAQ pages
-let ogImagePath = "/syncpack/social-card.jpg";
-if (pageId === "") {
+let ogImagePath = '/syncpack/social-card.jpg';
+if (pageId === '') {
   // Homepage - use index.png
-  ogImagePath = "/syncpack/og/index.png";
-} else if (pageId && !pageId.startsWith("faq")) {
+  ogImagePath = '/syncpack/og/index.png';
+} else if (pageId && !pageId.startsWith('faq')) {
   // Other docs pages
   ogImagePath = `/syncpack/og/${pageId}.png`;
 }

site/astro.config.mjs

@@ -1,4 +1,4 @@
-import { siteConfig } from "./siteConfig";
+import { siteConfig } from './siteConfig';
 
 type StarlightRouteData = any;
 
@@ -10,7 +10,7 @@ type StarlightRouteData = any;
 export function buildSchemas(route: StarlightRouteData) {
   const schemas: Record<string, any>[] = [];
 
-  const isHomepage = route.id === "";
+  const isHomepage = route.id === '';
   const isDocPage = !isHomepage;
 
   if (isHomepage) {
@@ -34,8 +34,8 @@ export function buildSchemas(route: StarlightRouteData) {
  */
 function buildWebSiteSchema() {
   return {
-    "@context": "https://schema.org",
-    "@type": "WebSite",
+    '@context': 'https://schema.org',
+    '@type': 'WebSite',
     name: siteConfig.siteName,
     url: siteConfig.siteUrl,
   };
@@ -47,14 +47,14 @@ function buildWebSiteSchema() {
  */
 function buildPersonSchema() {
   return {
-    "@context": "https://schema.org",
-    "@type": "Person",
+    '@context': 'https://schema.org',
+    '@type': 'Person',
     name: siteConfig.authorName,
     url: siteConfig.authorUrl,
     image: siteConfig.authorImage,
     sameAs: siteConfig.authorSocial,
     funding: {
-      "@type": "MonetaryGrant",
+      '@type': 'MonetaryGrant',
       url: siteConfig.sponsorUrl,
     },
   };
@@ -66,16 +66,16 @@ function buildPersonSchema() {
  */
 function buildSoftwareApplicationSchema() {
   return {
-    "@context": "https://schema.org",
-    "@type": "SoftwareApplication",
+    '@context': 'https://schema.org',
+    '@type': 'SoftwareApplication',
     name: siteConfig.siteName,
     description: siteConfig.softwareDescription,
     url: siteConfig.siteUrl,
     image: siteConfig.logoUrl,
-    applicationCategory: "DeveloperApplication",
-    operatingSystem: ["Linux", "macOS", "Windows"],
+    applicationCategory: 'DeveloperApplication',
+    operatingSystem: ['Linux', 'macOS', 'Windows'],
     author: {
-      "@type": "Person",
+      '@type': 'Person',
       name: siteConfig.authorName,
       url: siteConfig.authorUrl,
     },
@@ -92,10 +92,10 @@ function buildBreadcrumbSchema(route: StarlightRouteData) {
   const breadcrumbs = generateBreadcrumbs(route.slug);
 
   return {
-    "@context": "https://schema.org",
-    "@type": "BreadcrumbList",
+    '@context': 'https://schema.org',
+    '@type': 'BreadcrumbList',
     itemListElement: breadcrumbs.map((item, i) => ({
-      "@type": "ListItem",
+      '@type': 'ListItem',
       position: i + 1,
       name: item.name,
       item: `${siteConfig.siteUrl}${item.url}`,
@@ -109,36 +109,35 @@ function buildBreadcrumbSchema(route: StarlightRouteData) {
  */
 function buildArticleSchema(route: StarlightRouteData) {
   const { data } = route.entry;
-  const title = data.title || "Syncpack Documentation";
+  const title = data.title || 'Syncpack Documentation';
   const description = data.description || siteConfig.description;
 
   // Starlight provides lastUpdated from Git when lastUpdated: true in config
-  const dateModified =
-    data.lastUpdated?.toISOString() || new Date().toISOString();
+  const dateModified = data.lastUpdated?.toISOString() || new Date().toISOString();
 
   // Use the OG image for this specific page
   const ogImageUrl = `${siteConfig.siteUrl}/og/${route.id}.png`;
 
   return {
-    "@context": "https://schema.org",
-    "@type": "Article",
+    '@context': 'https://schema.org',
+    '@type': 'Article',
     headline: title,
     description: description,
     datePublished: dateModified, // Use same as modified for docs
     dateModified: dateModified,
     author: {
-      "@type": "Person",
+      '@type': 'Person',
       name: siteConfig.authorName,
       url: siteConfig.authorUrl,
     },
     publisher: {
-      "@type": "Person",
+      '@type': 'Person',
       name: siteConfig.authorName,
       url: siteConfig.authorUrl,
       image: siteConfig.authorImage,
     },
     image: ogImageUrl,
-    inLanguage: "en",
+    inLanguage: 'en',
   };
 }
 
@@ -151,12 +150,12 @@ function buildArticleSchema(route: StarlightRouteData) {
  * - Getting Started → /syncpack/guide/getting-started/
  */
 function generateBreadcrumbs(slug: string) {
-  const breadcrumbs = [{ name: "Docs", url: "/" }];
+  const breadcrumbs = [{ name: 'Docs', url: '/' }];
 
-  const parts = slug.split("/").filter(Boolean);
-  let currentPath = "";
+  const parts = slug.split('/').filter(Boolean);
+  let currentPath = '';
 
-  parts.forEach((part) => {
+  parts.forEach(part => {
     currentPath += `/${part}`;
     breadcrumbs.push({
       name: titleCase(part),
@@ -174,7 +173,7 @@ function generateBreadcrumbs(slug: string) {
  */
 function titleCase(str: string) {
   return str
-    .split("-")
-    .map((word) => word.charAt(0).toUpperCase() + word.slice(1))
-    .join(" ");
+    .split('-')
+    .map(word => word.charAt(0).toUpperCase() + word.slice(1))
+    .join(' ');
 }

site/package.json

@@ -4,22 +4,22 @@
  * These values are used across all schema builders to ensure consistency.
  */
 export const siteConfig = {
-  siteName: "Syncpack",
-  siteUrl: "https://jamiemason.github.io/syncpack",
-  description: "Consistent dependency versions in large JavaScript Monorepos",
+  siteName: 'Syncpack',
+  siteUrl: 'https://jamiemason.github.io/syncpack',
+  description: 'Consistent dependency versions in large JavaScript Monorepos',
   softwareDescription:
-    "CLI for managing dependency versions in JavaScript monorepos. Used by AWS, Cloudflare, DataDog, Electron, Microsoft, Vercel, and others.",
-  logoUrl: "https://jamiemason.github.io/syncpack/logo.svg",
-  npmUrl: "https://www.npmjs.com/package/syncpack",
-  githubUrl: "https://github.com/JamieMason/syncpack",
-  authorName: "Jamie Mason",
-  authorUrl: "https://github.com/JamieMason",
-  authorImage: "https://avatars.githubusercontent.com/u/320492?v=4",
+    'CLI for managing dependency versions in JavaScript monorepos. Used by AWS, Cloudflare, DataDog, Electron, Microsoft, Vercel, and others.',
+  logoUrl: 'https://jamiemason.github.io/syncpack/logo.svg',
+  npmUrl: 'https://www.npmjs.com/package/syncpack',
+  githubUrl: 'https://github.com/JamieMason/syncpack',
+  authorName: 'Jamie Mason',
+  authorUrl: 'https://github.com/JamieMason',
+  authorImage: 'https://avatars.githubusercontent.com/u/320492?v=4',
   authorSocial: [
-    "https://github.com/JamieMason",
-    "https://bsky.app/profile/foldleft.bsky.social",
-    "http://uk.linkedin.com/in/jamiemasonleeds",
-    "https://twitter.com/fold_left",
+    'https://github.com/JamieMason',
+    'https://bsky.app/profile/foldleft.bsky.social',
+    'http://uk.linkedin.com/in/jamiemasonleeds',
+    'https://twitter.com/fold_left',
   ],
-  sponsorUrl: "https://github.com/sponsors/JamieMason",
+  sponsorUrl: 'https://github.com/sponsors/JamieMason',
 } as const;

site/src/components/Head.astro

@@ -1,11 +1,11 @@
 ---
-import { getCollection, render } from "astro:content";
-import StarlightPage from "@astrojs/starlight/components/StarlightPage.astro";
-import Question from "@components/question.astro";
+import { getCollection, render } from 'astro:content';
+import StarlightPage from '@astrojs/starlight/components/StarlightPage.astro';
+import Question from '@components/question.astro';
 
-const files = await getCollection("faq");
+const files = await getCollection('faq');
 const faqs = await Promise.all(
-  files.map(async (faq) => ({
+  files.map(async faq => ({
     Answer: (await render(faq)).Content,
     faq,
     slug: faq.id,

site/src/lib/schema.ts

@@ -1,37 +1,34 @@
-import { defineRouteMiddleware } from "@astrojs/starlight/route-data";
+import { defineRouteMiddleware } from '@astrojs/starlight/route-data';
 
 // Build custom title with breadcrumb structure
 function getCustomTitle(route: any): string {
-  if (!route) return "Syncpack";
+  if (!route) return 'Syncpack';
 
   // Homepage special case
-  if (route.id === "") {
-    return "Consistent dependency versions in JavaScript Monorepos | Syncpack";
+  if (route.id === '') {
+    return 'Consistent dependency versions in JavaScript Monorepos | Syncpack';
   }
 
   const pageTitle = route.entry.data.title;
 
   // Special case: Status Codes overview page (reference/status-codes with slug: status)
   // Title is "Status Codes" so avoid duplicate
-  if (
-    route.id === "reference/status-codes" ||
-    (route.slug === "status" && pageTitle === "Status Codes")
-  ) {
+  if (route.id === 'reference/status-codes' || (route.slug === 'status' && pageTitle === 'Status Codes')) {
     return `${pageTitle} | Syncpack`;
   }
 
   // Map directory to sidebar label
   const categoryMap: Record<string, string> = {
-    command: "Commands",
-    "version-groups": "Version Groups",
-    "semver-groups": "Semver Groups",
-    config: "Configuration File",
-    reference: "Reference",
-    guide: "Guides",
-    status: "Status Codes",
+    command: 'Commands',
+    'version-groups': 'Version Groups',
+    'semver-groups': 'Semver Groups',
+    config: 'Configuration File',
+    reference: 'Reference',
+    guide: 'Guides',
+    status: 'Status Codes',
   };
 
-  const parts = route.id.split("/");
+  const parts = route.id.split('/');
 
   if (parts.length >= 1) {
     const category = categoryMap[parts[0]];
@@ -43,13 +40,13 @@ function getCustomTitle(route: any): string {
   return `${pageTitle} | Syncpack`;
 }
 
-export const onRequest = defineRouteMiddleware((context) => {
+export const onRequest = defineRouteMiddleware(context => {
   const route = context.locals.starlightRoute;
 
   // Update sitemap href
-  route.head.some((item) => {
-    if (item.attrs?.rel === "sitemap") {
-      item.attrs.href = "/syncpack/sitemap.xml";
+  route.head.some(item => {
+    if (item.attrs?.rel === 'sitemap') {
+      item.attrs.href = '/syncpack/sitemap.xml';
       return true;
     }
     return false;
@@ -59,11 +56,11 @@ export const onRequest = defineRouteMiddleware((context) => {
   const customTitle = getCustomTitle(route);
 
   // Remove existing title tag(s) from head
-  route.head = route.head.filter((item) => item.tag !== "title");
+  route.head = route.head.filter(item => item.tag !== 'title');
 
   // Add our custom title tag
   route.head.push({
-    tag: "title",
+    tag: 'title',
     content: customTitle,
   });
 });