[feature] TypeDoc setup should be at package level

Author: marmoure

.circleci/config.yml

@@ -82,7 +82,7 @@ jobs:
           command: yarn build
       - run:
           name: Generate Docs
-          command: yarn docs:all
+          command: yarn generate-docs
 
   run-example:
     docker:

package.json

@@ -19,9 +19,7 @@
     "example": "yarn workspace @evolvedbinary/lwdita-xdita run example",
     "test": "mocha",
     "test:watch": "mocha -w",
-    "docs:ast": "typedoc --options typedoc.config.mjs --entryPoints packages/lwdita-ast/src/index.ts --out doc/ast",
-    "docs:xdita": "typedoc --options typedoc.config.mjs --entryPoints packages/lwdita-xdita/src/index.ts --out doc/xdita",
-    "docs:all": "rimraf doc && yarn docs:ast && yarn docs:xdita",
+    "generate-docs": "yarn workspaces foreach --parallel --recursive --from '@evolvedbinary/lwdita-*' run docs",
     "lint": "eslint",
     "coverage": "rimraf coverage && nyc yarn mocha",
     "coveralls": "nyc --reporter=text-lcov report | coveralls"
@@ -65,7 +63,6 @@
     "nodemon": "^3.1.10",
     "nyc": "^17.1.0",
     "rimraf": "^6.1.0",
-    "typedoc": "^0.28.14",
     "typescript": "5.9.3",
     "typescript-eslint": "^8.46.2"
   },

packages/lwdita-ast/package.json

@@ -10,7 +10,8 @@
   "scripts": {
     "build": "tsc",
     "clean": "rimraf dist",
-    "prepack": "yarn run build"
+    "prepack": "yarn run build",
+    "docs": "typedoc --options typedoc.config.mjs --entryPoints src/index.ts --out dist/doc"
   },
   "keywords": [
     "LwDITA",
@@ -30,6 +31,7 @@
   },
   "devDependencies": {
     "rimraf": "^6.1.0",
+    "typedoc": "^0.28.14",
     "typescript": "5.9.3"
   },
   "packageManager": "[email protected]"

typedoc.config.mjs renamed to packages/lwdita-ast/typedoc.config.mjs

@@ -11,6 +11,7 @@
     "build": "tsc",
     "clean": "rimraf dist",
     "prepack": "yarn run build",
+    "docs": "typedoc --options typedoc.config.mjs --entryPoints src/index.ts --out dist/doc",
     "example": "ts-node ./example.ts"
   },
   "keywords": [
@@ -40,6 +41,7 @@
     "@types/node": "^24.9.2",
     "rimraf": "^6.1.0",
     "ts-node": "^10.9.2",
+    "typedoc": "^0.28.14",
     "typescript": "5.9.3"
   },
   "packageManager": "[email protected]"

packages/lwdita-xdita/package.json

@@ -0,0 +1,29 @@
+/*!
+Copyright (C) 2020 Evolved Binary
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.
+*/
+
+import { OptionDefaults } from "typedoc";
+
+/** @type {Partial<import('typedoc').TypeDocOptions>} */
+const config = {
+  tsconfig: "./tsconfig.json",
+  modifierTags: [...OptionDefaults.modifierTags, "@decorator"],
+  highlightLanguages: ["ts", "js", "xml", "json", "bash"],
+  treatWarningsAsErrors: true,
+  treatValidationWarningsAsErrors: true,
+};
+
+export default config;

packages/lwdita-xdita/typedoc.config.mjs

@@ -1,6 +1,6 @@
 {
   "extends": "@tsconfig/recommended/tsconfig.json",
-  "exclude": ["**/test/**", "**/dist/**", "node_modules", "eslint.config.mts"],
+
   // overrides recommended
   "compilerOptions": {
     "skipLibCheck": false,                    /* Do NOT skip type checking of declaration files. */
@@ -9,6 +9,7 @@
     "sourceMap": true,                        /* Generates corresponding '.map' file. */
     "noEmit": false,                          /* NOTE(AR) just making it explicit that we are using tsc (and not another tool) to emit compiled JavaScript */
     "moduleResolution": "node10",             /* NOTE(AR) just making it explicit that this is the tsc compilation strategy for module resolution that we are currently using */
+    "rootDir": "src",
     "outDir": "dist",                         /* Redirect output structure to the `dist/` directory. */
   },
 }

tsconfig.json

@@ -378,6 +378,7 @@ __metadata:
   resolution: "@evolvedbinary/lwdita-ast@workspace:packages/lwdita-ast"
   dependencies:
     rimraf: "npm:^6.1.0"
+    typedoc: "npm:^0.28.14"
     typescript: "npm:5.9.3"
   languageName: unknown
   linkType: soft
@@ -391,6 +392,7 @@ __metadata:
     "@types/node": "npm:^24.9.2"
     rimraf: "npm:^6.1.0"
     ts-node: "npm:^10.9.2"
+    typedoc: "npm:^0.28.14"
     typescript: "npm:5.9.3"
   languageName: unknown
   linkType: soft
@@ -414,7 +416,6 @@ __metadata:
     nodemon: "npm:^3.1.10"
     nyc: "npm:^17.1.0"
     rimraf: "npm:^6.1.0"
-    typedoc: "npm:^0.28.14"
     typescript: "npm:5.9.3"
     typescript-eslint: "npm:^8.46.2"
   languageName: unknown