mirror of
https://github.com/clusterio/clusterio.git
synced 2026-11-14 23:24:52 +09:00
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 <noreply@anthropic.com>
This commit is contained in:
1 parent
a82af49c05
commit
c724f144e7
5 files changed
+5
-19
No files matched your search
@@ -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.
|
||||
|
||||
@@ -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)
|
||||
|
||||
|
||||
Reference in new issue
Block a user