Add support for Astro 5 (#58)

.changeset/mighty-horses-beam.md

@@ -0,0 +1,9 @@
+---
+'starlight-openapi': minor
+---
+
+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.

.node-version

@@ -1 +1 @@
-v18.14.1
+v18.17.1

.vscode/settings.json

@@ -1,5 +1,5 @@
 {
-  "eslint.experimental.useFlatConfig": true,
+  "eslint.useFlatConfig": true,
   "eslint.validate": [
     "javascript",
     "javascriptreact",

docs/package.json

@@ -11,18 +11,17 @@
     "build": "astro build",
     "preview": "astro preview",
     "astro": "astro",
-    "lint": "eslint . --cache --max-warnings=0",
-    "format": "prettier -w --cache --ignore-unknown ."
+    "lint": "eslint . --cache --max-warnings=0"
   },
   "dependencies": {
-    "@astrojs/starlight": "0.26.0",
-    "@hideoo/starlight-plugins-docs-components": "^0.2.2",
-    "astro": "4.11.1",
-    "sharp": "0.32.6",
+    "@astrojs/starlight": "^0.30.2",
+    "@hideoo/starlight-plugins-docs-components": "^0.3.0",
+    "astro": "^5.0.9",
+    "sharp": "^0.33.5",
     "starlight-openapi": "workspace:*"
   },
   "engines": {
-    "node": ">=18.14.1"
+    "node": ">=18.17.1"
   },
   "packageManager": "[email protected]",
   "private": true,
@@ -38,7 +37,8 @@
   "homepage": "https://github.com/HiDeoo/starlight-openapi",
   "repository": {
     "type": "git",
-    "url": "https://github.com/HiDeoo/starlight-openapi.git"
+    "url": "https://github.com/HiDeoo/starlight-openapi.git",
+    "directory": "docs"
   },
   "bugs": "https://github.com/HiDeoo/starlight-openapi/issues"
 }

docs/src/content.config.ts

@@ -0,0 +1,7 @@
+import { docsLoader } from '@astrojs/starlight/loaders'
+import { docsSchema } from '@astrojs/starlight/schema'
+import { defineCollection } from 'astro:content'
+
+export const collections = {
+  docs: defineCollection({ loader: docsLoader(), schema: docsSchema() }),
+}

docs/src/content/docs/index.mdx

@@ -17,7 +17,7 @@ hero:
       icon: rocket
     - text: Demo
       link: /api/petstore/operations/addpet/
-      icon: external
+      icon: right-arrow
       variant: minimal
 ---
 

package.json

@@ -7,24 +7,25 @@
   "type": "module",
   "scripts": {
     "test": "pnpm --stream -r test",
-    "lint": "pnpm -r lint",
-    "format": "pnpm -r format",
+    "lint": "astro check --noSync && pnpm -r lint",
+    "format": "prettier -w --cache --ignore-unknown .",
     "version": "pnpm changeset version && pnpm i --no-frozen-lockfile"
   },
   "devDependencies": {
-    "@changesets/changelog-github": "0.5.0",
-    "@changesets/cli": "2.27.10",
-    "@hideoo/eslint-config": "3.0.0",
-    "@hideoo/prettier-config": "2.0.0",
-    "@hideoo/tsconfig": "2.0.1",
-    "astro": "4.11.1",
-    "eslint": "8.56.0",
-    "prettier": "3.0.3",
-    "prettier-plugin-astro": "0.12.0",
-    "typescript": "5.1.6"
+    "@astrojs/check": "^0.9.4",
+    "@changesets/changelog-github": "^0.5.0",
+    "@changesets/cli": "^2.27.10",
+    "@hideoo/eslint-config": "^4.0.0",
+    "@hideoo/prettier-config": "^2.0.0",
+    "@hideoo/tsconfig": "^2.0.1",
+    "astro": "^5.0.9",
+    "eslint": "^9.17.0",
+    "prettier": "^3.4.2",
+    "prettier-plugin-astro": "^0.14.1",
+    "typescript": "^5.7.2"
   },
   "engines": {
-    "node": ">=18.14.1"
+    "node": ">=18.17.1"
   },
   "packageManager": "[email protected]",
   "private": true,

packages/starlight-openapi/components/Items.astro

@@ -1,6 +1,6 @@
 ---
 import { getBound, getType, type Items } from '../libs/items'
-import { isSchemaObjectObject } from '../libs/schemaObject'
+import { isSchemaObjectObject, type SchemaObject as SchemaObjectType } from '../libs/schemaObject'
 
 import SchemaObject from './schema/SchemaObject.astro'
 import Tag from './Tag.astro'
@@ -11,7 +11,7 @@ interface Props {
   items: Items
   negated?: boolean | undefined
   nullable?: boolean | undefined
-  parents?: SchemaObject[]
+  parents?: SchemaObjectType[]
 }
 
 const { hideExample, items, negated, nullable, parents = [] } = Astro.props
@@ -47,7 +47,11 @@ const enumItems = items.enum ?? items.items?.enum
 />
 
 {enumItems && <Tags label="Allowed values:" tags={enumItems} />}
-{items.items && isSchemaObjectObject(items.items) && <SchemaObject {parents} nested schemaObject={items.items} {hideExample} />}
+{
+  items.items && isSchemaObjectObject(items.items) && (
+    <SchemaObject {parents} nested schemaObject={items.items} {hideExample} />
+  )
+}
 
 <style>
   .type {

packages/starlight-openapi/components/schema/SchemaObject.astro

@@ -2,6 +2,7 @@
 import {
   getNullable,
   getSchemaObjects,
+  isSchemaObject,
   isSchemaObjectAllOf,
   isSchemaObjectObject,
   type SchemaObject,
@@ -28,13 +29,12 @@ const { hideExample = false, negated, nested = false, parents = [], schemaObject
 const schemaObjects = getSchemaObjects(schemaObject)
 
 const hasMany = schemaObjects !== undefined
-const isNegated = schemaObject.not !== undefined
 ---
 
 {
   hasMany ? (
     <SchemaObjects {parents} discriminator={schemaObject.discriminator} {nested} {schemaObjects} />
-  ) : isNegated ? (
+  ) : isSchemaObject(schemaObject.not) ? (
     <Astro.self negated schemaObject={schemaObject.not} />
   ) : (
     <>

packages/starlight-openapi/components/schema/SchemaObjects.astro

@@ -2,15 +2,15 @@
 import { Tabs, TabItem } from '@astrojs/starlight/components'
 
 import { getType } from '../../libs/items'
-import type { Discriminator, SchemaObjects } from '../../libs/schemaObject'
+import type { Discriminator, SchemaObjects, SchemaObject as SchemaObjectType } from '../../libs/schemaObject'
 import Tag from '../Tag.astro'
 
 import SchemaObject from './SchemaObject.astro'
 
 interface Props {
   discriminator: Discriminator
   nested: boolean
-  parents?: SchemaObject[]
+  parents?: SchemaObjectType[]
   schemaObjects: SchemaObjects
 }
 
@@ -25,8 +25,8 @@ const discriminatorPropertyName =
   typeof discriminator === 'string'
     ? discriminator
     : typeof discriminator === 'object'
-    ? discriminator.propertyName
-    : undefined
+      ? discriminator.propertyName
+      : undefined
 
 const humanReadableType: Record<SchemaObjects['type'], string> = {
   anyOf: 'Any of',

packages/starlight-openapi/libs/operation.ts

@@ -17,7 +17,7 @@ export function getOperationsByTag(document: Schema['document']) {
     }
 
     const allOperationIds = operationHttpMethods.map((method) => {
-      return isPathItemOperation(pathItem, method) ? pathItem[method].operationId ?? pathItemPath : undefined
+      return isPathItemOperation(pathItem, method) ? (pathItem[method].operationId ?? pathItemPath) : undefined
     })
 
     for (const [index, method] of operationHttpMethods.entries()) {
@@ -106,7 +106,7 @@ export function getWebhooksOperations(document: Schema['document']): PathItemOpe
 export function isPathItemOperation<TMethod extends OperationHttpMethod>(
   pathItem: PathItem,
   method: TMethod,
-): pathItem is { [key in TMethod]: Operation } {
+): pathItem is Record<TMethod, Operation> {
   return method in pathItem
 }
 
@@ -126,10 +126,10 @@ export function getOperationURLs(document: Document, { operation, path, pathItem
       'servers' in operation
         ? operation.servers
         : 'servers' in pathItem
-        ? pathItem.servers
-        : 'servers' in document
-        ? document.servers
-        : []
+          ? pathItem.servers
+          : 'servers' in document
+            ? document.servers
+            : []
 
     for (const server of servers) {
       let url = server.url

packages/starlight-openapi/package.json

@@ -12,27 +12,23 @@
   },
   "scripts": {
     "test": "playwright install --with-deps chromium && playwright test",
-    "lint": "eslint . --cache --max-warnings=0",
-    "format": "prettier -w --cache --ignore-unknown ."
+    "lint": "eslint . --cache --max-warnings=0"
   },
   "dependencies": {
-    "@readme/openapi-parser": "2.5.0",
-    "github-slugger": "2.0.0"
+    "@readme/openapi-parser": "^2.5.0",
+    "github-slugger": "^2.0.0"
   },
   "devDependencies": {
-    "@astrojs/starlight": "0.26.0",
-    "@playwright/test": "1.36.2",
-    "@types/node": "18.17.3",
-    "astro": "4.11.1",
-    "openapi-types": "12.1.3"
+    "@playwright/test": "^1.49.1",
+    "@types/node": "^18.19.68",
+    "openapi-types": "^12.1.3"
   },
   "peerDependencies": {
-    "@astrojs/markdown-remark": ">=4.2.0",
-    "@astrojs/starlight": ">=0.26.0",
-    "astro": ">=4.8.6"
+    "@astrojs/markdown-remark": ">=6.0.0",
+    "@astrojs/starlight": ">=0.30.0"
   },
   "engines": {
-    "node": ">=18.14.1"
+    "node": ">=18.17.1"
   },
   "packageManager": "[email protected]",
   "publishConfig": {
@@ -51,7 +47,8 @@
   "homepage": "https://github.com/HiDeoo/starlight-openapi",
   "repository": {
     "type": "git",
-    "url": "https://github.com/HiDeoo/starlight-openapi.git"
+    "url": "https://github.com/HiDeoo/starlight-openapi.git",
+    "directory": "packages/starlight-openapi"
   },
   "bugs": "https://github.com/HiDeoo/starlight-openapi/issues"
 }

packages/starlight-openapi/playwright.config.ts

@@ -13,7 +13,7 @@ export default defineConfig({
   },
   webServer: [
     {
-      command: 'pnpm run dev',
+      command: 'pnpm build && pnpm preview',
       cwd: '../../docs',
       reuseExistingServer: !process.env['CI'],
       url: 'http://localhost:4321',

packages/starlight-openapi/tests/fixtures/DocPage.ts

@@ -31,7 +31,7 @@ export class DocPage {
   }
 
   getParameters(location: string) {
-    return this.page.locator(`h3:text-is("${`${capitalize(location)} Parameters`}") + div > div`)
+    return this.page.locator(`h3:text-is("${capitalize(location)} Parameters") + div > div`)
   }
 
   getRequestBody() {