@xpack/doxygen2docusaurus 2.0.0 → 2.2.0

package/package.json

@@ -1,54 +1,27 @@
 {
   "name": "@xpack/doxygen2docusaurus",
-  "version": "2.0.0",
+  "version": "2.2.0",
   "description": "A Node.js CLI application to convert Doxygen XML files into Docusaurus documentation",
   "type": "module",
   "main": "./dist/index.js",
-  "typings": "./dist/doxygen2docusaurus.d.ts",
+  "typings": "./dist/index.d.ts",
   "bin": {
     "doxygen2docusaurus": "./bin/doxygen2docusaurus.js"
   },
   "files": [
     "dist/",
+    "src/",
     "templates/"
   ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/xpack/doxygen2docusaurus-cli-ts.git"
+  },
   "keywords": [
     "docusaurus",
     "doxygen",
     "cli"
   ],
-  "scripts": {
-    "generate-top-commons": "bash node_modules/@xpack/npm-packages-helper/maintenance-scripts/generate-top-commons.sh --xpack",
-    "api-extractor": "api-extractor run --local --verbose",
-    "prepare": "del-cli dist && npm run prettier && npm run lint && npm run compile && npm run api-extractor",
-    "compile-watch": "tsc --build --verbose --watch src",
-    "compile": "tsc --build --verbose src",
-    "prettier": "prettier src --write",
-    "fix": "eslint --fix src",
-    "dev-cycle": "npm run fix && npm run compile && npm run test",
-    "npm-install": "npm install",
-    "npm-link-helpers": "npm link @xpack/npm-packages-helper @xpack/docusaurus-template-liquid",
-    "npm-link": "npm link",
-    "npm-outdated": "npm outdated",
-    "npm-update": "npm update",
-    "npm-pack": "npm pack",
-    "npm-version-patch": "npm version patch",
-    "npm-version-minor": "npm version minor",
-    "postversion": "git push origin --all && git push origin --tags",
-    "git-log": "git log --pretty='%cd * %h %s' --date=short",
-    "lint": "eslint src",
-    "test": "echo 'No tests defined'",
-    "prepublishOnly": "npm run lint && npm run test",
-    "postpublish": "git push origin --follow-tags",
-    "clean": "del-cli dist cjs 'tests/**/cjs' 'src/**/*.d.ts' 'src/**/*.d.ts.map' 'src/**/*.js' 'src/**/*.js.map' 'tests/**/*.d.ts' 'tests/**/*.d.ts.map' 'tests/**/*.js' 'tests/**/*.js.map' '**/tsconfig.tsbuildinfo' .nyc_output coverage",
-    "deep-clean": "npm run clean && rm -rf node_modules package-lock.json",
-    "dumpconf": "env | sort | uniq",
-    "show-versions": "echo $(which node) $(node --version) && echo $(which npm) $(npm --version)"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/xpack/doxygen2docusaurus-cli-ts.git"
-  },
   "author": {
     "name": "Liviu Ionescu",
     "email": "ilg@livius.net",
@@ -60,25 +33,54 @@
   },
   "homepage": "https://xpack.github.io/doxygen2docusaurus/",
   "homepagePreview": "https://xpack.github.io/doxygen2docusaurus-cli-ts/",
+  "$dependenciesUrls": {
+    "@tsconfig/node20": "https://www.npmjs.com/package/@tsconfig/node20"
+  },
   "dependencies": {
-    "commander": "^14.0.0",
-    "fast-xml-parser": "^5.2.5"
+    "commander": "^14.0.3",
+    "fast-xml-parser": "^5.7.3"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.52.8",
-    "@tsconfig/node20": "^20.1.6",
-    "@types/node": "^24.0.14",
-    "del-cli": "^6.0.0",
+    "@eslint/js": "^9.31.0",
+    "@tsconfig/node20": "^20.1.9",
+    "@types/node": "^25.0.9",
+    "del-cli": "^7.0.0",
     "eslint": "^9.31.0",
     "eslint-config-prettier": "^10.1.8",
-    "fs-extra": "^11.3.0",
+    "fs-extra": "^11.3.5",
     "json": "^11.0.0",
-    "liquidjs": "^10.19.1",
-    "prettier": "3.6.2",
+    "liquidjs": "^10.24.0",
+    "prettier": "^3.8.1",
     "ts-node": "^10.9.2",
     "typescript": "^5.8.3",
-    "typescript-eslint": "^8.38.0",
-    "@eslint/js": "^9.31.0"
+    "typescript-eslint": "^8.59.2"
+  },
+  "scripts": {
+    "generate-top-commons": "bash node_modules/@xpack/npm-packages-helper/maintenance-scripts/generate-top-commons.sh --xpack",
+    "compile-watch": "tsc --build --verbose --watch src",
+    "prettier": "prettier src tests --write --config config/.prettierrc.json --ignore-path config/.prettierignore",
+    "fix": "eslint --config config/eslint.config.js --fix src",
+    "compile": "tsc --project tsconfig.json",
+    "fix-compile": "npm run prettier && npm run fix && npm run compile",
+    "lint": "eslint --config config/eslint.config.js src",
+    "npm-install": "npm install",
+    "npm-link": "npm link",
+    "npm-link-helpers": "npm link @xpack/npm-packages-helper @xpack/docusaurus-template-liquid",
+    "npm-outdated": "npm outdated",
+    "npm-update": "npm update",
+    "postversion": "git push origin --all && git push origin --tags",
+    "npm-pack": "npm pack",
+    "git-log": "git log --pretty='%cd * %h %s' --date=short",
+    "prepare": "del-cli dist && npm run prettier && npm run lint && npm run compile",
+    "test": "echo 'No tests defined'",
+    "dev-cycle": "npm run fix && npm run compile && npm run test",
+    "clean": "del-cli --force dist build .tap",
+    "deep-clean": "npm run clean && del-cli --force node_modules package-lock.json",
+    "npm-audit": "npm audit fix --force",
+    "dumpconf": "env | sort | uniq",
+    "show-versions": "echo $(which node) $(node --version) && echo $(which npm) $(npm --version)",
+    "prepublishOnly": "npm run lint && npm run test",
+    "postpublish": "git push origin --follow-tags"
   },
   "topConfig": {
     "descriptiveName": "Doxygen Documentation Converter",
@@ -88,16 +90,11 @@
     "hasNoGithubReleases": "true",
     "hasCli": "true",
     "useEslint": "true",
+    "usePrettier": "true",
     "hasTriggerPublish": "true",
     "isWebPreview": "true"
   },
-  "prettier": {
-    "printWidth": 80,
-    "semi": false,
-    "singleQuote": true,
-    "trailingComma": "es5"
-  },
   "engines": {
-    "node": " >=20.0.0"
+    "node": ">=20.0"
   }
 }

