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 9ec86269..48094a79 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -136,7 +136,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/packages/create/templates/common/package.json b/packages/create/templates/common/package.json index 75de43fb..b5a690d7 100644 --- a/packages/create/templates/common/package.json +++ b/packages/create/templates/common/package.json @@ -55,7 +55,7 @@ "devDependencies": { //%// Typescript and type declarations //%if typescript - "typescript": "^5.9.3", + "typescript": "^7.0.2", "@types/node": "^24.13.4", //%endif //%if typescript & web diff --git a/packages/create/templates/plugin-ts/tsconfig.node.json b/packages/create/templates/plugin-ts/tsconfig.node.json index 53333178..78554d9f 100644 --- a/packages/create/templates/plugin-ts/tsconfig.node.json +++ b/packages/create/templates/plugin-ts/tsconfig.node.json @@ -2,6 +2,7 @@ "extends": "./tsconfig.base.json", "compilerOptions": { "lib": ["es2023"], + "types": ["node"], "module": "node16", "moduleResolution": "node16", "target": "es2022", diff --git a/packages/lib/src/data/messages_mod.ts b/packages/lib/src/data/messages_mod.ts index 5d26fc78..f0fb57c3 100644 --- a/packages/lib/src/data/messages_mod.ts +++ b/packages/lib/src/data/messages_mod.ts @@ -251,7 +251,6 @@ export class ModPortalGetAllRequest { // Define the Response class inline static Response = class ModPortalGetAllResponse { - declare ["constructor"]: typeof ModPortalGetAllResponse; constructor( public mods: Static[], ) { } diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml index de679916..ddd59f18 100644 --- a/pnpm-workspace.yaml +++ b/pnpm-workspace.yaml @@ -31,7 +31,7 @@ catalog: react-router-dom: ^7.18.4 semver: ^7.8.5 set-blocking: ^2.0.0 - typescript: ^5.9.3 + typescript: ^7.0.2 vite: ^8.3.4 winston: ^3.19.0 winston-daily-rotate-file: ^5.0.0 diff --git a/tsconfig.node.json b/tsconfig.node.json index da0a3006..d0941899 100644 --- a/tsconfig.node.json +++ b/tsconfig.node.json @@ -2,6 +2,7 @@ "extends": "./tsconfig.base.json", "compilerOptions": { "lib": ["es2023"], + "types": ["node"], "module": "nodenext", "moduleResolution": "node16", "target": "es2022", 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" -}