bin/gen-docs - jsdoc-scribe API

Functions(19)

#printHelp

Signature

printHelp()

#parseArgs

line 91

Parameter	Type	Optional	Description
`argv`	`any`

Returns: any

Signature

parseArgs(argv: any): any

#resolveEntryPoints

line 152

Resolves a project's own entry points (bin/main/exports) from the package.json in the current working directory, if any. Used to keep findOrphanFiles from flagging a project's own public entry points.

Returns: string[] — absolute file paths, deduplicated.

Signature

resolveEntryPoints(): any

#computeQualityEmbedData

line 184

Runs code-multivitals + the import-graph analysis for embedding into the doc site. Applies baseline/snapshot side effects (these are meaningful regardless of embedded vs. standalone mode) before returning the data buildSite() needs.

Parameter	Type	Optional	Description
`files`	`string[]`
`cliArgs`	`object`

Returns: {result: object, graph: object, orphans: string[], snapshots?: object[]}

Signature

computeQualityEmbedData(files: any, cliArgs: any): any

#runQualityStandalone

line 235

Handles the standalone/export --quality-reporter modes (console, json, sarif, badge, html, dashboard) -- entirely separate from the doc-site build, same contract as the original design. Only invoked when the user explicitly passes --quality-reporter; the plain `--quality` case is handled by computeQualityEmbedData() + the normal build() call instead.

Parameter	Type	Optional	Description
`files`	`string[]`
`cliArgs`	`object`
`outDir`	`string`

Returns: boolean — true (always handles the run when called).

Signature

runQualityStandalone(files: any, cliArgs: any, outDir: any): any

#resolveTitle

line 314

Parameter	Type	Optional	Description
`titleArg`	`any`

Returns: any

Signature

resolveTitle(titleArg: any): any

#resolveVersion

line 320

Returns: any

Signature

resolveVersion(): any

#collectAllFiles

line 325

Parameter	Type	Optional	Description
`inputs`	`any`
`ignorePatterns`	`any`

Returns: any

Signature

collectAllFiles(inputs: any, ignorePatterns: any): any

#generateReadme

line 338

Parameter	Type	Optional	Description
`modules`	`any`
`projectName`	`any`
`version`	`any`
`outDir`	`any`

Returns: any

Signature

generateReadme(modules: any, projectName: any, version: any, outDir: any): any

#row

line 353

Parameter	Type	Optional	Description
`kind`	`any`
`item`	`any`
`sig`	`any`

Returns: any

Signature

row(kind: any, item: any, sig: any): any

#deriveVersionId

line 420

story-doc-version-switcher: extracts the version-id out of a `site-data-history/site-data-<id>.json` filename. Pure string-parse of the ISO-timestamp (dashes standing in for colons/dot) `writeSiteData()` (lib/site-data.js) already generates -- no new convention invented, and this never needs to change if that convention doesn't. a "-1"-style collision suffix in the rare case two writes landed in the same millisecond).

Parameter	Type	Optional	Description
`historyFilePath`	`string`		- a `site-data-history/*.json` path or bare filename.

