Update to output the apiIndex to the user specified output directory

Author: wise-king-sullyman

cli/cli.ts

@@ -12,7 +12,7 @@ import { symLinkConfig } from './symLinkConfig.js'
 import { buildPropsData } from './buildPropsData.js'
 import { hasFile } from './hasFile.js'
 import { convertToMDX } from './convertToMDX.js'
-import { mkdir, copyFile } from 'fs/promises'
+import { mkdir, copyFile, readFile, writeFile } from 'fs/promises'
 import { fileExists } from './fileExists.js'
 
 const currentDir = process.cwd()
@@ -87,29 +87,52 @@ async function transformMDContentToMDX() {
   }
 }
 
-async function initializeApiIndex() {
-  const templateIndexPath = join(astroRoot, 'cli', 'templates', 'apiIndex.json')
-  const targetIndexPath = join(astroRoot, 'src', 'apiIndex.json')
+async function updateTsConfigOutputDirPath(program: Command) {
+  const { verbose } = program.opts()
+  const tsConfigPath = join(astroRoot, 'tsconfig.json')
+
+  try {
+    const tsConfigFile = await readFile(tsConfigPath, 'utf-8')
+    const tsConfig = JSON.parse(tsConfigFile)
+    const formattedOutputDir = join(absoluteOutputDir, '*')
+
+    tsConfig.compilerOptions.paths["outputDir/*"] = [formattedOutputDir]
+
+    await writeFile(tsConfigPath, JSON.stringify(tsConfig, null, 2))
+
+    if (verbose) {
+      console.log(`Updated tsconfig.json with outputDir path: ${formattedOutputDir}`)
+    }
+  } catch (e: any) {
+    console.error('Error updating tsconfig.json with outputDir path:', e)
+  }
+}
 
+async function initializeApiIndex(program: Command) {
+  const { verbose } = program.opts()
+  const templateIndexPath = join(astroRoot, 'cli', 'templates', 'apiIndex.json')
+  const targetIndexPath = join(absoluteOutputDir, 'apiIndex.json')
   const indexExists = await fileExists(targetIndexPath)
 
   // early return if the file exists from a previous build
   if (indexExists) {
-    console.log('apiIndex.json already exists, skipping initialization')
+    if (verbose) {
+      console.log('apiIndex.json already exists, skipping initialization')
+    }
     return
   }
 
   try {
     await copyFile(templateIndexPath, targetIndexPath)
-    console.log('Initialized apiIndex.json')
+    if (verbose) {
+      console.log('Initialized apiIndex.json')
+    }
   } catch (e: any) {
     console.error('Error copying apiIndex.json template:', e)
   }
 }
 
 async function buildProject(): Promise<DocsConfig | undefined> {
-  await updateContent(program)
-  await generateProps(program, true)
   if (!config) {
     console.error(
       'No config found, please run the `setup` command or manually create a pf-docs.config.mjs file',
@@ -123,13 +146,17 @@ async function buildProject(): Promise<DocsConfig | undefined> {
     )
     return config
   }
-
-  await initializeApiIndex()
+  await updateTsConfigOutputDirPath(program)
+  await updateContent(program)
+  await generateProps(program, true)
+  await initializeApiIndex(program)
   await transformMDContentToMDX()
 
-  build({
+  const docsOutputDir = join(absoluteOutputDir, 'docs')
+
+  await build({
     root: astroRoot,
-    outDir: join(absoluteOutputDir, 'docs'),
+    outDir: docsOutputDir,
   })
 
   return config
@@ -193,8 +220,9 @@ program.command('init').action(async () => {
 })
 
 program.command('start').action(async () => {
+  await updateTsConfigOutputDirPath(program)
   await updateContent(program)
-  await initializeApiIndex()
+  await initializeApiIndex(program)
 
   // if a props file hasn't been generated yet, but the consumer has propsData, it will cause a runtime error so to
   // prevent that we're just creating a props file regardless of what they say if one doesn't exist yet

jest.config.ts

@@ -16,9 +16,10 @@ const config: Config = {
   testPathIgnorePatterns: ['/node_modules/', '/__tests__/helpers/'],
   moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
   moduleNameMapper: {
+    '^outputDir/(.*)$': '<rootDir>/dist/$1',
     '\\.(css|less)$': '<rootDir>/src/__mocks__/styleMock.ts',
-    '(.+)\\.js': '$1',
     '^astro:content$': '<rootDir>/src/__mocks__/astro-content.ts',
+    '(.+)\\.js': '$1',
   },
   setupFilesAfterEnv: ['<rootDir>/test.setup.ts'],
   transformIgnorePatterns: [

src/__tests__/pages/api/__tests__/[version].test.ts

@@ -4,7 +4,7 @@ import { GET } from '../../../../pages/api/[version]'
  * Mock apiIndex.json with multiple versions (v5, v6)
  * to test section retrieval for different versions
  */
-jest.mock('../../../../apiIndex.json', () => ({
+jest.mock('outputDir/apiIndex.json', () => ({
   versions: ['v5', 'v6'],
   sections: {
     v5: ['getting-started'],

src/__tests__/pages/api/__tests__/versions.test.ts

@@ -3,7 +3,7 @@ import { GET } from '../../../../pages/api/versions'
 /**
  * Mock apiIndex.json with multiple versions
  */
-jest.mock('../../../../apiIndex.json', () => ({
+jest.mock('outputDir/apiIndex.json', () => ({
   versions: ['v5', 'v6'],
   sections: {},
   pages: {},

src/pages/api/[version].ts

@@ -1,6 +1,6 @@
 import type { APIRoute } from 'astro'
 import { createJsonResponse, createIndexKey } from '../../utils/apiHelpers'
-import { sections as sectionsData } from '../../apiIndex.json'
+import { sections as sectionsData } from 'outputDir/apiIndex.json'
 
 export const prerender = false
 

src/pages/api/[version]/[section].ts

@@ -1,6 +1,6 @@
 import type { APIRoute } from 'astro'
 import { createJsonResponse, createIndexKey } from '../../../utils/apiHelpers'
-import { pages as pagesData } from '../../../apiIndex.json'
+import { pages as pagesData } from 'outputDir/apiIndex.json'
 
 export const prerender = false
 

src/pages/api/[version]/[section]/[page].ts

@@ -1,6 +1,6 @@
 import type { APIRoute } from 'astro'
 import { createJsonResponse, createIndexKey } from '../../../../utils/apiHelpers'
-import { tabs as tabsData } from '../../../../apiIndex.json'
+import { tabs as tabsData } from 'outputDir/apiIndex.json'
 
 export const prerender = false
 

src/pages/api/openapi.json.ts

@@ -1,5 +1,5 @@
 import type { APIRoute } from 'astro'
-import index from '../../apiIndex.json'
+import index from 'outputDir/apiIndex.json'
 
 export const prerender = false
 

src/pages/api/versions.ts

@@ -1,6 +1,6 @@
 import type { APIRoute } from 'astro'
 import { createJsonResponse } from '../../utils/apiHelpers'
-import { versions as versionsData } from '../../apiIndex.json'
+import { versions as versionsData } from 'outputDir/apiIndex.json'
 
 export const prerender = false
 

src/utils/apiIndex/generate.ts

@@ -133,7 +133,7 @@ export async function generateApiIndex(): Promise<ApiIndex> {
 }
 
 /**
- * Writes API index to src/apiIndex.json
+ * Writes API index to a apiIndex.json file in the user defined output directory
  * This file is used by server-side API routes to avoid runtime getCollection() calls
  *
  * @param index - The API index structure to write