Merge pull request #24 from HiDeoo/hd-packages

.github/workflows/integration.yml

@@ -33,7 +33,7 @@ jobs:
 
       - name: Store Playwright Version
         run: |
-          PLAYWRIGHT_VERSION=$(pnpm playwright --version | sed 's/Version //')
+          PLAYWRIGHT_VERSION=$(pnpm exec playwright --version | sed 's/Version //')
           echo "PLAYWRIGHT_VERSION=$PLAYWRIGHT_VERSION" >> $GITHUB_ENV
         working-directory: packages/starlight-typedoc
 

example/astro.config.ts

@@ -10,8 +10,8 @@ export default defineConfig({
       },
       plugins: [
         starlightTypeDoc({
-          entryPoints: ['../fixtures/src/index.ts'],
-          tsconfig: '../fixtures/tsconfig.json',
+          entryPoints: ['../fixtures/basics/src/index.ts'],
+          tsconfig: '../fixtures/basics/tsconfig.json',
           sidebar: {
             label: 'API (auto-generated)',
           },

example/astro.multiple-entrypoints.config.ts

@@ -8,13 +8,13 @@ export default defineConfig({
     starlight({
       plugins: [
         starlightTypeDoc({
-          entryPoints: ['../fixtures/src/Bar.ts', '../fixtures/src/Foo.ts'],
+          entryPoints: ['../fixtures/basics/src/Bar.ts', '../fixtures/basics/src/Foo.ts'],
           output: 'api-multiple-entrypoints',
           pagination: true,
           sidebar: {
             collapsed: true,
           },
-          tsconfig: '../fixtures/tsconfig.json',
+          tsconfig: '../fixtures/basics/tsconfig.json',
           // @ts-expect-error - Fake the `readme` option not being set to ensure that frontmatter titles are escaped properly.
           // @see https://github.com/HiDeoo/starlight-typedoc/pull/7
           typeDoc: {

example/astro.packages-entrypoints.config.ts

@@ -0,0 +1,29 @@
+import starlight from '@astrojs/starlight'
+import { defineConfig } from 'astro/config'
+import starlightTypeDoc, { typeDocSidebarGroup } from 'starlight-typedoc'
+
+export default defineConfig({
+  base: '/packages-entrypoints/',
+  integrations: [
+    starlight({
+      plugins: [
+        starlightTypeDoc({
+          entryPoints: ['../fixtures/packages/packages/*'],
+          output: 'api-packages-entrypoints',
+          tsconfig: '../fixtures/packages/tsconfig.json',
+          typeDoc: {
+            entryPointStrategy: 'packages',
+          },
+        }),
+      ],
+      sidebar: [
+        {
+          label: 'Guides',
+          items: [{ label: 'Example Guide', link: '/guides/example/' }],
+        },
+        typeDocSidebarGroup,
+      ],
+      title: 'Starlight TypeDoc Packages Entry Points Example',
+    }),
+  ],
+})

example/package.json

@@ -9,6 +9,7 @@
     "dev": "astro dev",
     "dev:single-entrypoints": "astro dev --config astro.config.ts",
     "dev:multiple-entrypoints": "astro dev --config astro.multiple-entrypoints.config.ts",
+    "dev:packages-entrypoints": "pnpm -C ../fixtures/packages run build && astro dev --config astro.packages-entrypoints.config.ts",
     "start": "astro dev",
     "build": "astro build",
     "preview": "astro preview",

example/src/content/docs/.gitignore

@@ -1,3 +1,4 @@
 # Autogenerated by https://github.com/HiDeoo/starlight-typedoc
 api/
 api-multiple-entrypoints/
+api-packages-entrypoints/

fixtures/package.json → fixtures/basics/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@starlight-typedoc/fixtures",
+  "name": "@starlight-typedoc/fixtures-basics",
   "version": "0.0.1",
   "license": "MIT",
   "description": "Starlight plugin to generate documentation from TypeScript using TypeDoc.",

fixtures/src/shared.ts → fixtures/basics/src/shared.ts

@@ -1,3 +1,5 @@
+export { doThingA as doThingARef } from './functions'
+
 /**
  * This is a string variable.
  */

fixtures/basics/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "../../tsconfig.json"
+}

fixtures/packages/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@starlight-typedoc/fixtures-packages",
+  "version": "0.0.1",
+  "license": "MIT",
+  "description": "Starlight plugin to generate documentation from TypeScript using TypeDoc.",
+  "author": "HiDeoo <[email protected]> (https://hideoo.dev)",
+  "type": "module",
+  "scripts": {
+    "build": "tsc --build"
+  },
+  "dependencies": {
+    "typescript": "5.1.6"
+  },
+  "engines": {
+    "node": ">=18.14.1"
+  },
+  "packageManager": "[email protected]",
+  "private": true,
+  "sideEffects": false,
+  "keywords": [
+    "starlight",
+    "plugin",
+    "typedoc",
+    "typescript",
+    "documentation",
+    "astro"
+  ],
+  "homepage": "https://github.com/HiDeoo/starlight-typedoc",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/HiDeoo/starlight-typedoc.git"
+  },
+  "bugs": "https://github.com/HiDeoo/starlight-typedoc/issues"
+}

fixtures/packages/packages/bar/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "bar",
+  "version": "0.0.1",
+  "license": "MIT",
+  "description": "Starlight plugin to generate documentation from TypeScript using TypeDoc.",
+  "author": "HiDeoo <[email protected]> (https://hideoo.dev)",
+  "type": "module",
+  "packageManager": "[email protected]",
+  "private": true,
+  "sideEffects": false,
+  "keywords": [
+    "starlight",
+    "plugin",
+    "typedoc",
+    "typescript",
+    "documentation",
+    "astro"
+  ],
+  "homepage": "https://github.com/HiDeoo/starlight-typedoc",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/HiDeoo/starlight-typedoc.git"
+  },
+  "bugs": "https://github.com/HiDeoo/starlight-typedoc/issues"
+}

fixtures/packages/packages/bar/src/functions.ts

@@ -0,0 +1,6 @@
+/**
+ * A function that does a bar thing.
+ */
+export function doBar() {
+  return 'doBar'
+}

fixtures/packages/packages/bar/src/index.ts

@@ -0,0 +1 @@
+export * from './functions.js'

fixtures/packages/packages/bar/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "dist"
+  },
+  "include": ["src"]
+}

fixtures/packages/packages/bar/typedoc.json

@@ -0,0 +1,3 @@
+{
+  "entryPoints": ["src/index.ts"]
+}

fixtures/packages/packages/foo/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "foo",
+  "version": "0.0.1",
+  "license": "MIT",
+  "description": "Starlight plugin to generate documentation from TypeScript using TypeDoc.",
+  "author": "HiDeoo <[email protected]> (https://hideoo.dev)",
+  "type": "module",
+  "packageManager": "[email protected]",
+  "private": true,
+  "sideEffects": false,
+  "keywords": [
+    "starlight",
+    "plugin",
+    "typedoc",
+    "typescript",
+    "documentation",
+    "astro"
+  ],
+  "homepage": "https://github.com/HiDeoo/starlight-typedoc",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/HiDeoo/starlight-typedoc.git"
+  },
+  "bugs": "https://github.com/HiDeoo/starlight-typedoc/issues"
+}

fixtures/packages/packages/foo/src/functions.ts

@@ -0,0 +1,16 @@
+/**
+ * A function that does a foo thing.
+ * @deprecated Use the new {@link doFooFaster} function instead.
+ */
+export function doFoo() {
+  return 'doFoo'
+}
+
+/**
+ * A function that does another foo thing but faster.
+ *
+ * This is a faster alternative to {@link doFoo}.
+ */
+export function doFooFaster() {
+  return 'doFoo'
+}

fixtures/packages/packages/foo/src/index.ts

@@ -0,0 +1 @@
+export * from './functions.js'

fixtures/packages/packages/foo/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "dist"
+  },
+  "include": ["src"]
+}

fixtures/packages/packages/foo/typedoc.json

@@ -0,0 +1,3 @@
+{
+  "entryPoints": ["src/index.ts"]
+}

fixtures/packages/tsconfig.base.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "composite": true,
+    "declaration": true,
+    "declarationMap": true,
+    "module": "NodeNext",
+    "strict": true
+  }
+}

fixtures/packages/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "files": [],
+  "references": [
+    {
+      "path": "./packages/bar"
+    },
+    {
+      "path": "./packages/foo"
+    }
+  ]
+}