Returns: string — the version-id (e.g. "2026-07-01T14-22-03-123Z", or with

Signature

deriveVersionId(historyFilePath: any): any

#listVersionSnapshots

line 435

story-doc-version-switcher: lists existing `site-versions/<id>/` directories, most-recent-first. Version-ids are fixed-width ISO-timestamp strings (dashes for colons/dot), so a plain reverse lexical sort is chronological too, without needing to re-parse each into a Date here -- `lib/renderer.js`'s `buildVersionSwitcher()`/`formatVersionLabel()` does that parsing purely for display, this function only enumerates ids.

Parameter	Type	Optional	Description
`outDir`	`string`

Returns: string[]

Signature

listVersionSnapshots(outDir: any): any

#renderVersionSnapshot

line 466

story-doc-version-switcher (TICKET-2): renders ONE historical `site-data-*.json` into its own `<outDir>/site-versions/<versionId>/` snapshot -- a complete, self-contained copy of the site as it looked at that generation (requirement 2/5). Reuses `writeSite()` verbatim (no new render path): `versionOpts` tells that call this is a snapshot render, not the live/main run, so it skips re-writing its own site-data.json/ history/backfill (that would recurse and pollute every historical snapshot with a nested copy of the data layer, which isn't part of "a complete copy of the site" per requirement 2's own listed contents -- index.html/modules/assets/health-detail pages, not docs.json/README/ site-data.json). `docs.json`/`README.md` are likewise switched off for snapshot renders for the same reason -- kept minimal and focused on the browsable site itself, not duplicated once per historical generation.

Parameter	Type	Description
`dataPath`	`string`	- the `site-data-*.json` file to render.
`outDir`	`string`	- the LIVE output root (site-versions/ is created under this).
`versionId`	`string`
`opts`	`object`
`versions`	`string[]`	- full version-id list (for that snapshot's own switcher).
`silent`	`boolean`

Returns: boolean — true if rendered, false if the source JSON couldn't be read.

Signature

renderVersionSnapshot(dataPath: any, outDir: any, versionId: any, opts: any, versions: any, silent: any): any

#renderMissingVersionSnapshots

line 495

story-doc-version-switcher (TICKET-3): render-only-missing backfill. `site-data-history/*.json` entries are immutable once moved there (Phase L Decision 5) -- once a version-id's snapshot exists, re-rendering it has zero correctness benefit and is pure wasted cost at realistic history depth (solutions-architect's estimate: O(1) per run after a one-time backfill, see the story's architect sign-off). `fs.existsSync` on the target directory is the entire "already rendered" check.

Parameter	Type	Optional	Description
`outDir`	`string`
`opts`	`object`
`silent`	`boolean`

Signature

renderMissingVersionSnapshots(outDir: any, opts: any, silent: any)

#writeSite

line 541

Writes the full site (+ optional docs.json / README.md / site-data.json) from an already-in-hand `modules` array. Split out from `build()` so `--from-data` (story-file-detail-redesign) can reuse this exact same write path without re-parsing source files -- `modules` there comes from a saved site-data.json instead of `extractModule()`. story-doc-version-switcher: set by `renderVersionSnapshot()` when this call is rendering ONE historical snapshot rather than the live/main site. `null`/omitted means "this is the live/main run" -- compute everything fresh below.

Parameter	Type	Description
`modules`	`object[]`
`outDir`	`string`
`projectName`	`string`
`projectVersion`	`string`
`opts`	`object`
`silent`	`boolean`
`qualityData`	`object\|null`
`versionOpts`	`{isSnapshot: boolean, currentVersionId: string, versions: string[]}\|null`	-

Returns: number — pages written.

Signature

writeSite(modules: any, outDir: any, projectName: any, projectVersion: any, opts: any, silent: any, qualityData: any, versionOpts: any): any

#build

line 629

Parameter	Type	Optional	Description
`files`	`any`
`outDir`	`any`
`projectName`	`any`
`projectVersion`	`any`
`opts`	`any`
`silent`	`any`
`qualityData`	`any`

Returns: any

Signature

build(files: any, outDir: any, projectName: any, projectVersion: any, opts: any, silent: any, qualityData: any): any

#main

line 642

Signature

main()

#stamp

line 727

Returns: any

Signature

stamp(): any

#scheduleBuild

line 738

Signature

scheduleBuild()

Variables & Constants(95)

#fs

line 4

const fs: any

const

Signature

const fs: any

#path

line 5

const path: any

const

Signature

const path: any

#{ collectFiles }

line 6

const { collectFiles }: any

const

Signature

const { collectFiles }: any

#{ extractModule }

line 7

const { extractModule }: any

const

Signature

const { extractModule }: any

#{ buildSite, moduleLabel, moduleHtmlPath }

line 8

const { buildSite, moduleLabel, moduleHtmlPath }: any

const

Signature

const { buildSite, moduleLabel, moduleHtmlPath }: any

#{ loadConfig, mergeConfig }

line 9

const { loadConfig, mergeConfig }: any

const

Signature

const { loadConfig, mergeConfig }: any

#{ buildImportGraph, findOrphanFiles }

line 10

const { buildImportGraph, findOrphanFiles }: any

const

Signature

const { buildImportGraph, findOrphanFiles }: any

#quality

line 11

const quality: any

const

Signature

const quality: any

#siteData

line 12

const siteData: any

const

Signature

const siteData: any

#pkg

line 13

const pkg: any

const

Signature

const pkg: any

#args

line 92

const args: Object

const

Signature

const args: Object

line 102

let i: number

var

Signature

let i: number

line 104

const a: any

const

Signature

const a: any

#pkgJson

line 153

let pkgJson: any

var

Signature

let pkgJson: any

#rootDir

line 159

const rootDir: any

const

Signature

const rootDir: any

#points

line 160

const points: Array

const

Signature

const points: Array

#binVal

line 162

const binVal: any

const

Signature

const binVal: any

#target

line 168

const target: any

const

Signature

const target: any

#result

line 185

let result: any

var

Signature

let result: any

#baseline

line 188

const baseline: any

const

Signature

const baseline: any

#snapPath

line 197

const snapPath: any

const

Signature

const snapPath: any

#graph

line 201

const graph: any

const

Signature

const graph: any

#orphans

line 202

const orphans: any

const

Signature

const orphans: any

#snapshots

line 210

let snapshots: any

var

Signature

let snapshots: any

#result

line 236

let result: any

var

Signature

let result: any

#baseline

line 246

let baseline: any

var

Signature

let baseline: any

#snapPath

line 264

const snapPath: any

const

Signature

const snapPath: any

#reporterName

line 268

const reporterName: any

const

Signature

const reporterName: any

#snapshots

line 271

const snapshots: any

const

Signature

const snapshots: any

#trends

line 272

const trends: any

const

Signature

const trends: any

#churnMap

line 273

const churnMap: any

const

Signature

const churnMap: any

#hotspots

line 274

const hotspots: any

const

Signature

const hotspots: any

#cm

line 275

const cm: any

const

Signature

const cm: any

#html

line 276

const html: any

const

Signature

const html: any

#outPath

line 277

const outPath: any

const

Signature

const outPath: any

#ext

line 299

const ext: any

const

Signature

const ext: any

#output

line 305

const output: any

const

Signature

const output: any

#outPath

line 306

const outPath: any

const

Signature

const outPath: any

#files

line 326

let files: Array

var

Signature

let files: Array

#md

line 339

let md: any

var

Signature

let md: any

#label

line 343

const label: any

const

Signature

const label: any

#anchor

line 344

const anchor: any

const

Signature

const anchor: any

#label

line 350

const label: any

const

Signature

const label: any

#dep

line 354

const dep: any

const

Signature

const dep: any

#snc

line 355

const snc: any

const

Signature

const snc: any

#desc

line 356

const desc: any

const

Signature

const desc: any

#ps

line 363

const ps: any

const

Signature

const ps: any

#dep

line 391

const dep: any

const

Signature

const dep: any

#dest

line 400

const dest: any

const

Signature

const dest: any

#base

line 421

const base: any

const

Signature

const base: any

#dir

line 436

const dir: any

const

Signature

const dir: any

#data

line 467

let data: any

var

Signature

let data: any

#snapshotOutDir

line 474

const snapshotOutDir: any

const

Signature

const snapshotOutDir: any

#snapshotOpts

line 475

const snapshotOpts: any

const

Signature

const snapshotOpts: any

#histDir

line 496

const histDir: any

const

Signature

const histDir: any

#versions

line 507

const versions: any

const

Signature

const versions: any

#versionId

line 515

const versionId: any

const

Signature

const versionId: any

#snapshotDir

line 516

const snapshotDir: any

const

Signature

const snapshotDir: any

#switcherVersions

line 542

let switcherVersions: Array

var

Signature

let switcherVersions: Array

#currentVersionId

line 543

let currentVersionId: any

var

Signature

let currentVersionId: any

#isSnapshot

line 544

let isSnapshot: boolean

var

Signature

let isSnapshot: boolean

#dataPath

line 574

const dataPath: any

const

Signature

const dataPath: any

#payload

line 575

const payload: any

const

Signature

const payload: any

#written

line 578

const written: any

const

Signature

const written: any

#pages

line 587

const pages: any

const

Signature

const pages: any

#dest

line 599

const dest: any

const

Signature

const dest: any

#jsonOut

line 606

const jsonOut: any

const

Signature

const jsonOut: any

#payload

line 607

const payload: Object

const

Signature

const payload: Object

#dest

line 622

const dest: any

const

Signature

const dest: any

#modules

line 630

const modules: Array

const

Signature

const modules: Array

#argv

line 643

const argv: any

const

Signature

const argv: any

#cliArgs

line 644

const cliArgs: any

const

Signature

const cliArgs: any

#fileConfig

line 656

const fileConfig: any

const

Signature

const fileConfig: any

#opts

line 657

const opts: any

const

Signature

const opts: any

#outDir

line 660

const outDir: any

const

Signature

const outDir: any

#projectName

line 661

const projectName: any

const

Signature

const projectName: any

#projectVersion

line 662

const projectVersion: any

const

Signature

const projectVersion: any

#data

line 671

let data: any

var

Signature

let data: any

#dataProjectName

line 679

const dataProjectName: any

const

Signature

const dataProjectName: any

#dataVersion

line 680

const dataVersion: any

const

Signature

const dataVersion: any

line 681

const n: any

const

Signature

const n: any

#files

line 687

const files: any

const

Signature

const files: any

#extras

line 690

const extras: any

const

Signature

const extras: any

#extraStr

line 691

const extraStr: any

const

Signature

const extraStr: any

#qualityEmbedData

line 698

let qualityEmbedData: any

var

Signature

let qualityEmbedData: any

line 716

const n: any

const

Signature

const n: any

line 719

const r: any

const

Signature

const r: any

line 733

const n: any

const

Signature

const n: any

#timer

line 737

let timer: any

var

Signature

let timer: any

#freshFiles

line 743

const freshFiles: any

const

Signature

const freshFiles: any

#freshQualityData

line 744

let freshQualityData: any

var

Signature

let freshQualityData: any

line 749

const n: any

const

Signature

const n: any

#watched

line 755

const watched: Set

const

Signature

const watched: Set

#absInput

line 758

const absInput: any

const

Signature

const absInput: any

#ext

line 763

const ext: any

const

Signature

const ext: any