@patternfly/patternfly-doc-core 1.15.4 → 1.15.5

package/cli/cli.ts

@@ -34,6 +34,7 @@ try {
     .replace('file://', '')
 } catch (e: any) {
   if (e.code === 'ERR_MODULE_NOT_FOUND') {
+    console.log('@patternfly/patternfly-doc-core not found, using current directory as astroRoot')
     astroRoot = process.cwd()
   } else {
     console.error('Error resolving astroRoot', e)
@@ -87,29 +88,33 @@ async function transformMDContentToMDX() {
   }
 }
 
-async function initializeApiIndex() {
+async function initializeApiIndex(program: Command) {
+  const { verbose } = program.opts()
   const templateIndexPath = join(astroRoot, 'cli', 'templates', 'apiIndex.json')
-  const targetIndexPath = join(astroRoot, 'src', '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)
+async function buildProject(program: Command): Promise<DocsConfig | undefined> {
+  const { verbose } = program.opts()
+
   if (!config) {
     console.error(
       'No config found, please run the `setup` command or manually create a pf-docs.config.mjs file',
@@ -123,44 +128,57 @@ async function buildProject(): Promise<DocsConfig | undefined> {
     )
     return config
   }
-
-  await initializeApiIndex()
+  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,
   })
 
+  // copy the apiIndex.json file to the docs directory so it can be served as a static asset
+  try {
+    const apiIndexPath = join(absoluteOutputDir, 'apiIndex.json')
+    const docsApiIndexPath = join(absoluteOutputDir, 'docs', 'apiIndex.json')
+    await copyFile(apiIndexPath, docsApiIndexPath)
+
+    if (verbose) {
+      console.log('Copied apiIndex.json to docs directory')
+    }
+  } catch (error) {
+    console.error('Failed to copy apiIndex.json to docs directory:', error)
+    throw error
+  }
+
   return config
 }
 
-async function deploy() {
-  const { verbose } = program.opts()
+async function deploy(program: Command) {
+  const { verbose, dryRun } = program.opts()
 
   if (verbose) {
     console.log('Starting Cloudflare deployment...')
   }
 
+  if (dryRun) {
+    console.log('Dry run mode enabled, skipping deployment')
+    return
+  }
+
   try {
-    // First build the project
-    const config = await buildProject()
-    if (config) {
-      if (verbose) {
-        console.log('Build complete, deploying to Cloudflare...')
-      }
-
-      // Deploy using Wrangler
-      const { execSync } = await import('child_process')
-      const outputPath = join(absoluteOutputDir, 'docs')
-
-      execSync(`npx wrangler pages deploy ${outputPath}`, {
-        stdio: 'inherit',
-        cwd: currentDir,
-      })
-
-      console.log('Successfully deployed to Cloudflare Pages!')
-    }
+    // Deploy using Wrangler
+    const { execSync } = await import('child_process')
+
+    execSync(`wrangler pages deploy`, {
+      stdio: 'inherit',
+      cwd: currentDir,
+    })
+
+    console.log('Successfully deployed to Cloudflare Pages!')
   } catch (error) {
     console.error('Deployment failed:', error)
     process.exit(1)
@@ -172,6 +190,7 @@ program.name('pf-doc-core')
 
 program.option('--verbose', 'verbose mode', false)
 program.option('--props', 'generate props data', false)
+program.option('--dry-run', 'dry run mode', false)
 
 program.command('setup').action(async () => {
   await Promise.all([
@@ -194,7 +213,7 @@ program.command('init').action(async () => {
 
 program.command('start').action(async () => {
   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
@@ -204,7 +223,7 @@ program.command('start').action(async () => {
 })
 
 program.command('build').action(async () => {
-  await buildProject()
+  await buildProject(program)
 })
 
 program.command('generate-props').action(async () => {
@@ -229,7 +248,7 @@ program
   })
 
 program.command('deploy').action(async () => {
-  await deploy()
+  await deploy(program)
 })
 
 program.parse(process.argv)

package/{src → dist}/apiIndex.json

@@ -101,6 +101,11 @@
       "truncate",
       "wizard"
     ],
+    "v6::patterns": [
+      "card-view",
+      "dashboard",
+      "primary-detail"
+    ],
     "v6::layouts": [
       "bullseye",
       "flex",
@@ -110,11 +115,6 @@
       "split",
       "stack"
     ],
-    "v6::patterns": [
-      "card-view",
-      "dashboard",
-      "primary-detail"
-    ],
     "v6::utility-classes": [
       "accessibility",
       "alignment",
@@ -145,10 +145,6 @@
       "react",
       "html"
     ],
-    "v6::components::avatar": [
-      "react",
-      "html"
-    ],
     "v6::components::alert": [
       "react",
       "html",
@@ -176,14 +172,13 @@
       "html",
       "html-demos"
     ],
-    "v6::components::brand": [
+    "v6::components::avatar": [
       "react",
       "html"
     ],
-    "v6::components::button": [
+    "v6::components::brand": [
       "react",
-      "html",
-      "html-demos"
+      "html"
     ],
     "v6::components::breadcrumb": [
       "react",
@@ -193,12 +188,16 @@
       "react",
       "html"
     ],
-    "v6::components::card": [
+    "v6::components::checkbox": [
+      "react",
+      "html"
+    ],
+    "v6::components::button": [
       "react",
       "html",
       "html-demos"
     ],
-    "v6::components::checkbox": [
+    "v6::components::code-block": [
       "react",
       "html"
     ],
@@ -206,9 +205,10 @@
       "react",
       "html"
     ],
-    "v6::components::code-block": [
+    "v6::components::card": [
       "react",
-      "html"
+      "html",
+      "html-demos"
     ],
     "v6::components::content": [
       "react",
@@ -219,15 +219,15 @@
       "html",
       "html-demos"
     ],
-    "v6::components::date-picker": [
-      "react",
-      "html"
-    ],
     "v6::components::description-list": [
       "react",
       "html",
       "html-demos"
     ],
+    "v6::components::date-picker": [
+      "react",
+      "html"
+    ],
     "v6::components::divider": [
       "react",
       "html"
@@ -245,10 +245,6 @@
       "react-deprecated",
       "html"
     ],
-    "v6::components::expandable-section": [
-      "react",
-      "html"
-    ],
     "v6::components::empty-state": [
       "react",
       "html"
@@ -257,22 +253,22 @@
       "react",
       "html"
     ],
-    "v6::components::form": [
+    "v6::components::expandable-section": [
       "react",
-      "html",
-      "html-demos"
+      "html"
     ],
     "v6::components::form-select": [
       "react"
     ],
-    "v6::components::helper-text": [
+    "v6::components::form": [
       "react",
       "html",
       "html-demos"
     ],
-    "v6::components::hint": [
+    "v6::components::helper-text": [
       "react",
-      "html"
+      "html",
+      "html-demos"
     ],
     "v6::components::icon": [
       "react",
@@ -287,6 +283,10 @@
       "html",
       "html-demos"
     ],
+    "v6::components::hint": [
+      "react",
+      "html"
+    ],
     "v6::components::label": [
       "react",
       "html"
@@ -304,11 +304,11 @@
       "html",
       "html-demos"
     ],
-    "v6::components::menu-toggle": [
+    "v6::components::menu": [
       "react",
       "html"
     ],
-    "v6::components::menu": [
+    "v6::components::menu-toggle": [
       "react",
       "html"
     ],
@@ -322,6 +322,11 @@
       "react",
       "html"
     ],
+    "v6::components::navigation": [
+      "react",
+      "html",
+      "html-demos"
+    ],
     "v6::components::notification-badge": [
       "react"
     ],
@@ -334,10 +339,9 @@
       "html",
       "html-demos"
     ],
-    "v6::components::navigation": [
+    "v6::components::pagination": [
       "react",
-      "html",
-      "html-demos"
+      "html"
     ],
     "v6::components::overflow-menu": [
       "react",
@@ -348,28 +352,24 @@
       "html",
       "html-demos"
     ],
-    "v6::components::pagination": [
-      "react",
-      "html"
-    ],
     "v6::components::panel": [
       "react",
       "html",
       "html-demos"
     ],
-    "v6::components::popover": [
+    "v6::components::progress": [
       "react",
       "html"
     ],
-    "v6::components::progress-stepper": [
+    "v6::components::popover": [
       "react",
       "html"
     ],
-    "v6::components::radio": [
+    "v6::components::progress-stepper": [
       "react",
       "html"
     ],
-    "v6::components::progress": [
+    "v6::components::radio": [
       "react",
       "html"
     ],
@@ -383,10 +383,6 @@
       "react",
       "html"
     ],
-    "v6::components::simple-list": [
-      "react",
-      "html"
-    ],
     "v6::components::skeleton": [
       "react",
       "html",
@@ -396,40 +392,44 @@
       "react",
       "html"
     ],
-    "v6::components::slider": [
+    "v6::components::simple-list": [
       "react",
       "html"
     ],
-    "v6::components::switch": [
+    "v6::components::spinner": [
       "react",
       "html"
     ],
-    "v6::components::spinner": [
+    "v6::components::slider": [
+      "react",
+      "html"
+    ],
+    "v6::components::switch": [
       "react",
       "html"
     ],
     "v6::components::text-area": [
       "react"
     ],
+    "v6::components::text-input": [
+      "react"
+    ],
     "v6::components::tabs": [
       "react",
       "html",
       "html-demos"
     ],
-    "v6::components::text-input": [
-      "react"
-    ],
     "v6::components::text-input-group": [
       "react",
       "html"
     ],
-    "v6::components::time-picker": [
-      "react"
-    ],
     "v6::components::timestamp": [
       "react",
       "html"
     ],
+    "v6::components::time-picker": [
+      "react"
+    ],
     "v6::components::title": [
       "react",
       "html"
@@ -461,54 +461,64 @@
       "html",
       "html-demos"
     ],
-    "v6::components::chip": [
-      "react-deprecated"
-    ],
     "v6::components::drag-and-drop": [
       "react-deprecated",
       "html"
     ],
+    "v6::components::chip": [
+      "react-deprecated"
+    ],
     "v6::components::tile": [
       "react-deprecated",
       "html-deprecated"
     ],
-    "v6::layouts::bullseye": [
-      "html"
+    "v6::patterns::card-view": [
+      "html-demos"
     ],
-    "v6::layouts::gallery": [
-      "html"
+    "v6::patterns::dashboard": [
+      "html-demos"
     ],
-    "v6::layouts::level": [
-      "html"
+    "v6::components::password-generator": [
+      "html-demos"
     ],
-    "v6::layouts::grid": [
-      "html"
+    "v6::components::password-strength": [
+      "html-demos"
     ],
-    "v6::layouts::split": [
+    "v6::patterns::primary-detail": [
+      "html-demos"
+    ],
+    "v6::components::table": [
+      "html",
+      "html-demos"
+    ],
+    "v6::components::code-editor": [
       "html"
     ],
-    "v6::layouts::stack": [
+    "v6::components::form-control": [
       "html"
     ],
-    "v6::patterns::card-view": [
-      "html-demos"
+    "v6::components::inline-edit": [
+      "html"
     ],
-    "v6::patterns::dashboard": [
-      "html-demos"
+    "v6::layouts::bullseye": [
+      "html"
     ],
     "v6::layouts::flex": [
       "html"
     ],
-    "v6::components::password-generator": [
-      "html-demos"
+    "v6::layouts::gallery": [
+      "html"
     ],
-    "v6::components::password-strength": [
-      "html-demos"
+    "v6::layouts::level": [
+      "html"
     ],
-    "v6::patterns::primary-detail": [
-      "html-demos"
+    "v6::layouts::grid": [
+      "html"
     ],
-    "v6::utility-classes::accessibility": [
+    "v6::layouts::stack": [
+      "html"
+    ],
+    "v6::layouts::split": [
       "html"
     ],
     "v6::utility-classes::alignment": [
@@ -517,16 +527,15 @@
     "v6::utility-classes::background-color": [
       "html"
     ],
+    "v6::utility-classes::accessibility": [
+      "html"
+    ],
     "v6::utility-classes::box-shadow": [
       "html"
     ],
     "v6::utility-classes::display": [
       "html"
     ],
-    "v6::components::table": [
-      "html",
-      "html-demos"
-    ],
     "v6::utility-classes::flex": [
       "html"
     ],
@@ -542,15 +551,6 @@
     "v6::utility-classes::text": [
       "html"
     ],
-    "v6::components::code-editor": [
-      "html"
-    ],
-    "v6::components::form-control": [
-      "html"
-    ],
-    "v6::components::inline-edit": [
-      "html"
-    ],
     "v6::extensions::quick-starts": [
       "about",
       "Basic-quick-starts",