diff --git a/.changeset/better-adults-cut.md b/.changeset/better-adults-cut.md new file mode 100644 index 00000000..b16acd0b --- /dev/null +++ b/.changeset/better-adults-cut.md @@ -0,0 +1,6 @@ +--- +'@tanstack/config': minor +'@tanstack/typedoc-config': minor +--- + +feat: update to typedoc v0.28 diff --git a/.changeset/easy-icons-drive.md b/.changeset/easy-icons-drive.md new file mode 100644 index 00000000..0fadcee0 --- /dev/null +++ b/.changeset/easy-icons-drive.md @@ -0,0 +1,6 @@ +--- +'@tanstack/typedoc-config': minor +'@tanstack/config': minor +--- + +BREAKING: typedoc output is no longer lower-cased due to API changes diff --git a/packages/typedoc-config/src/typedoc-custom-settings.js b/packages/typedoc-config/src/typedoc-custom-settings.js index 2e3c7bf8..b38ccf5d 100644 --- a/packages/typedoc-config/src/typedoc-custom-settings.js +++ b/packages/typedoc-config/src/typedoc-custom-settings.js @@ -1,7 +1,4 @@ -import { - MarkdownPageEvent, - MarkdownRendererEvent, -} from 'typedoc-plugin-markdown' +import { MarkdownPageEvent } from 'typedoc-plugin-markdown' /** * @param {import("typedoc-plugin-markdown").MarkdownApplication} app @@ -20,18 +17,4 @@ export function load(app) { '\n\n' }, ) - // Rename output files - app.renderer.on( - MarkdownRendererEvent.BEGIN, - /** - * @param {import("typedoc-plugin-markdown").MarkdownRendererEvent} renderer - */ (renderer) => { - renderer.urls = renderer.urls?.map((urlMapping) => { - const name = urlMapping.url.toLowerCase() - urlMapping.url = name - urlMapping.model.url = name - return urlMapping - }) - }, - ) } diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 4ddd168b..cd6b3748 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -103,14 +103,14 @@ catalogs: specifier: ^5.0.1 version: 5.0.1 typedoc: - specifier: 0.27.9 - version: 0.27.9 + specifier: 0.28.14 + version: 0.28.14 typedoc-plugin-frontmatter: - specifier: 1.2.1 - version: 1.2.1 + specifier: 1.3.0 + version: 1.3.0 typedoc-plugin-markdown: - specifier: 4.4.2 - version: 4.4.2 + specifier: 4.9.0 + version: 4.9.0 typescript: specifier: ^5.9.2 version: 5.9.3 @@ -324,13 +324,13 @@ importers: dependencies: typedoc: specifier: 'catalog:' - version: 0.27.9(typescript@5.9.3) + version: 0.28.14(typescript@5.9.3) typedoc-plugin-frontmatter: specifier: 'catalog:' - version: 1.2.1(typedoc-plugin-markdown@4.4.2(typedoc@0.27.9(typescript@5.9.3))) + version: 1.3.0(typedoc-plugin-markdown@4.9.0(typedoc@0.28.14(typescript@5.9.3))) typedoc-plugin-markdown: specifier: 'catalog:' - version: 4.4.2(typedoc@0.27.9(typescript@5.9.3)) + version: 4.9.0(typedoc@0.28.14(typescript@5.9.3)) packages/vite-config: dependencies: @@ -752,8 +752,8 @@ packages: resolution: {integrity: sha512-sB5uyeq+dwCWyPi31B2gQlVlo+j5brPlWx4yZBrEaRo/nhdDE8Xke1gsGgtiBdaBTxuTkceLVuVt/pclrasb0A==} engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0} - '@gerrit0/mini-shiki@1.27.2': - resolution: {integrity: sha512-GeWyHz8ao2gBiUW4OJnQDxXQnFgZQwwQk05t/CVVgNBN7/rK8XZ7xY6YhLVv9tH3VppWWmr9DCl3MwemB/i+Og==} + '@gerrit0/mini-shiki@3.13.1': + resolution: {integrity: sha512-fDWM5QQc70jwBIt/WYMybdyXdyBmoJe7r1hpM+V/bHnyla79sygVDK2/LlVxIPc4n5FA3B5Wzt7AQH2+psNphg==} '@humanfs/core@0.19.1': resolution: {integrity: sha512-5DyQ4+1JEUzejeK1JGICcideyfUbGixgS9jNgex5nqkW+cY7WZhxBigmieN5Qnw9ZosSNVC9KQKyb+GUaGyKUA==} @@ -1060,11 +1060,17 @@ packages: '@rushstack/ts-command-line@4.22.6': resolution: {integrity: sha512-QSRqHT/IfoC5nk9zn6+fgyqOPXHME0BfchII9EUPR19pocsNp/xSbeBCbD3PIR2Lg+Q5qk7OFqk1VhWPMdKHJg==} - '@shikijs/engine-oniguruma@1.29.2': - resolution: {integrity: sha512-7iiOx3SG8+g1MnlzZVDYiaeHe7Ez2Kf2HrJzdmGwkRisT7r4rak0e655AcM/tF9JG/kg5fMNYlLLKglbN7gBqA==} + '@shikijs/engine-oniguruma@3.13.0': + resolution: {integrity: sha512-O42rBGr4UDSlhT2ZFMxqM7QzIU+IcpoTMzb3W7AlziI1ZF7R8eS2M0yt5Ry35nnnTX/LTLXFPUjRFCIW+Operg==} - '@shikijs/types@1.29.2': - resolution: {integrity: sha512-VJjK0eIijTZf0QSTODEXCqinjBn0joAHQ+aPSBzrv4O2d/QSbsMw+ZeSRx03kV34Hy7NzUvV/7NqfYGRLrASmw==} + '@shikijs/langs@3.13.0': + resolution: {integrity: sha512-672c3WAETDYHwrRP0yLy3W1QYB89Hbpj+pO4KhxK6FzIrDI2FoEXNiNCut6BQmEApYLfuYfpgOZaqbY+E9b8wQ==} + + '@shikijs/themes@3.13.0': + resolution: {integrity: sha512-Vxw1Nm1/Od8jyA7QuAenaV78BG2nSr3/gCGdBkLpfLscddCkzkL36Q5b67SrLLfvAJTOUzW39x4FHVCFriPVgg==} + + '@shikijs/types@3.13.0': + resolution: {integrity: sha512-oM9P+NCFri/mmQ8LoFGVfVyemm5Hi27330zuOBp0annwJdKH1kOLndw3zCtAVDehPLg9fKqoEx3Ht/wNZxolfw==} '@shikijs/vscode-textmate@10.0.2': resolution: {integrity: sha512-83yeghZ2xxin3Nj8z1NMd/NCuca+gsYXswywDy5bHvwlWL8tpTQmzGeUuHd9FC3E/SBEMvzJRwWEOz5gGes9Qg==} @@ -2941,23 +2947,23 @@ packages: resolution: {integrity: sha512-9MpwAI52m8H6ssA542UxSLnSiSD2dsC3/L85g6hVubLSXd82wdI80eZwTWhdOfN67NlA+D+oipAs1MlcTcu3KA==} engines: {node: '>=20'} - typedoc-plugin-frontmatter@1.2.1: - resolution: {integrity: sha512-TKiOOQCxC1uUYldokAegap2oAtDy9QpsUoVDRohcB6Dm45T91qMgkWqHVS8qbCpDc4SJoGqmGTULGfrqeRqXtA==} + typedoc-plugin-frontmatter@1.3.0: + resolution: {integrity: sha512-xYQFMAecMlsRUjmf9oM/Sq2FVz4zlgcbIeVFNLdO118CHTN06gIKJNSlyExh9+Xl8sK0YhIvoQwViUURxritWA==} peerDependencies: - typedoc-plugin-markdown: '>=4.4.2' + typedoc-plugin-markdown: '>=4.5.0' - typedoc-plugin-markdown@4.4.2: - resolution: {integrity: sha512-kJVkU2Wd+AXQpyL6DlYXXRrfNrHrEIUgiABWH8Z+2Lz5Sq6an4dQ/hfvP75bbokjNDUskOdFlEEm/0fSVyC7eg==} + typedoc-plugin-markdown@4.9.0: + resolution: {integrity: sha512-9Uu4WR9L7ZBgAl60N/h+jqmPxxvnC9nQAlnnO/OujtG2ubjnKTVUFY1XDhcMY+pCqlX3N2HsQM2QTYZIU9tJuw==} engines: {node: '>= 18'} peerDependencies: - typedoc: 0.27.x + typedoc: 0.28.x - typedoc@0.27.9: - resolution: {integrity: sha512-/z585740YHURLl9DN2jCWe6OW7zKYm6VoQ93H0sxZ1cwHQEQrUn5BJrEnkWhfzUdyO+BLGjnKUZ9iz9hKloFDw==} - engines: {node: '>= 18'} + typedoc@0.28.14: + resolution: {integrity: sha512-ftJYPvpVfQvFzpkoSfHLkJybdA/geDJ8BGQt/ZnkkhnBYoYW6lBgPQXu6vqLxO4X75dA55hX8Af847H5KXlEFA==} + engines: {node: '>= 18', pnpm: '>= 10'} hasBin: true peerDependencies: - typescript: 5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x || 5.6.x || 5.7.x || 5.8.x + typescript: 5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x || 5.6.x || 5.7.x || 5.8.x || 5.9.x typescript-eslint@8.46.0: resolution: {integrity: sha512-6+ZrB6y2bT2DX3K+Qd9vn7OFOJR+xSLDj+Aw/N3zBwUt27uTw2sw2TE2+UcY1RiyBZkaGbTkVg9SSdPNUG6aUw==} @@ -3678,10 +3684,12 @@ snapshots: '@eslint/core': 0.16.0 levn: 0.4.1 - '@gerrit0/mini-shiki@1.27.2': + '@gerrit0/mini-shiki@3.13.1': dependencies: - '@shikijs/engine-oniguruma': 1.29.2 - '@shikijs/types': 1.29.2 + '@shikijs/engine-oniguruma': 3.13.0 + '@shikijs/langs': 3.13.0 + '@shikijs/themes': 3.13.0 + '@shikijs/types': 3.13.0 '@shikijs/vscode-textmate': 10.0.2 '@humanfs/core@0.19.1': {} @@ -3963,12 +3971,20 @@ snapshots: transitivePeerDependencies: - '@types/node' - '@shikijs/engine-oniguruma@1.29.2': + '@shikijs/engine-oniguruma@3.13.0': dependencies: - '@shikijs/types': 1.29.2 + '@shikijs/types': 3.13.0 '@shikijs/vscode-textmate': 10.0.2 - '@shikijs/types@1.29.2': + '@shikijs/langs@3.13.0': + dependencies: + '@shikijs/types': 3.13.0 + + '@shikijs/themes@3.13.0': + dependencies: + '@shikijs/types': 3.13.0 + + '@shikijs/types@3.13.0': dependencies: '@shikijs/vscode-textmate': 10.0.2 '@types/hast': 3.0.4 @@ -5904,18 +5920,18 @@ snapshots: dependencies: tagged-tag: 1.0.0 - typedoc-plugin-frontmatter@1.2.1(typedoc-plugin-markdown@4.4.2(typedoc@0.27.9(typescript@5.9.3))): + typedoc-plugin-frontmatter@1.3.0(typedoc-plugin-markdown@4.9.0(typedoc@0.28.14(typescript@5.9.3))): dependencies: - typedoc-plugin-markdown: 4.4.2(typedoc@0.27.9(typescript@5.9.3)) + typedoc-plugin-markdown: 4.9.0(typedoc@0.28.14(typescript@5.9.3)) yaml: 2.8.1 - typedoc-plugin-markdown@4.4.2(typedoc@0.27.9(typescript@5.9.3)): + typedoc-plugin-markdown@4.9.0(typedoc@0.28.14(typescript@5.9.3)): dependencies: - typedoc: 0.27.9(typescript@5.9.3) + typedoc: 0.28.14(typescript@5.9.3) - typedoc@0.27.9(typescript@5.9.3): + typedoc@0.28.14(typescript@5.9.3): dependencies: - '@gerrit0/mini-shiki': 1.27.2 + '@gerrit0/mini-shiki': 3.13.1 lunr: 2.3.9 markdown-it: 14.1.0 minimatch: 9.0.5 diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml index 1cea71b0..02177aef 100644 --- a/pnpm-workspace.yaml +++ b/pnpm-workspace.yaml @@ -39,9 +39,9 @@ catalog: simple-git: ^3.28.0 tinyglobby: ^0.2.15 type-fest: ^5.0.1 - typedoc: 0.27.9 - typedoc-plugin-frontmatter: 1.2.1 - typedoc-plugin-markdown: 4.4.2 + typedoc: 0.28.14 + typedoc-plugin-frontmatter: 1.3.0 + typedoc-plugin-markdown: 4.9.0 typescript: ^5.9.2 typescript-eslint: ^8.46.0 vite: ^7.1.9