diff --git a/package.json b/package.json index b1eb379b12..3a12350e3f 100644 --- a/package.json +++ b/package.json @@ -27,7 +27,7 @@ "dev": "pnpm run watch", "prettier": "prettier --ignore-unknown '**/*'", "prettier:write": "pnpm run prettier --write", - "docs:reference": "node scripts/reference-docs.js", + "docs:generate": "node scripts/generateDocs.js", "cipublish": "node scripts/publish.js" }, "nx": { @@ -42,7 +42,7 @@ "@cspell/eslint-plugin": "^8.9.1", "@eslint-react/eslint-plugin": "^1.5.16", "@solidjs/testing-library": "^0.8.8", - "@tanstack/config": "^0.9.8", + "@tanstack/config": "^0.10.0", "@testing-library/jest-dom": "^6.4.6", "@testing-library/react": "^16.0.0", "@types/eslint": "^8.56.10", @@ -66,9 +66,6 @@ "sherif": "^0.10.0", "solid-js": "^1.8.17", "tsup": "^8.0.2", - "typedoc": "^0.26.4", - "typedoc-plugin-frontmatter": "^1.0.0", - "typedoc-plugin-markdown": "^4.2.1", "typescript": "5.3.3", "typescript47": "npm:typescript@4.7", "typescript48": "npm:typescript@4.8", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 8993152e0a..7690634a2f 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -28,8 +28,8 @@ importers: specifier: ^0.8.8 version: 0.8.8(@solidjs/router@0.13.3(solid-js@1.8.17))(solid-js@1.8.17) '@tanstack/config': - specifier: ^0.9.8 - version: 0.9.8(@types/node@20.14.10)(esbuild@0.19.11)(eslint@8.57.0)(rollup@4.14.1)(typescript@5.3.3)(vite@5.3.3(@types/node@20.14.10)(less@4.2.0)(sass@1.71.1)(terser@5.29.1)) + specifier: ^0.10.0 + version: 0.10.0(@types/node@20.14.10)(esbuild@0.19.11)(eslint@8.57.0)(rollup@4.14.1)(typescript@5.3.3)(vite@5.3.3(@types/node@20.14.10)(less@4.2.0)(sass@1.71.1)(terser@5.29.1)) '@testing-library/jest-dom': specifier: ^6.4.6 version: 6.4.6(vitest@2.0.3(@types/node@20.14.10)(jsdom@24.1.0)(less@4.2.0)(sass@1.71.1)(terser@5.29.1)) @@ -99,15 +99,6 @@ importers: tsup: specifier: ^8.0.2 version: 8.0.2(@microsoft/api-extractor@7.46.2(@types/node@20.14.10))(postcss@8.4.39)(typescript@5.3.3) - typedoc: - specifier: ^0.26.4 - version: 0.26.4(typescript@5.3.3) - typedoc-plugin-frontmatter: - specifier: ^1.0.0 - version: 1.0.0(typedoc-plugin-markdown@4.2.1(typedoc@0.26.4(typescript@5.3.3))) - typedoc-plugin-markdown: - specifier: ^4.2.1 - version: 4.2.1(typedoc@0.26.4(typescript@5.3.3)) typescript: specifier: 5.3.3 version: 5.3.3 @@ -992,10 +983,10 @@ importers: version: types-react-dom@19.0.0-rc.1 '@typescript-eslint/eslint-plugin': specifier: ^7.15.0 - version: 7.16.0(@typescript-eslint/parser@7.16.0(eslint@8.57.0)(typescript@5.3.3))(eslint@8.57.0)(typescript@5.3.3) + version: 7.16.1(@typescript-eslint/parser@7.16.1(eslint@8.57.0)(typescript@5.3.3))(eslint@8.57.0)(typescript@5.3.3) '@typescript-eslint/parser': specifier: ^7.15.0 - version: 7.16.0(eslint@8.57.0)(typescript@5.3.3) + version: 7.16.1(eslint@8.57.0)(typescript@5.3.3) '@vitejs/plugin-react': specifier: ^4.3.1 version: 4.3.1(vite@5.3.3(@types/node@20.14.10)(less@4.2.0)(sass@1.71.1)(terser@5.29.1)) @@ -6169,8 +6160,8 @@ packages: '@swc/helpers@0.5.5': resolution: {integrity: sha512-KGYxvIOXcceOAbEk4bi/dVLEK9z8sZ0uBB3Il5b1rhfClSpcX0yfRO0KmTkqR2cnQDymwLB+25ZyMzICg/cm/A==} - '@tanstack/config@0.9.8': - resolution: {integrity: sha512-vq+i8YyaVnyLNSgBdCJGD1bNcmaV/Hep14jKOUFKfSUBt3y6Pim/tIi8g1QW0x2SlvTxHJDpQNQV5lGOFdpA8g==} + '@tanstack/config@0.10.0': + resolution: {integrity: sha512-Yz+7cWxuDo8onU2nm4+kwA9B2GSp+l1k8oSrqiERNkmRu6dKtiiW8ENFqLuXi0p5fi0sBdLeUcEhfMxTifzmtA==} engines: {node: '>=18'} hasBin: true @@ -6485,8 +6476,8 @@ packages: '@types/yargs@17.0.29': resolution: {integrity: sha512-nacjqA3ee9zRF/++a3FUY1suHTFKZeHba2n8WeDw9cCVdmzmHpIxyzOJBcpHvvEmS8E9KqWlSnWHUkOrkhWcvA==} - '@typescript-eslint/eslint-plugin@7.16.0': - resolution: {integrity: sha512-py1miT6iQpJcs1BiJjm54AMzeuMPBSPuKPlnT8HlfudbcS5rYeX5jajpLf3mrdRh9dA/Ec2FVUY0ifeVNDIhZw==} + '@typescript-eslint/eslint-plugin@7.16.1': + resolution: {integrity: sha512-SxdPak/5bO0EnGktV05+Hq8oatjAYVY3Zh2bye9pGZy6+jwyR3LG3YKkV4YatlsgqXP28BTeVm9pqwJM96vf2A==} engines: {node: ^18.18.0 || >=20.0.0} peerDependencies: '@typescript-eslint/parser': ^7.0.0 @@ -6496,8 +6487,8 @@ packages: typescript: optional: true - '@typescript-eslint/parser@7.16.0': - resolution: {integrity: sha512-ar9E+k7CU8rWi2e5ErzQiC93KKEFAXA2Kky0scAlPcxYblLt8+XZuHUZwlyfXILyQa95P6lQg+eZgh/dDs3+Vw==} + '@typescript-eslint/parser@7.16.1': + resolution: {integrity: sha512-u+1Qx86jfGQ5i4JjK33/FnawZRpsLxRnKzGE6EABZ40KxVT/vWsiZFEBBHjFOljmmV3MBYOHEKi0Jm9hbAOClA==} engines: {node: ^18.18.0 || >=20.0.0} peerDependencies: eslint: ^8.57.0 @@ -6513,16 +6504,16 @@ packages: '@eslint/eslintrc': '>=2' eslint: ^8.57.0 - '@typescript-eslint/scope-manager@7.16.0': - resolution: {integrity: sha512-8gVv3kW6n01Q6TrI1cmTZ9YMFi3ucDT7i7aI5lEikk2ebk1AEjrwX8MDTdaX5D7fPXMBLvnsaa0IFTAu+jcfOw==} + '@typescript-eslint/scope-manager@7.16.1': + resolution: {integrity: sha512-nYpyv6ALte18gbMz323RM+vpFpTjfNdyakbf3nsLvF43uF9KeNC289SUEW3QLZ1xPtyINJ1dIsZOuWuSRIWygw==} engines: {node: ^18.18.0 || >=20.0.0} '@typescript-eslint/scope-manager@8.0.0-alpha.30': resolution: {integrity: sha512-FGW/iPWGyPFamAVZ60oCAthMqQrqafUGebF8UKuq/ha+e9SVG6YhJoRzurlQXOVf8dHfOhJ0ADMXyFnMc53clg==} engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0} - '@typescript-eslint/type-utils@7.16.0': - resolution: {integrity: sha512-j0fuUswUjDHfqV/UdW6mLtOQQseORqfdmoBNDFOqs9rvNVR2e+cmu6zJu/Ku4SDuqiJko6YnhwcL8x45r8Oqxg==} + '@typescript-eslint/type-utils@7.16.1': + resolution: {integrity: sha512-rbu/H2MWXN4SkjIIyWcmYBjlp55VT+1G3duFOIukTNFxr9PI35pLc2ydwAfejCEitCv4uztA07q0QWanOHC7dA==} engines: {node: ^18.18.0 || >=20.0.0} peerDependencies: eslint: ^8.57.0 @@ -6531,16 +6522,16 @@ packages: typescript: optional: true - '@typescript-eslint/types@7.16.0': - resolution: {integrity: sha512-fecuH15Y+TzlUutvUl9Cc2XJxqdLr7+93SQIbcZfd4XRGGKoxyljK27b+kxKamjRkU7FYC6RrbSCg0ALcZn/xw==} + '@typescript-eslint/types@7.16.1': + resolution: {integrity: sha512-AQn9XqCzUXd4bAVEsAXM/Izk11Wx2u4H3BAfQVhSfzfDOm/wAON9nP7J5rpkCxts7E5TELmN845xTUCQrD1xIQ==} engines: {node: ^18.18.0 || >=20.0.0} '@typescript-eslint/types@8.0.0-alpha.30': resolution: {integrity: sha512-4WzLlw27SO9pK9UFj/Hu7WGo8WveT0SEiIpFVsV2WwtQmLps6kouwtVCB8GJPZKJyurhZhcqCoQVQFmpv441Vg==} engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0} - '@typescript-eslint/typescript-estree@7.16.0': - resolution: {integrity: sha512-a5NTvk51ZndFuOLCh5OaJBELYc2O3Zqxfl3Js78VFE1zE46J2AaVuW+rEbVkQznjkmlzWsUI15BG5tQMixzZLw==} + '@typescript-eslint/typescript-estree@7.16.1': + resolution: {integrity: sha512-0vFPk8tMjj6apaAZ1HlwM8w7jbghC8jc1aRNJG5vN8Ym5miyhTQGMqU++kuBFDNKe9NcPeZ6x0zfSzV8xC1UlQ==} engines: {node: ^18.18.0 || >=20.0.0} peerDependencies: typescript: '*' @@ -6557,8 +6548,8 @@ packages: typescript: optional: true - '@typescript-eslint/utils@7.16.0': - resolution: {integrity: sha512-PqP4kP3hb4r7Jav+NiRCntlVzhxBNWq6ZQ+zQwII1y/G/1gdIPeYDCKr2+dH6049yJQsWZiHU6RlwvIFBXXGNA==} + '@typescript-eslint/utils@7.16.1': + resolution: {integrity: sha512-WrFM8nzCowV0he0RlkotGDujx78xudsxnGMBHI88l5J8wEhED6yBwaSLP99ygfrzAjsQvcYQ94quDwI0d7E1fA==} engines: {node: ^18.18.0 || >=20.0.0} peerDependencies: eslint: ^8.57.0 @@ -6569,8 +6560,8 @@ packages: peerDependencies: eslint: ^8.57.0 - '@typescript-eslint/visitor-keys@7.16.0': - resolution: {integrity: sha512-rMo01uPy9C7XxG7AFsxa8zLnWXTF8N3PYclekWSrurvhwiw1eW88mrKiAYe6s53AUY57nTRz8dJsuuXdkAhzCg==} + '@typescript-eslint/visitor-keys@7.16.1': + resolution: {integrity: sha512-Qlzzx4sE4u3FsHTPQAAQFJFNOuqtuY0LFrZHwQ8IHK705XxBiWOFkfKRWu6niB7hwfgnwIpO4jTC75ozW1PHWg==} engines: {node: ^18.18.0 || >=20.0.0} '@typescript-eslint/visitor-keys@8.0.0-alpha.30': @@ -14719,8 +14710,8 @@ packages: engines: {node: '>=10'} hasBin: true - semver@7.6.2: - resolution: {integrity: sha512-FNAIBWCx9qcRhoHcgcJ0gvU7SN1lYU2ZXuSfl04bSC5OpvDHFyJCjdNHomPXxjQlCBU67YW64PzY7/VIEH7F2w==} + semver@7.6.3: + resolution: {integrity: sha512-oVekP1cKtI+CTDvHWYFUcMtsK/00wmAEfyqKfNdARm8u1wNVhSgaX7A8d4UuIlUI5e84iEwOhs7ZPYRmzU9U6A==} engines: {node: '>=10'} hasBin: true @@ -14871,6 +14862,7 @@ packages: shikiji@0.9.19: resolution: {integrity: sha512-Kw2NHWktdcdypCj1GkKpXH4o6Vxz8B8TykPlPuLHOGSV8VkhoCLcFOH4k19K4LXAQYRQmxg+0X/eM+m2sLhAkg==} + deprecated: Shikiji is merged back to Shiki v1.0, please migrate over to get the latest updates short-unique-id@5.2.0: resolution: {integrity: sha512-cMGfwNyfDZ/nzJ2k2M+ClthBIh//GlZl1JEf47Uoa9XR11bz8Pa2T2wQO4bVrRdH48LrIDWJahQziKo3MjhsWg==} @@ -16006,8 +15998,8 @@ packages: typescript-auto-import-cache@0.3.3: resolution: {integrity: sha512-ojEC7+Ci1ij9eE6hp8Jl9VUNnsEKzztktP5gtYNRMrTmfXVwA1PITYYAkpxCvvupdSYa/Re51B6KMcv1CTZEUA==} - typescript-eslint@7.16.0: - resolution: {integrity: sha512-kaVRivQjOzuoCXU6+hLnjo3/baxyzWVO5GrnExkFzETRYJKVHYkrJglOu2OCm8Hi9RPDWX1PTNNTpU5KRV0+RA==} + typescript-eslint@7.16.1: + resolution: {integrity: sha512-889oE5qELj65q/tGeOSvlreNKhimitFwZqQ0o7PcWC7/lgRkAMknznsCsV8J8mZGTP/Z+cIbX8accf2DE33hrA==} engines: {node: ^18.18.0 || >=20.0.0} peerDependencies: eslint: ^8.57.0 @@ -17648,7 +17640,7 @@ snapshots: chokidar: 3.6.0 convert-source-map: 1.9.0 reflect-metadata: 0.2.2 - semver: 7.6.2 + semver: 7.6.3 tslib: 2.6.2 typescript: 5.3.3 yargs: 17.7.2 @@ -17708,13 +17700,13 @@ snapshots: commander: 10.0.1 marked: 9.1.6 marked-terminal: 6.2.0(marked@9.1.6) - semver: 7.6.2 + semver: 7.6.3 '@arethetypeswrong/core@0.15.1': dependencies: '@andrewbranch/untar.js': 1.0.3 fflate: 0.8.2 - semver: 7.6.2 + semver: 7.6.3 ts-expose-internals-conditionally: 1.0.0-empty.0 typescript: 5.3.3 validate-npm-package-name: 5.0.0 @@ -20236,9 +20228,9 @@ snapshots: '@eslint-community/eslint-utils': 4.4.0(eslint@8.57.0) '@eslint-react/tools': 1.5.17 '@eslint-react/types': 1.5.17(eslint@8.57.0)(typescript@5.3.3) - '@typescript-eslint/scope-manager': 7.16.0 - '@typescript-eslint/types': 7.16.0 - '@typescript-eslint/utils': 7.16.0(eslint@8.57.0)(typescript@5.3.3) + '@typescript-eslint/scope-manager': 7.16.1 + '@typescript-eslint/types': 7.16.1 + '@typescript-eslint/utils': 7.16.1(eslint@8.57.0)(typescript@5.3.3) effect: 3.4.5 string-ts: 2.2.0 ts-pattern: 5.2.0 @@ -20255,10 +20247,10 @@ snapshots: '@eslint-react/tools': 1.5.17 '@eslint-react/types': 1.5.17(eslint@8.57.0)(typescript@5.3.3) '@eslint-react/var': 1.5.17(eslint@8.57.0)(typescript@5.3.3) - '@typescript-eslint/scope-manager': 7.16.0 - '@typescript-eslint/type-utils': 7.16.0(eslint@8.57.0)(typescript@5.3.3) - '@typescript-eslint/types': 7.16.0 - '@typescript-eslint/utils': 7.16.0(eslint@8.57.0)(typescript@5.3.3) + '@typescript-eslint/scope-manager': 7.16.1 + '@typescript-eslint/type-utils': 7.16.1(eslint@8.57.0)(typescript@5.3.3) + '@typescript-eslint/types': 7.16.1 + '@typescript-eslint/utils': 7.16.1(eslint@8.57.0)(typescript@5.3.3) effect: 3.4.5 short-unique-id: 5.2.0 ts-pattern: 5.2.0 @@ -20273,10 +20265,10 @@ snapshots: '@eslint-react/shared': 1.5.17(eslint@8.57.0)(typescript@5.3.3) '@eslint-react/tools': 1.5.17 '@eslint-react/types': 1.5.17(eslint@8.57.0)(typescript@5.3.3) - '@typescript-eslint/scope-manager': 7.16.0 - '@typescript-eslint/type-utils': 7.16.0(eslint@8.57.0)(typescript@5.3.3) - '@typescript-eslint/types': 7.16.0 - '@typescript-eslint/utils': 7.16.0(eslint@8.57.0)(typescript@5.3.3) + '@typescript-eslint/scope-manager': 7.16.1 + '@typescript-eslint/type-utils': 7.16.1(eslint@8.57.0)(typescript@5.3.3) + '@typescript-eslint/types': 7.16.1 + '@typescript-eslint/utils': 7.16.1(eslint@8.57.0)(typescript@5.3.3) effect: 3.4.5 eslint: 8.57.0 eslint-plugin-react-dom: 1.5.17(eslint@8.57.0)(typescript@5.3.3) @@ -20295,9 +20287,9 @@ snapshots: '@eslint-react/tools': 1.5.17 '@eslint-react/types': 1.5.17(eslint@8.57.0)(typescript@5.3.3) '@eslint-react/var': 1.5.17(eslint@8.57.0)(typescript@5.3.3) - '@typescript-eslint/scope-manager': 7.16.0 - '@typescript-eslint/types': 7.16.0 - '@typescript-eslint/utils': 7.16.0(eslint@8.57.0)(typescript@5.3.3) + '@typescript-eslint/scope-manager': 7.16.1 + '@typescript-eslint/types': 7.16.1 + '@typescript-eslint/utils': 7.16.1(eslint@8.57.0)(typescript@5.3.3) effect: 3.4.5 micro-memoize: 4.1.2 ts-pattern: 5.2.0 @@ -20308,7 +20300,7 @@ snapshots: '@eslint-react/shared@1.5.17(eslint@8.57.0)(typescript@5.3.3)': dependencies: - '@typescript-eslint/utils': 7.16.0(eslint@8.57.0)(typescript@5.3.3) + '@typescript-eslint/utils': 7.16.1(eslint@8.57.0)(typescript@5.3.3) deepmerge-ts: 7.0.3 valibot: 0.35.0 transitivePeerDependencies: @@ -20321,8 +20313,8 @@ snapshots: '@eslint-react/types@1.5.17(eslint@8.57.0)(typescript@5.3.3)': dependencies: '@eslint-react/tools': 1.5.17 - '@typescript-eslint/types': 7.16.0 - '@typescript-eslint/utils': 7.16.0(eslint@8.57.0)(typescript@5.3.3) + '@typescript-eslint/types': 7.16.1 + '@typescript-eslint/utils': 7.16.1(eslint@8.57.0)(typescript@5.3.3) transitivePeerDependencies: - eslint - supports-color @@ -20333,9 +20325,9 @@ snapshots: '@eslint-react/ast': 1.5.17(eslint@8.57.0)(typescript@5.3.3) '@eslint-react/tools': 1.5.17 '@eslint-react/types': 1.5.17(eslint@8.57.0)(typescript@5.3.3) - '@typescript-eslint/scope-manager': 7.16.0 - '@typescript-eslint/types': 7.16.0 - '@typescript-eslint/utils': 7.16.0(eslint@8.57.0)(typescript@5.3.3) + '@typescript-eslint/scope-manager': 7.16.1 + '@typescript-eslint/types': 7.16.1 + '@typescript-eslint/utils': 7.16.1(eslint@8.57.0)(typescript@5.3.3) effect: 3.4.5 string-ts: 2.2.0 valibot: 0.35.0 @@ -20457,7 +20449,7 @@ snapshots: resolve: 1.22.8 resolve-from: 5.0.0 resolve.exports: 2.0.2 - semver: 7.6.2 + semver: 7.6.3 send: 0.18.0(supports-color@6.1.0) slugify: 1.6.6 source-map-support: 0.5.21 @@ -20495,7 +20487,7 @@ snapshots: getenv: 1.0.0 glob: 7.1.6 resolve-from: 5.0.0 - semver: 7.6.2 + semver: 7.6.3 slash: 3.0.0 slugify: 1.6.6 xcode: 3.0.1 @@ -20515,7 +20507,7 @@ snapshots: glob: 7.1.6 require-from-string: 2.0.2 resolve-from: 5.0.0 - semver: 7.6.2 + semver: 7.6.3 slugify: 1.6.6 sucrase: 3.34.0 transitivePeerDependencies: @@ -20559,7 +20551,7 @@ snapshots: node-fetch: 2.7.0(encoding@0.1.13) parse-png: 2.1.0 resolve-from: 5.0.0 - semver: 7.6.2 + semver: 7.6.3 tempy: 0.3.0 transitivePeerDependencies: - encoding @@ -20631,7 +20623,7 @@ snapshots: expo-modules-autolinking: 1.11.1 fs-extra: 9.1.0 resolve-from: 5.0.0 - semver: 7.6.2 + semver: 7.6.3 xml2js: 0.6.0 transitivePeerDependencies: - encoding @@ -20976,7 +20968,7 @@ snapshots: nopt: 5.0.0 npmlog: 5.0.1 rimraf: 3.0.2 - semver: 7.6.2 + semver: 7.6.3 tar: 6.2.0 transitivePeerDependencies: - encoding @@ -21291,11 +21283,11 @@ snapshots: '@npmcli/fs@1.1.1': dependencies: '@gar/promisify': 1.1.3 - semver: 7.6.2 + semver: 7.6.3 '@npmcli/fs@3.1.0': dependencies: - semver: 7.6.2 + semver: 7.6.3 '@npmcli/git@5.0.3': dependencies: @@ -21305,7 +21297,7 @@ snapshots: proc-log: 3.0.0 promise-inflight: 1.0.1(bluebird@3.7.2) promise-retry: 2.0.1 - semver: 7.6.2 + semver: 7.6.3 which: 4.0.0 transitivePeerDependencies: - bluebird @@ -21556,7 +21548,7 @@ snapshots: hermes-profile-transformer: 0.0.6 node-stream-zip: 1.15.0 ora: 5.4.1 - semver: 7.6.2 + semver: 7.6.3 strip-ansi: 5.2.0 wcwidth: 1.0.1 yaml: 2.4.5 @@ -21627,7 +21619,7 @@ snapshots: node-fetch: 2.7.0(encoding@0.1.13) open: 6.4.0 ora: 5.4.1 - semver: 7.6.2 + semver: 7.6.3 shell-quote: 1.8.1 sudo-prompt: 9.2.1 transitivePeerDependencies: @@ -21655,7 +21647,7 @@ snapshots: fs-extra: 8.1.0 graceful-fs: 4.2.11 prompts: 2.4.2 - semver: 7.6.2 + semver: 7.6.3 transitivePeerDependencies: - bufferutil - encoding @@ -22327,7 +22319,7 @@ snapshots: chokidar: 3.6.0 kleur: 4.1.5 sade: 1.8.1 - semver: 7.6.2 + semver: 7.6.3 svelte: 4.2.18 svelte2tsx: 0.7.1(svelte@4.2.18)(typescript@5.4.2) transitivePeerDependencies: @@ -22434,7 +22426,7 @@ snapshots: '@swc/counter': 0.1.3 tslib: 2.6.2 - '@tanstack/config@0.9.8(@types/node@20.14.10)(esbuild@0.19.11)(eslint@8.57.0)(rollup@4.14.1)(typescript@5.3.3)(vite@5.3.3(@types/node@20.14.10)(less@4.2.0)(sass@1.71.1)(terser@5.29.1))': + '@tanstack/config@0.10.0(@types/node@20.14.10)(esbuild@0.19.11)(eslint@8.57.0)(rollup@4.14.1)(typescript@5.3.3)(vite@5.3.3(@types/node@20.14.10)(less@4.2.0)(sass@1.71.1)(terser@5.29.1))': dependencies: '@commitlint/parse': 19.0.3 '@eslint/js': 8.57.0 @@ -22449,9 +22441,12 @@ snapshots: liftoff: 5.0.0 minimist: 1.2.8 rollup-plugin-preserve-directives: 0.4.0(rollup@4.14.1) - semver: 7.6.2 + semver: 7.6.3 simple-git: 3.25.0 - typescript-eslint: 7.16.0(eslint@8.57.0)(typescript@5.3.3) + typedoc: 0.26.4(typescript@5.3.3) + typedoc-plugin-frontmatter: 1.0.0(typedoc-plugin-markdown@4.2.1(typedoc@0.26.4(typescript@5.3.3))) + typedoc-plugin-markdown: 4.2.1(typedoc@0.26.4(typescript@5.3.3)) + typescript-eslint: 7.16.1(eslint@8.57.0)(typescript@5.3.3) v8flags: 4.0.1 vite-plugin-dts: 3.9.1(@types/node@20.14.10)(rollup@4.14.1)(typescript@5.3.3)(vite@5.3.3(@types/node@20.14.10)(less@4.2.0)(sass@1.71.1)(terser@5.29.1)) vite-plugin-externalize-deps: 0.8.0(vite@5.3.3(@types/node@20.14.10)(less@4.2.0)(sass@1.71.1)(terser@5.29.1)) @@ -22807,14 +22802,14 @@ snapshots: dependencies: '@types/yargs-parser': 21.0.2 - '@typescript-eslint/eslint-plugin@7.16.0(@typescript-eslint/parser@7.16.0(eslint@8.57.0)(typescript@5.3.3))(eslint@8.57.0)(typescript@5.3.3)': + '@typescript-eslint/eslint-plugin@7.16.1(@typescript-eslint/parser@7.16.1(eslint@8.57.0)(typescript@5.3.3))(eslint@8.57.0)(typescript@5.3.3)': dependencies: '@eslint-community/regexpp': 4.11.0 - '@typescript-eslint/parser': 7.16.0(eslint@8.57.0)(typescript@5.3.3) - '@typescript-eslint/scope-manager': 7.16.0 - '@typescript-eslint/type-utils': 7.16.0(eslint@8.57.0)(typescript@5.3.3) - '@typescript-eslint/utils': 7.16.0(eslint@8.57.0)(typescript@5.3.3) - '@typescript-eslint/visitor-keys': 7.16.0 + '@typescript-eslint/parser': 7.16.1(eslint@8.57.0)(typescript@5.3.3) + '@typescript-eslint/scope-manager': 7.16.1 + '@typescript-eslint/type-utils': 7.16.1(eslint@8.57.0)(typescript@5.3.3) + '@typescript-eslint/utils': 7.16.1(eslint@8.57.0)(typescript@5.3.3) + '@typescript-eslint/visitor-keys': 7.16.1 eslint: 8.57.0 graphemer: 1.4.0 ignore: 5.3.1 @@ -22825,12 +22820,12 @@ snapshots: transitivePeerDependencies: - supports-color - '@typescript-eslint/parser@7.16.0(eslint@8.57.0)(typescript@5.3.3)': + '@typescript-eslint/parser@7.16.1(eslint@8.57.0)(typescript@5.3.3)': dependencies: - '@typescript-eslint/scope-manager': 7.16.0 - '@typescript-eslint/types': 7.16.0 - '@typescript-eslint/typescript-estree': 7.16.0(typescript@5.3.3) - '@typescript-eslint/visitor-keys': 7.16.0 + '@typescript-eslint/scope-manager': 7.16.1 + '@typescript-eslint/types': 7.16.1 + '@typescript-eslint/typescript-estree': 7.16.1(typescript@5.3.3) + '@typescript-eslint/visitor-keys': 7.16.1 debug: 4.3.5(supports-color@6.1.0) eslint: 8.57.0 optionalDependencies: @@ -22847,25 +22842,25 @@ snapshots: eslint: 8.57.0 json-stable-stringify-without-jsonify: 1.0.1 lodash.merge: 4.6.2 - semver: 7.6.2 + semver: 7.6.3 transitivePeerDependencies: - supports-color - typescript - '@typescript-eslint/scope-manager@7.16.0': + '@typescript-eslint/scope-manager@7.16.1': dependencies: - '@typescript-eslint/types': 7.16.0 - '@typescript-eslint/visitor-keys': 7.16.0 + '@typescript-eslint/types': 7.16.1 + '@typescript-eslint/visitor-keys': 7.16.1 '@typescript-eslint/scope-manager@8.0.0-alpha.30': dependencies: '@typescript-eslint/types': 8.0.0-alpha.30 '@typescript-eslint/visitor-keys': 8.0.0-alpha.30 - '@typescript-eslint/type-utils@7.16.0(eslint@8.57.0)(typescript@5.3.3)': + '@typescript-eslint/type-utils@7.16.1(eslint@8.57.0)(typescript@5.3.3)': dependencies: - '@typescript-eslint/typescript-estree': 7.16.0(typescript@5.3.3) - '@typescript-eslint/utils': 7.16.0(eslint@8.57.0)(typescript@5.3.3) + '@typescript-eslint/typescript-estree': 7.16.1(typescript@5.3.3) + '@typescript-eslint/utils': 7.16.1(eslint@8.57.0)(typescript@5.3.3) debug: 4.3.5(supports-color@6.1.0) eslint: 8.57.0 ts-api-utils: 1.3.0(typescript@5.3.3) @@ -22874,19 +22869,19 @@ snapshots: transitivePeerDependencies: - supports-color - '@typescript-eslint/types@7.16.0': {} + '@typescript-eslint/types@7.16.1': {} '@typescript-eslint/types@8.0.0-alpha.30': {} - '@typescript-eslint/typescript-estree@7.16.0(typescript@5.3.3)': + '@typescript-eslint/typescript-estree@7.16.1(typescript@5.3.3)': dependencies: - '@typescript-eslint/types': 7.16.0 - '@typescript-eslint/visitor-keys': 7.16.0 + '@typescript-eslint/types': 7.16.1 + '@typescript-eslint/visitor-keys': 7.16.1 debug: 4.3.5(supports-color@6.1.0) globby: 11.1.0 is-glob: 4.0.3 minimatch: 9.0.5 - semver: 7.6.2 + semver: 7.6.3 ts-api-utils: 1.3.0(typescript@5.3.3) optionalDependencies: typescript: 5.3.3 @@ -22901,19 +22896,19 @@ snapshots: globby: 11.1.0 is-glob: 4.0.3 minimatch: 9.0.5 - semver: 7.6.2 + semver: 7.6.3 ts-api-utils: 1.3.0(typescript@5.4.2) optionalDependencies: typescript: 5.4.2 transitivePeerDependencies: - supports-color - '@typescript-eslint/utils@7.16.0(eslint@8.57.0)(typescript@5.3.3)': + '@typescript-eslint/utils@7.16.1(eslint@8.57.0)(typescript@5.3.3)': dependencies: '@eslint-community/eslint-utils': 4.4.0(eslint@8.57.0) - '@typescript-eslint/scope-manager': 7.16.0 - '@typescript-eslint/types': 7.16.0 - '@typescript-eslint/typescript-estree': 7.16.0(typescript@5.3.3) + '@typescript-eslint/scope-manager': 7.16.1 + '@typescript-eslint/types': 7.16.1 + '@typescript-eslint/typescript-estree': 7.16.1(typescript@5.3.3) eslint: 8.57.0 transitivePeerDependencies: - supports-color @@ -22930,9 +22925,9 @@ snapshots: - supports-color - typescript - '@typescript-eslint/visitor-keys@7.16.0': + '@typescript-eslint/visitor-keys@7.16.1': dependencies: - '@typescript-eslint/types': 7.16.0 + '@typescript-eslint/types': 7.16.1 eslint-visitor-keys: 3.4.3 '@typescript-eslint/visitor-keys@8.0.0-alpha.30': @@ -23910,7 +23905,7 @@ snapshots: prompts: 2.4.2 rehype: 13.0.1 resolve: 1.22.8 - semver: 7.6.2 + semver: 7.6.3 shiki: 1.10.3 string-width: 7.1.0 strip-ansi: 7.1.0 @@ -24450,7 +24445,7 @@ snapshots: builtins@5.0.1: dependencies: - semver: 7.6.2 + semver: 7.6.3 bundle-name@3.0.0: dependencies: @@ -25304,7 +25299,7 @@ snapshots: postcss-modules-values: 3.0.0 postcss-value-parser: 4.2.0 schema-utils: 2.7.1 - semver: 7.6.2 + semver: 7.6.3 webpack: 4.44.2 css-loader@6.10.0(webpack@5.90.3(esbuild@0.19.11)): @@ -25316,7 +25311,7 @@ snapshots: postcss-modules-scope: 3.2.0(postcss@8.4.39) postcss-modules-values: 4.0.0(postcss@8.4.39) postcss-value-parser: 4.2.0 - semver: 7.6.2 + semver: 7.6.3 optionalDependencies: webpack: 5.90.3(esbuild@0.19.11) @@ -26297,12 +26292,12 @@ snapshots: eslint-compat-utils@0.5.1(eslint@8.57.0): dependencies: eslint: 8.57.0 - semver: 7.6.2 + semver: 7.6.3 eslint-compat-utils@0.5.1(eslint@9.4.0): dependencies: eslint: 9.4.0 - semver: 7.6.2 + semver: 7.6.3 eslint-import-resolver-node@0.3.9: dependencies: @@ -26322,7 +26317,7 @@ snapshots: eslint-plugin-import-x@3.0.1(eslint@8.57.0)(typescript@5.3.3): dependencies: '@rtsao/scc': 1.1.0 - '@typescript-eslint/utils': 7.16.0(eslint@8.57.0)(typescript@5.3.3) + '@typescript-eslint/utils': 7.16.1(eslint@8.57.0)(typescript@5.3.3) debug: 4.3.5(supports-color@6.1.0) doctrine: 3.0.0 eslint: 8.57.0 @@ -26330,7 +26325,7 @@ snapshots: get-tsconfig: 4.7.5 is-glob: 4.0.3 minimatch: 9.0.5 - semver: 7.6.2 + semver: 7.6.3 stable-hash: 0.0.4 tslib: 2.6.2 transitivePeerDependencies: @@ -26347,7 +26342,7 @@ snapshots: eslint: 9.4.0 esquery: 1.6.0 parse-imports: 2.1.1 - semver: 7.6.2 + semver: 7.6.3 spdx-expression-parse: 4.0.0 synckit: 0.9.0 transitivePeerDependencies: @@ -26363,7 +26358,7 @@ snapshots: globals: 15.8.0 ignore: 5.3.1 minimatch: 9.0.5 - semver: 7.6.2 + semver: 7.6.3 eslint-plugin-react-compiler@0.0.0-experimental-c8b3f72-20240517(eslint@9.4.0): dependencies: @@ -26386,9 +26381,9 @@ snapshots: '@eslint-react/tools': 1.5.17 '@eslint-react/types': 1.5.17(eslint@8.57.0)(typescript@5.3.3) '@eslint-react/var': 1.5.17(eslint@8.57.0)(typescript@5.3.3) - '@typescript-eslint/scope-manager': 7.16.0 - '@typescript-eslint/types': 7.16.0 - '@typescript-eslint/utils': 7.16.0(eslint@8.57.0)(typescript@5.3.3) + '@typescript-eslint/scope-manager': 7.16.1 + '@typescript-eslint/types': 7.16.1 + '@typescript-eslint/utils': 7.16.1(eslint@8.57.0)(typescript@5.3.3) effect: 3.4.5 eslint: 8.57.0 string-ts: 2.2.0 @@ -26407,10 +26402,10 @@ snapshots: '@eslint-react/tools': 1.5.17 '@eslint-react/types': 1.5.17(eslint@8.57.0)(typescript@5.3.3) '@eslint-react/var': 1.5.17(eslint@8.57.0)(typescript@5.3.3) - '@typescript-eslint/scope-manager': 7.16.0 - '@typescript-eslint/type-utils': 7.16.0(eslint@8.57.0)(typescript@5.3.3) - '@typescript-eslint/types': 7.16.0 - '@typescript-eslint/utils': 7.16.0(eslint@8.57.0)(typescript@5.3.3) + '@typescript-eslint/scope-manager': 7.16.1 + '@typescript-eslint/type-utils': 7.16.1(eslint@8.57.0)(typescript@5.3.3) + '@typescript-eslint/types': 7.16.1 + '@typescript-eslint/utils': 7.16.1(eslint@8.57.0)(typescript@5.3.3) effect: 3.4.5 eslint: 8.57.0 string-ts: 2.2.0 @@ -26432,10 +26427,10 @@ snapshots: '@eslint-react/shared': 1.5.17(eslint@8.57.0)(typescript@5.3.3) '@eslint-react/tools': 1.5.17 '@eslint-react/types': 1.5.17(eslint@8.57.0)(typescript@5.3.3) - '@typescript-eslint/scope-manager': 7.16.0 - '@typescript-eslint/type-utils': 7.16.0(eslint@8.57.0)(typescript@5.3.3) - '@typescript-eslint/types': 7.16.0 - '@typescript-eslint/utils': 7.16.0(eslint@8.57.0)(typescript@5.3.3) + '@typescript-eslint/scope-manager': 7.16.1 + '@typescript-eslint/type-utils': 7.16.1(eslint@8.57.0)(typescript@5.3.3) + '@typescript-eslint/types': 7.16.1 + '@typescript-eslint/utils': 7.16.1(eslint@8.57.0)(typescript@5.3.3) effect: 3.4.5 eslint: 8.57.0 string-ts: 2.2.0 @@ -26458,10 +26453,10 @@ snapshots: '@eslint-react/tools': 1.5.17 '@eslint-react/types': 1.5.17(eslint@8.57.0)(typescript@5.3.3) '@eslint-react/var': 1.5.17(eslint@8.57.0)(typescript@5.3.3) - '@typescript-eslint/scope-manager': 7.16.0 - '@typescript-eslint/type-utils': 7.16.0(eslint@8.57.0)(typescript@5.3.3) - '@typescript-eslint/types': 7.16.0 - '@typescript-eslint/utils': 7.16.0(eslint@8.57.0)(typescript@5.3.3) + '@typescript-eslint/scope-manager': 7.16.1 + '@typescript-eslint/type-utils': 7.16.1(eslint@8.57.0)(typescript@5.3.3) + '@typescript-eslint/types': 7.16.1 + '@typescript-eslint/utils': 7.16.1(eslint@8.57.0)(typescript@5.3.3) effect: 3.4.5 eslint: 8.57.0 string-ts: 2.2.0 @@ -26484,7 +26479,7 @@ snapshots: postcss-load-config: 3.1.4(postcss@8.4.39) postcss-safe-parser: 6.0.0(postcss@8.4.39) postcss-selector-parser: 6.1.0 - semver: 7.6.2 + semver: 7.6.3 svelte-eslint-parser: 0.40.0(svelte@4.2.18) optionalDependencies: svelte: 4.2.18 @@ -26499,7 +26494,7 @@ snapshots: natural-compare: 1.4.0 nth-check: 2.1.1 postcss-selector-parser: 6.1.0 - semver: 7.6.2 + semver: 7.6.3 vue-eslint-parser: 9.4.3(eslint@9.4.0) xml-name-validator: 4.0.0 transitivePeerDependencies: @@ -27201,7 +27196,7 @@ snapshots: memfs: 3.5.3 minimatch: 3.1.2 schema-utils: 2.7.0 - semver: 7.6.2 + semver: 7.6.3 tapable: 1.1.3 typescript: 5.4.2 webpack: 5.90.3(esbuild@0.19.11) @@ -28513,7 +28508,7 @@ snapshots: '@babel/parser': 7.24.6 '@istanbuljs/schema': 0.1.3 istanbul-lib-coverage: 3.2.2 - semver: 7.6.2 + semver: 7.6.3 transitivePeerDependencies: - supports-color @@ -29257,7 +29252,7 @@ snapshots: make-dir@4.0.0: dependencies: - semver: 7.6.2 + semver: 7.6.3 make-fetch-happen@13.0.0: dependencies: @@ -30360,7 +30355,7 @@ snapshots: rollup: 4.14.1 rollup-plugin-visualizer: 5.12.0(rollup@4.14.1) scule: 1.3.0 - semver: 7.6.2 + semver: 7.6.3 serve-placeholder: 2.0.1 serve-static: 1.15.0(supports-color@6.1.0) std-env: 3.7.0 @@ -30443,7 +30438,7 @@ snapshots: make-fetch-happen: 13.0.0 nopt: 7.2.0 proc-log: 3.0.0 - semver: 7.6.2 + semver: 7.6.3 tar: 6.2.0 which: 4.0.0 transitivePeerDependencies: @@ -30497,7 +30492,7 @@ snapshots: dependencies: hosted-git-info: 7.0.1 is-core-module: 2.13.1 - semver: 7.6.2 + semver: 7.6.3 validate-npm-package-license: 3.0.4 normalize-path@2.1.1: @@ -30529,7 +30524,7 @@ snapshots: npm-install-checks@6.3.0: dependencies: - semver: 7.6.2 + semver: 7.6.3 npm-normalize-package-bin@2.0.0: {} @@ -30539,7 +30534,7 @@ snapshots: dependencies: hosted-git-info: 7.0.1 proc-log: 3.0.0 - semver: 7.6.2 + semver: 7.6.3 validate-npm-package-name: 5.0.0 npm-package-arg@7.0.0: @@ -30565,7 +30560,7 @@ snapshots: npm-install-checks: 6.3.0 npm-normalize-package-bin: 3.0.1 npm-package-arg: 11.0.1 - semver: 7.6.2 + semver: 7.6.3 npm-registry-fetch@16.1.0: dependencies: @@ -30639,7 +30634,7 @@ snapshots: npm-run-path: 4.0.1 open: 8.4.2 ora: 5.3.0 - semver: 7.6.2 + semver: 7.6.3 string-width: 4.2.3 strong-log-transformer: 2.1.0 tar-stream: 2.2.0 @@ -31550,7 +31545,7 @@ snapshots: cosmiconfig: 7.1.0 klona: 2.0.6 postcss: 8.4.39 - semver: 7.6.2 + semver: 7.6.3 webpack: 5.90.3(esbuild@0.19.11) postcss-loader@8.1.1(postcss@8.4.35)(typescript@5.3.3)(webpack@5.90.3(esbuild@0.20.1)): @@ -31558,7 +31553,7 @@ snapshots: cosmiconfig: 9.0.0(typescript@5.3.3) jiti: 1.21.6 postcss: 8.4.35 - semver: 7.6.2 + semver: 7.6.3 optionalDependencies: webpack: 5.90.3(esbuild@0.19.11) transitivePeerDependencies: @@ -32725,7 +32720,7 @@ snapshots: resolve: 1.22.8 resolve-url-loader: 4.0.0(rework-visit@1.0.0)(rework@1.0.1) sass-loader: 12.6.0(sass@1.71.1)(webpack@5.90.3(esbuild@0.19.11)) - semver: 7.6.2 + semver: 7.6.3 source-map-loader: 3.0.2(webpack@5.90.3(esbuild@0.19.11)) style-loader: 3.3.3(webpack@5.90.3(esbuild@0.19.11)) tailwindcss: 3.4.3 @@ -33359,7 +33354,7 @@ snapshots: loader-utils: 2.0.4 neo-async: 2.6.2 schema-utils: 3.3.0 - semver: 7.6.2 + semver: 7.6.3 webpack: 4.44.2 optionalDependencies: sass: 1.71.1 @@ -33466,7 +33461,7 @@ snapshots: dependencies: lru-cache: 6.0.0 - semver@7.6.2: {} + semver@7.6.3: {} send@0.18.0(supports-color@6.1.0): dependencies: @@ -33581,7 +33576,7 @@ snapshots: dependencies: color: 4.2.3 detect-libc: 2.0.3 - semver: 7.6.2 + semver: 7.6.3 optionalDependencies: '@img/sharp-darwin-arm64': 0.33.4 '@img/sharp-darwin-x64': 0.33.4 @@ -34916,13 +34911,13 @@ snapshots: typescript-auto-import-cache@0.3.3: dependencies: - semver: 7.6.2 + semver: 7.6.3 - typescript-eslint@7.16.0(eslint@8.57.0)(typescript@5.3.3): + typescript-eslint@7.16.1(eslint@8.57.0)(typescript@5.3.3): dependencies: - '@typescript-eslint/eslint-plugin': 7.16.0(@typescript-eslint/parser@7.16.0(eslint@8.57.0)(typescript@5.3.3))(eslint@8.57.0)(typescript@5.3.3) - '@typescript-eslint/parser': 7.16.0(eslint@8.57.0)(typescript@5.3.3) - '@typescript-eslint/utils': 7.16.0(eslint@8.57.0)(typescript@5.3.3) + '@typescript-eslint/eslint-plugin': 7.16.1(@typescript-eslint/parser@7.16.1(eslint@8.57.0)(typescript@5.3.3))(eslint@8.57.0)(typescript@5.3.3) + '@typescript-eslint/parser': 7.16.1(eslint@8.57.0)(typescript@5.3.3) + '@typescript-eslint/utils': 7.16.1(eslint@8.57.0)(typescript@5.3.3) eslint: 8.57.0 optionalDependencies: typescript: 5.3.3 @@ -35594,7 +35589,7 @@ snapshots: volar-service-typescript@0.0.59(@volar/language-service@2.4.0-alpha.16): dependencies: path-browserify: 1.0.1 - semver: 7.6.2 + semver: 7.6.3 typescript-auto-import-cache: 0.3.3 vscode-languageserver-textdocument: 1.0.11 vscode-nls: 5.2.0 @@ -35652,7 +35647,7 @@ snapshots: espree: 9.6.1 esquery: 1.6.0 lodash: 4.17.21 - semver: 7.6.2 + semver: 7.6.3 transitivePeerDependencies: - supports-color @@ -35665,21 +35660,21 @@ snapshots: dependencies: '@volar/typescript': 1.11.1 '@vue/language-core': 1.8.27(typescript@5.3.3) - semver: 7.6.2 + semver: 7.6.3 typescript: 5.3.3 vue-tsc@2.0.26(typescript@5.3.3): dependencies: '@volar/typescript': 2.4.0-alpha.16 '@vue/language-core': 2.0.26(typescript@5.3.3) - semver: 7.6.2 + semver: 7.6.3 typescript: 5.3.3 vue-tsc@2.0.26(typescript@5.4.2): dependencies: '@volar/typescript': 2.4.0-alpha.16 '@vue/language-core': 2.0.26(typescript@5.4.2) - semver: 7.6.2 + semver: 7.6.3 typescript: 5.4.2 vue@2.6.0: {} diff --git a/scripts/generateDocs.js b/scripts/generateDocs.js new file mode 100644 index 0000000000..fdf6aac0a7 --- /dev/null +++ b/scripts/generateDocs.js @@ -0,0 +1,32 @@ +import { resolve } from 'node:path' +import { fileURLToPath } from 'node:url' +import { generateReferenceDocs } from '@tanstack/config/typedoc' + +const __dirname = fileURLToPath(new URL('.', import.meta.url)) + +/** @type {import('@tanstack/config/typedoc').Package[]} */ +const packages = [ + { + name: 'angular-query-experimental', + entryPoints: [ + resolve(__dirname, '../packages/angular-query-experimental/src/index.ts'), + ], + tsconfig: resolve( + __dirname, + '../packages/angular-query-experimental/tsconfig.json', + ), + outputDir: resolve(__dirname, '../docs/framework/angular/reference'), + exclude: ['./packages/query-core/**/*'], + }, + { + name: 'svelte-query', + entryPoints: [resolve(__dirname, '../packages/svelte-query/src/index.ts')], + tsconfig: resolve(__dirname, '../packages/svelte-query/tsconfig.json'), + outputDir: resolve(__dirname, '../docs/framework/svelte/reference'), + exclude: ['./packages/query-core/**/*'], + }, +] + +await generateReferenceDocs({ packages }) + +process.exit(0) diff --git a/scripts/reference-docs.js b/scripts/reference-docs.js deleted file mode 100644 index f4767a045d..0000000000 --- a/scripts/reference-docs.js +++ /dev/null @@ -1,78 +0,0 @@ -import { resolve } from 'node:path' -import { fileURLToPath } from 'node:url' -import { mkdir, rm } from 'node:fs/promises' -import * as TypeDoc from 'typedoc' - -const __dirname = fileURLToPath(new URL('.', import.meta.url)) - -/** - * @type {Partial} - */ -const options = { - plugin: [ - 'typedoc-plugin-markdown', - 'typedoc-plugin-frontmatter', - resolve(__dirname, './typedoc-remove-prefix.js'), - ], - hideGenerator: true, - readme: 'none', - flattenOutputFiles: true, - entryFileName: 'index', - hideBreadcrumbs: true, - hidePageHeader: true, - useCodeBlocks: true, - excludePrivate: true, -} - -/** @type {Array<{name: string, entryPoints: Array, tsconfig: string, outputDir: string, exclude?: Array}>} */ -const packages = [ - { - name: 'angular-query-experimental', - entryPoints: [ - resolve(__dirname, '../packages/angular-query-experimental/src/index.ts'), - ], - tsconfig: resolve( - __dirname, - '../packages/angular-query-experimental/tsconfig.json', - ), - outputDir: resolve(__dirname, '../docs/framework/angular/reference'), - exclude: ['./packages/query-core/**/*'], - }, - { - name: 'svelte-query', - entryPoints: [resolve(__dirname, '../packages/svelte-query/src/index.ts')], - tsconfig: resolve(__dirname, '../packages/svelte-query/tsconfig.json'), - outputDir: resolve(__dirname, '../docs/framework/svelte/reference'), - exclude: ['./packages/query-core/**/*'], - }, -] - -async function main() { - for (const pkg of packages) { - // Clean and recreate the output directories - try { - await rm(pkg.outputDir, { recursive: true }) - } catch (error) { - // @ts-expect-error - if (error.code !== 'ENOENT') { - throw error - } - } - await mkdir(pkg.outputDir, { recursive: true }) - - const app = await TypeDoc.Application.bootstrapWithPlugins({ - ...options, - entryPoints: pkg.entryPoints, - tsconfig: pkg.tsconfig, - exclude: pkg.exclude, - }) - - const project = await app.convert() - - if (project) { - await app.generateDocs(project, pkg.outputDir) - } - } -} - -main().catch(console.error) diff --git a/scripts/typedoc-remove-prefix.js b/scripts/typedoc-remove-prefix.js deleted file mode 100644 index fe00189d7d..0000000000 --- a/scripts/typedoc-remove-prefix.js +++ /dev/null @@ -1,39 +0,0 @@ -import { - MarkdownPageEvent, - MarkdownRendererEvent, -} from 'typedoc-plugin-markdown' - -/** - * @param {import("typedoc-plugin-markdown").MarkdownApplication} app - */ -export function load(app) { - // Add `id` and `title` to frontmatter - app.renderer.on( - MarkdownPageEvent.BEGIN, - /** @param {import('typedoc-plugin-markdown').MarkdownPageEvent} page */ - (page) => { - page.frontmatter = { - id: page.model.name, - title: page.model.name, - } - }, - ) - // 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.split('.') - if (name[0] !== 'index') { - name.splice(0, 1) - } - const newBasename = name.join('.') - urlMapping.url = newBasename - urlMapping.model.url = newBasename - return urlMapping - }) - }, - ) -}