fix: update tsdoc defaults and keep api docs in readmes

Author: achingbrain

src/check-project/check-monorepo-files.js

@@ -1,11 +1,27 @@
 /* eslint-disable no-console */
 
+import path from 'node:path'
+import fs from 'fs-extra'
+import {
+  ensureFileHasContents
+} from './utils.js'
+
 /**
  * @param {string} projectDir
  */
 export async function checkMonorepoFiles (projectDir) {
   console.info('Check monorepo files')
 
-  // we don't need any special files since npm has workspace support,
-  // but if we did, they'd be set up here
+  const manifest = path.join(projectDir, 'package.json')
+  const pkg = fs.readJSONSync(manifest)
+
+  await ensureFileHasContents(projectDir, 'typedoc.json', JSON.stringify({
+    $schema: 'https://typedoc.org/schema.json',
+    name: pkg.name,
+    readme: './README.md',
+    headings: {
+      readme: false,
+      document: false
+    }
+  }, null, 2))
 }

src/check-project/check-typedoc-files.js

@@ -43,6 +43,7 @@ export async function checkTypedocFiles (projectDir, isTypescriptProject) {
     })
 
   await ensureFileHasContents(projectDir, 'typedoc.json', JSON.stringify({
+    readme: 'none',
     entryPoints
   }, null, 2))
 }

src/check-project/files/.github/workflows/semantic-pull-request.yml

@@ -9,4 +9,4 @@ on:
 
 jobs:
   main:
-    uses: pl-strflt/.github/.github/workflows/reusable-semantic-pull-request.yml@v0.3
+    uses: ipdxco/unified-github-workflows/.github/workflows/reusable-semantic-pull-request.yml@v1

src/check-project/files/.github/workflows/stale.yml

@@ -3,11 +3,12 @@ name: Close and mark stale issue
 on:
   schedule:
     - cron: '0 0 * * *'
+  workflow_dispatch:
 
 permissions:
   issues: write
   pull-requests: write
 
 jobs:
   stale:
-    uses: pl-strflt/.github/.github/workflows/reusable-stale-issue.yml@v0.3
+    uses: ipdxco/unified-github-workflows/.github/workflows/reusable-stale-issue.yml@v1

src/check-project/index.js

@@ -139,13 +139,13 @@ async function processMonorepo (projectDir, manifest, branchName, repoUrl, ciFil
       continue
     }
 
-    const manifest = path.join(subProjectDir, 'package.json')
+    const subProjectManifest = path.join(subProjectDir, 'package.json')
 
-    if (!fs.existsSync(manifest)) {
+    if (!fs.existsSync(subProjectManifest)) {
       continue
     }
 
-    const pkg = fs.readJSONSync(manifest)
+    const pkg = fs.readJSONSync(subProjectManifest)
     const homePage = `${webRoot}/${subProjectDir.includes(projectDir) ? subProjectDir.substring(projectDir.length) : subProjectDir}`
 
     console.info('Found monorepo project', pkg.name)