@coreui/astro-docs-api-generator 0.1.0-beta.0 → 0.1.0-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coreui/astro-docs-api-generator",
-  "version": "0.1.0-beta.0",
+  "version": "0.1.0-beta.1",
   "description": "API documentation JSON generator for @coreui/astro-docs (React + Vue), emitting a consistent ApiData shape.",
   "type": "module",
   "license": "MIT",
@@ -29,6 +29,7 @@
   },
   "exports": {
     ".": "./src/cli.mjs",
+    "./config": "./src/config.mjs",
     "./react": "./src/react.mjs",
     "./vue": "./src/vue.mjs"
   },

package/src/config.mjs

@@ -0,0 +1,52 @@
+// Helper for a docs project's `api.config.mjs`. Each framework's config used to repeat
+// the same source scan (`isComponent` + recursive `scan`) and only differed in the file
+// pattern and the component roots — this centralizes that. The consumer passes its own
+// `configUrl` (`import.meta.url`) so roots and the emitted component paths resolve
+// relative to the config file, exactly as the CLI's `run()` expects (it resolves each
+// `rel` against the config's directory).
+import { readdirSync } from 'node:fs'
+import { join, dirname, basename, relative } from 'node:path'
+import { fileURLToPath } from 'node:url'
+
+// Per-framework: file extension + which filenames count as a documentable component.
+// React mirrors the source convention (`C*.tsx`, minus declarations/specs/tests); Vue
+// mirrors the VuePress docgen glob (`[A-Z]*.ts`, minus declarations/specs/ComponentProps).
+const FRAMEWORKS = {
+  react: {
+    ext: '.tsx',
+    isComponent: (name) => /^C[A-Z].*\.tsx$/.test(name) && !/\.(d|spec|test)\.tsx$/.test(name),
+  },
+  vue: {
+    ext: '.ts',
+    isComponent: (name) =>
+      /^[A-Z].*\.ts$/.test(name) && !/\.(d|spec)\.ts$/.test(name) && name !== 'ComponentProps.ts',
+  },
+}
+
+export function createApiConfig({ framework, configUrl, roots, importPackage, outDir = 'src/api', importSrcBase }) {
+  const fw = FRAMEWORKS[framework]
+  if (!fw) throw new Error(`createApiConfig: unknown framework '${framework}' (expected 'react' or 'vue')`)
+
+  const here = dirname(fileURLToPath(configUrl))
+
+  const scan = (dir, out) => {
+    let entries
+    try {
+      entries = readdirSync(dir, { withFileTypes: true })
+    } catch {
+      return out
+    }
+    for (const e of entries) {
+      if (e.name === '__tests__' || e.name.startsWith('.')) continue
+      const p = join(dir, e.name)
+      if (e.isDirectory()) scan(p, out)
+      else if (fw.isComponent(e.name)) out[basename(e.name, fw.ext)] = `./${relative(here, p)}`
+    }
+    return out
+  }
+
+  const components = {}
+  for (const root of roots) scan(join(here, root), components)
+
+  return { framework, outDir, importPackage, importSrcBase, components }
+}