package/src/cli/main.ts

@@ -0,0 +1,122 @@
+/*
+ * This file is part of the xPack project (http://xpack.github.io).
+ * Copyright (c) 2025-2026 Liviu Ionescu. All rights reserved.
+ *
+ * Permission to use, copy, modify, and/or distribute this software for any
+ * purpose is hereby granted, under the terms of the MIT license.
+ *
+ * If a copy of the license was not distributed with this file, it can be
+ * obtained from https://opensource.org/licenses/mit.
+ */
+
+// ----------------------------------------------------------------------------
+
+// import assert from 'node:assert'
+import * as path from 'node:path'
+import * as fs from 'node:fs/promises'
+import { fileURLToPath } from 'node:url'
+// import * as util from 'node:util'
+
+// https://www.npmjs.com/package/commander
+import { CliOptions } from '../docusaurus/cli-options.js'
+import { formatDuration } from '../docusaurus/utils.js'
+import { DataModel } from '../doxygen/data-model/data-model.js'
+import { DocusaurusGenerator } from '../docusaurus/generator.js'
+import { Workspace } from '../docusaurus/workspace.js'
+// https://www.npmjs.com/package/commander
+import { Command } from 'commander'
+
+// ----------------------------------------------------------------------------
+
+/**
+ * Main entry point for the doxygen2docusaurus CLI tool.
+ *
+ * @remarks
+ * Orchestrates the complete conversion process from Doxygen XML to Docusaurus
+ * documentation. Handles command-line argument parsing, configuration loading,
+ * data model creation, workspace initialisation, and documentation generation.
+ * Provides timing information and appropriate exit codes for integration.
+ *
+ * @param argv - Command line arguments array
+ * @returns Promise that resolves to the exit code (0 for success, 1 for error)
+ *
+ * @public
+ */
+export async function main(argv: string[]): Promise<number> {
+  const startTime = Date.now()
+
+  // Like .../doxygen2docusaurus/dist/cli
+  const __dirname = path.dirname(fileURLToPath(import.meta.url))
+  const packageJsonPath = path.join(
+    path.dirname(path.dirname(__dirname)),
+    'package.json'
+  )
+  const packageJsonContent = await fs.readFile(packageJsonPath)
+
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+  const packageJson = JSON.parse(packageJsonContent.toString())
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access
+  const packageVersion: string = packageJson.version
+
+  const program = new Command()
+
+  program.option('--id <name>', 'configuration id, for multi-configurations')
+  program.option('--verbose', 'display more details during the conversion')
+  program.option('--debug', 'display debug lines during the conversion')
+  program.option('-C <path>', 'change the current folder')
+  program.option('-v, --version', 'display version')
+  program.parse(argv)
+
+  const programOptions = program.opts()
+
+  if (programOptions.version) {
+    console.log(packageVersion)
+    return 0
+  }
+
+  if (programOptions.C) {
+    process.chdir(programOptions.C as string)
+  }
+
+  let commandLine: string = path.basename(argv[1] ?? 'doxygen2docusaurus')
+  if (argv.length > 2) {
+    commandLine += ` ${argv.slice(2).join(' ')}`
+  }
+
+  console.log(`Running '${commandLine}' (v${packageVersion})...`)
+
+  const id = (programOptions.id as string | undefined) ?? 'default'
+  const verbose = programOptions.verbose as boolean | undefined
+  const debug = programOptions.debug as boolean | undefined
+
+  const commandOptions = { id, verbose, debug }
+  const options = new CliOptions(commandOptions)
+  await options.parse()
+
+  let exitCode = 0
+
+  console.log()
+
+  const dataModel = new DataModel(options)
+  await dataModel.parse()
+  dataModel.projectVersion = packageVersion
+
+  const workspace = new Workspace(dataModel)
+
+  const generator = new DocusaurusGenerator(workspace)
+  exitCode = await generator.run()
+
+  const durationString = formatDuration(Date.now() - startTime)
+
+  if (exitCode === 0) {
+    console.log()
+    console.log(
+      `Running '${commandLine}' has completed successfully ` +
+        `in ${durationString}.`
+    )
+  }
+
+  return exitCode
+}
+
+// ----------------------------------------------------------------------------