move to a peer dep and hide the command

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

package.json

@@ -134,6 +134,7 @@
     "shx": "^0.3.2",
     "sloc": "^0.3.1",
     "sort-package-json": "^2.8.0",
+    "typedoc": "^0.27.6",
     "typescript": "~5.2.0"
   },
   "packageManager": "yarn@3.8.1",

packages/repo-tools/package.json

@@ -81,7 +81,6 @@
     "portfinder": "^1.0.32",
     "tar": "^6.1.12",
     "ts-morph": "^24.0.0",
-    "typedoc": "^0.27.6",
     "yaml-diff-patch": "^2.0.0"
   },
   "devDependencies": {
@@ -90,7 +89,8 @@
     "@backstage/types": "workspace:^",
     "@types/is-glob": "^4.0.2",
     "@types/node": "^20.16.0",
-    "@types/prettier": "^2.0.0"
+    "@types/prettier": "^2.0.0",
+    "typedoc": "^0.27.6"
   },
   "peerDependencies": {
     "@microsoft/api-extractor-model": "*",
@@ -98,11 +98,15 @@
     "@microsoft/tsdoc-config": "*",
     "@useoptic/optic": "^1.0.0",
     "prettier": "^2.8.1",
+    "typedoc": "^0.27.0",
     "typescript": "> 3.0.0"
   },
   "peerDependenciesMeta": {
     "prettier": {
       "optional": true
+    },
+    "typedoc": {
+      "optional": true
     }
   }
 }

packages/repo-tools/src/commands/index.ts

@@ -263,7 +263,8 @@ export function registerCommands(program: Command) {
     );
 
   program
-    .command('package-docs [paths...]')
+    .command('package-docs [paths...]', { hidden: true })
+    .description('EXPERIMENTAL: Generate package documentation')
     .action(lazy(() => import('./package-docs/command'), 'default'));
 
   registerPackageCommand(program);

packages/repo-tools/src/commands/package-docs/command.ts

@@ -71,7 +71,10 @@ async function generateDocJson(pkg: string) {
   );
 
   const exports = getExports(packageJson);
-  if (!exports.length || !exports.some(e => e.startsWith('src'))) {
+  if (
+    !exports.length ||
+    !exports.some(e => e.startsWith('src') || e.startsWith('./src'))
+  ) {
     return;
   }
 
@@ -110,6 +113,7 @@ async function generateDocJson(pkg: string) {
 }
 
 export default async function packageDocs(paths: string[] = [], opts: any) {
+  console.warn('!!! This is an experimental command !!!');
   const selectedPackageDirs = await resolvePackagePaths({
     paths,
     include: opts.include,

yarn.lock

@@ -8733,10 +8733,13 @@ __metadata:
     "@microsoft/tsdoc-config": "*"
     "@useoptic/optic": ^1.0.0
     prettier: ^2.8.1
+    typedoc: ^0.27.0
     typescript: "> 3.0.0"
   peerDependenciesMeta:
     prettier:
       optional: true
+    typedoc:
+      optional: true
   bin:
     backstage-repo-tools: bin/backstage-repo-tools
   languageName: unknown
@@ -42812,6 +42815,7 @@ __metadata:
     shx: ^0.3.2
     sloc: ^0.3.1
     sort-package-json: ^2.8.0
+    typedoc: ^0.27.6
     typescript: ~5.2.0
   languageName: unknown
   linkType: soft