feat: move typedoc documentation template away from common setup (#232)

.github/workflows/reusable-release.yml

@@ -93,7 +93,7 @@ jobs:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
 
-    if: ${{ inputs.publish_docs == 'true' && (github.ref == 'refs/heads/next' || github.ref == 'refs/heads/main') }}
+    if: ${{ inputs.publish_docs == 'true' && contains(fromJSON(inputs.package_json).scripts, 'build:docs') && (github.ref == 'refs/heads/next' || github.ref == 'refs/heads/main') }}
     steps:
       - uses: actions/checkout@v4
       - name: Create semantic-release cache file

examples/yargs-cli/package.json

@@ -20,7 +20,6 @@
   "files": ["bin", ".dist", "package.json"],
   "scripts": {
     "build": "tsc -p tsconfig.dist.json",
-    "build:docs": "npx typedoc",
     "check:coverage": "vitest run --coverage=true",
     "check:project": "node-standards lint",
     "check:types": "tsc -p tsconfig.json",

package.json

@@ -26,7 +26,6 @@
   "scripts": {
     "build": "tsc -p tsconfig.dist.json",
     "prebuild:docs": "npm ci",
-    "build:docs": "npx typedoc",
     "check:coverage": "vitest run --coverage=true",
     "check:project": "node-standards lint",
     "check:types": "tsc -p tsconfig.json",

src/lib/templates/common.ts

@@ -24,7 +24,7 @@ export const CommonTypescriptTemplate: ProjectTemplateBuilder = {
             build: 'tsc -p tsconfig.dist.json',
             'build:clean': undefined,
             'prebuild:docs': 'npm ci',
-            'build:docs': 'npx typedoc',
+            'build:docs': undefined,
             'check:cost': undefined,
             'check:coverage': 'vitest run --coverage=true',
             'check:full': undefined,

src/lib/templates/index.ts

@@ -2,4 +2,5 @@ export { CommonTemplate } from './common.js'
 export { LibraryTemplate } from './library.js'
 export { YargsCliTemplate } from './yargs-cli.js'
 export { DocusaurusTemplate } from './docusaurus.js'
+export { TypedocTemplate } from './typedoc.js'
 export type { ProjectTemplateBuilder, ProjectTemplate } from './types.js'

src/lib/templates/typedoc.ts

@@ -0,0 +1,14 @@
+import type { ProjectTemplate } from './types.js'
+
+import { repositoryUrl, rootDirectory } from '../constants.js'
+
+export const TypedocTemplate: ProjectTemplate = {
+    type: 'typedoc',
+    template: {
+        repositoryUrl,
+        scripts: {
+            'build:docs': 'npx typedoc',
+        },
+        roots: [rootDirectory],
+    },
+}

templates/common-typescript/-typedoc.cjs

@@ -0,0 +1 @@
+// moved to own template