mirror of
https://github.com/clusterio/clusterio.git
synced 2026-11-11 15:04: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
@@ -23,9 +23,6 @@ coverage
|
||||
build/Release
|
||||
dist/
|
||||
|
||||
# Autogenerated docs output
|
||||
/docs/api
|
||||
|
||||
node_modules
|
||||
|
||||
/factorio*
|
||||
|
||||
@@ -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)
|
||||
|
||||
|
||||
@@ -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:",
|
||||
|
||||
@@ -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"
|
||||
}
|
||||
Reference in new issue
Block a user