[feature] introduce TypeDoc to the project again

Author: marmoure

.circleci/config.yml

@@ -69,6 +69,21 @@ jobs:
           name: Build
           command: yarn build
 
+  generate-docs:
+    docker:
+      - image: cimg/node:<< pipeline.parameters.node-image-tag >>
+    resource_class: << pipeline.parameters.resource-class >>
+    steps:
+      - checkout
+      - install-yarn
+      - install-dependencies
+      - run:
+          name: Build
+          command: yarn build
+      - run:
+          name: Generate Docs
+          command: yarn docs:all
+
   run-example:
     docker:
       - image: cimg/node:<< pipeline.parameters.node-image-tag >>
@@ -90,4 +105,5 @@ workflows:
       - lint
       - build
       - coverage
+      - generate-docs
       - run-example

.gitignore

@@ -27,3 +27,6 @@ package-lock.json
 !.yarn/versions
 #!.yarn/cache
 .pnp.*
+
+# Typedoc output
+doc/

changes

@@ -0,0 +1,86 @@
+diff --git a/.circleci/config.yml b/.circleci/config.yml
+index 0f9cbca..aec2d6b 100644
+--- a/.circleci/config.yml
++++ b/.circleci/config.yml
+@@ -69,6 +69,21 @@ jobs:
+           name: Build
+           command: yarn build
+ 
++  generate-docs:
++    docker:
++      - image: cimg/node:<< pipeline.parameters.node-image-tag >>
++    resource_class: << pipeline.parameters.resource-class >>
++    steps:
++      - checkout
++      - install-yarn
++      - install-dependencies
++      - run:
++          name: Build
++          command: yarn build
++      - run:
++          name: Generate Docs
++          command: yarn docs:all
++
+   run-example:
+     docker:
+       - image: cimg/node:<< pipeline.parameters.node-image-tag >>
+@@ -90,4 +105,5 @@ workflows:
+       - lint
+       - build
+       - coverage
++      - generate-docs
+       - run-example
+diff --git a/.gitignore b/.gitignore
+index 2680f21..50804b0 100644
+--- a/.gitignore
++++ b/.gitignore
+@@ -27,3 +27,6 @@ package-lock.json
+ !.yarn/versions
+ #!.yarn/cache
+ .pnp.*
++
++# Typedoc output
++doc/
+\ No newline at end of file
+diff --git a/package.json b/package.json
+index c9a8d1c..a986c3c 100644
+--- a/package.json
++++ b/package.json
+@@ -19,6 +19,9 @@
+     "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",
+     "lint": "eslint",
+     "coverage": "rimraf coverage && nyc yarn mocha",
+     "coveralls": "nyc --reporter=text-lcov report | coveralls"
+@@ -62,6 +65,7 @@
+     "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"
+   },
+diff --git a/tsconfig.json b/tsconfig.json
+index 2614f00..50d46b6 100644
+--- a/tsconfig.json
++++ b/tsconfig.json
+@@ -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,7 +9,6 @@
+     "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. */
+   },
+ }

package.json

@@ -19,6 +19,9 @@
     "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",
     "lint": "eslint",
     "coverage": "rimraf coverage && nyc yarn mocha",
     "coveralls": "nyc --reporter=text-lcov report | coveralls"
@@ -62,6 +65,7 @@
     "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"
   },

tsconfig.json

@@ -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,7 +9,6 @@
     "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. */
   },
 }

typedoc.config.mjs

@@ -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;