From c289e7e3ccd2f743ca8da29384c39982b78386ac Mon Sep 17 00:00:00 2001 From: bcakmakoglu <78412429+bcakmakoglu@users.noreply.github.com> Date: Tue, 7 Jun 2022 22:49:59 +0200 Subject: [PATCH] docs: update typedoc to use src/index.ts as entry # What's changed? * use src/index.ts as entry for typedocs instead of dist/index.d.ts (otherwise crashes with new vue-tsc version) * update tsconfigs * update turbo config and skip building d.ts files for typedocs --- packages/vue-flow/package.json | 2 +- packages/vue-flow/tsconfig.build.json | 2 +- packages/vue-flow/tsconfig.docs.json | 3 ++- turbo.json | 1 - 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/packages/vue-flow/package.json b/packages/vue-flow/package.json index cfff8a30..1b21f585 100644 --- a/packages/vue-flow/package.json +++ b/packages/vue-flow/package.json @@ -25,7 +25,7 @@ "prepare": "ts-patch install -s", "build": "vite build", "types": "pnpm prepare && vue-tsc --declaration --emitDeclarationOnly && tsc -p tsconfig.build.json && shx rm -rf tmp && pnpm lint:dist", - "typedoc": "typedoc --tsconfig tsconfig.docs.json dist/index.d.ts --out typedocs", + "typedoc": "typedoc --tsconfig tsconfig.docs.json src/index.ts --out typedocs", "theme": "postcss src/style.css -o dist/style.css && postcss src/theme-default.css -o dist/theme-default.css", "lint": "eslint --ext \".js,.jsx,.ts,.tsx\" --fix --ignore-path ../../.gitignore .", "lint:dist": "eslint --ext \".ts,.tsx\" -c .eslintrc.js --fix ./dist", diff --git a/packages/vue-flow/tsconfig.build.json b/packages/vue-flow/tsconfig.build.json index 3f9774d8..f64ef1f4 100644 --- a/packages/vue-flow/tsconfig.build.json +++ b/packages/vue-flow/tsconfig.build.json @@ -16,8 +16,8 @@ "noUnusedLocals": false, "strictNullChecks": true, "forceConsistentCasingInFileNames": true, - "jsx": "preserve", "types": ["vite/client", "vue/macros"], + "jsx": "preserve", "paths": { "~/*": ["src/*"] }, diff --git a/packages/vue-flow/tsconfig.docs.json b/packages/vue-flow/tsconfig.docs.json index e8dcb962..7ccf4e95 100644 --- a/packages/vue-flow/tsconfig.docs.json +++ b/packages/vue-flow/tsconfig.docs.json @@ -1,6 +1,5 @@ { "compilerOptions": { - "outDir": "./tmp", "baseUrl": ".", "module": "ESNext", "target": "es2017", @@ -15,6 +14,7 @@ "strictNullChecks": true, "forceConsistentCasingInFileNames": true, "types": ["vite/client"], + "jsx": "preserve", "paths": { "~/*": ["src/*"] }, @@ -23,5 +23,6 @@ { "transform": "typescript-transform-paths", "afterDeclarations": true } ] }, + "include": ["dist", "src"], "exclude": ["node_modules"] } diff --git a/turbo.json b/turbo.json index 5f16a486..96888559 100644 --- a/turbo.json +++ b/turbo.json @@ -12,7 +12,6 @@ "outputs": ["dist/**"] }, "typedoc": { - "dependsOn": ["types"], "outputs": ["typedocs/**"] }, "theme": {