From c724f144e77deb456d83a8f29aa93828b48662ef Mon Sep 17 00:00:00 2001 From: bbassie <17990055+bbassie@users.noreply.github.com> Date: Thu, 29 Oct 2026 00:16:59 +0000 Subject: [PATCH] Drop TypeDoc The generated API docs were never published or built in CI, and typedoc's peer range stops at TypeScript 6.0. TSDoc comments stay. Co-Authored-By: Claude Opus 5.5 --- .gitignore | 3 --- docs/contributing.md | 1 - docs/decisions.md | 5 +++++ package.json | 2 -- typedoc.json | 13 ------------- 5 files changed, 5 insertions(+), 19 deletions(-) delete mode 100644 typedoc.json diff --git a/.gitignore b/.gitignore index 5f99e160..682add85 100644 --- a/.gitignore +++ b/.gitignore @@ -23,9 +23,6 @@ coverage build/Release dist/ -# Autogenerated docs output -/docs/api - node_modules /factorio* diff --git a/docs/contributing.md b/docs/contributing.md index f099db99..3e8462f1 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -135,7 +135,6 @@ Keep in mind if you're working on external plugins the `--dev-plugin` option is | `pnpm watch` | TypeScript compilation as files change; restart affected Node processes afterward. | | `pnpm -r run prepare` | Compiled packages, generated validators, and production web bundles. | | `pnpm build-mod` | Factorio mod archives in root `dist/`. | -| `pnpm docs` | Generated API documentation. | `pnpm build` alone does not regenerate the standalone validator or web bundles. After changing `packages/lib/src/data/messages_core.ts`, run `pnpm -r run prepare` to compile the schema and regenerate its validator. diff --git a/docs/decisions.md b/docs/decisions.md index 8e06617a..5aaadf2e 100644 --- a/docs/decisions.md +++ b/docs/decisions.md @@ -91,6 +91,11 @@ Therefore, we decided to use TSDoc comments for this purpose as it is well inter Our specific implementation is TypeDoc because it is lightweight it and can output TSDoc comments as html. API Extractor was also considered but not selected. +🧾 29th October 2026 | [Github PR #1147](https://github.com/clusterio/clusterio/pull/1147) + +We dropped TypeDoc as the generated docs were never published and it does not support TypeScript 7. +TSDoc comments are still used for editor hover text. + ## Code Style (General) diff --git a/package.json b/package.json index 845eaa79..b8c32482 100644 --- a/package.json +++ b/package.json @@ -18,7 +18,6 @@ "lint": "oxlint packages plugins test", "lint-fix": "oxlint --fix packages plugins test", "clean": "node ./clean.js", - "docs": "typedoc", "bundle-dependencies": "bundle-dependencies" }, "c8": { @@ -51,7 +50,6 @@ "jsonwebtoken": "catalog:", "mocha": "^11.8.0", "oxlint": "^1.88.0", - "typedoc": "^0.28.20", "typescript": "catalog:", "yargs": "catalog:", "yauzl": "catalog:", diff --git a/typedoc.json b/typedoc.json deleted file mode 100644 index 1523eca2..00000000 --- a/typedoc.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "$schema": "https://typedoc.org/schema.json", - "entryPoints": [ - "packages/lib/", - "packages/controller/", - "packages/host/", - "packages/ctl/", - "packages/web_ui/", - ], - "entryPointStrategy": "packages", - "cleanOutputDir": false, - "out": "docs/api" -}