build: adjust dts test setup

KelvinHUNG11 · Feb 3, 2023 · 1ddde63 · 1ddde63
1 parent d10a81e
commit 1ddde63
Show file tree

Hide file tree

Showing 28 changed files with 50 additions and 45 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -32,7 +32,7 @@ module.exports = {
   overrides: [
     // tests, no restrictions (runs in Node / jest with jsdom)
     {
-      files: ['**/__tests__/**', 'test-dts/**'],
+      files: ['**/__tests__/**', 'packages/dts-test/**'],
       rules: {
         'no-restricted-globals': 'off',
         'no-restricted-syntax': 'off',

diff --git a/package.json b/package.json
@@ -17,7 +17,7 @@
     "test-unit": "vitest -c vitest.unit.config.ts",
     "test-e2e": "node scripts/build.mjs vue -f global -d && vitest -c vitest.e2e.config.ts",
     "test-dts": "run-s build-dts test-dts-only",
-    "test-dts-only": "tsc -p ./test-dts/tsconfig.build.json",
+    "test-dts-only": "tsc -p ./packages/dts-test/tsconfig.test.json",
     "test-coverage": "vitest -c vitest.unit.config.ts --coverage",
     "release": "node scripts/release.mjs",
     "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s",
@@ -37,7 +37,6 @@
     "preinstall": "node ./scripts/preinstall.mjs",
     "postinstall": "simple-git-hooks"
   },
-  "types": "test-dts/index.d.ts",
   "simple-git-hooks": {
     "pre-commit": "pnpm lint-staged && pnpm check",
     "commit-msg": "node scripts/verifyCommit.mjs"
@@ -69,9 +68,6 @@
     "@typescript-eslint/parser": "^5.23.0",
     "@vitest/coverage-istanbul": "^0.28.2",
     "@vue/consolidate": "0.17.3",
-    "@vue/reactivity": "workspace:*",
-    "@vue/runtime-core": "workspace:*",
-    "@vue/runtime-dom": "workspace:*",
     "brotli": "^1.3.2",
     "chalk": "^4.1.0",
     "conventional-changelog-cli": "^2.0.31",
@@ -105,7 +101,6 @@
     "tslib": "^2.4.0",
     "typescript": "^4.9.0",
     "vite": "^4.0.4",
-    "vitest": "^0.28.2",
-    "vue": "workspace:*"
+    "vitest": "^0.28.2"
   }
 }
diff --git a/packages/dts-test/README.md b/packages/dts-test/README.md
@@ -0,0 +1,7 @@
+# dts-test
+
+Tests Typescript types to ensure the types remain as expected.
+
+- This directory is included in the root `tsconfig.json`, where package imports are aliased to `src` directories, so in IDEs and the `pnpm check` script the types are validated against source code.
+
+- When runnong `tsc` with `packages/dts-test/tsconfig.test.json`, packages are resolved using using normal `node` resolution, so the types are validated against actual **built** types. This requires the types to be built first via `pnpm build-types`.
diff --git a/test-dts/appUse.test-d.ts → packages/dts-test/appUse.test-d.ts b/test-dts/appUse.test-d.ts → packages/dts-test/appUse.test-d.ts
diff --git a/test-dts/compiler.test-d.ts → packages/dts-test/compiler.test-d.ts b/test-dts/compiler.test-d.ts → packages/dts-test/compiler.test-d.ts
diff --git a/test-dts/component.test-d.ts → packages/dts-test/component.test-d.ts b/test-dts/component.test-d.ts → packages/dts-test/component.test-d.ts
diff --git a/test-dts/componentTypeExtensions.test-d.tsx → ...s-test/componentTypeExtensions.test-d.tsx b/test-dts/componentTypeExtensions.test-d.tsx → ...s-test/componentTypeExtensions.test-d.tsx
diff --git a/test-dts/defineComponent.test-d.tsx → packages/dts-test/defineComponent.test-d.tsx b/test-dts/defineComponent.test-d.tsx → packages/dts-test/defineComponent.test-d.tsx
diff --git a/test-dts/defineCustomElement.test-d.ts → ...es/dts-test/defineCustomElement.test-d.ts b/test-dts/defineCustomElement.test-d.ts → ...es/dts-test/defineCustomElement.test-d.ts
diff --git a/test-dts/functionalComponent.test-d.tsx → ...s/dts-test/functionalComponent.test-d.tsx b/test-dts/functionalComponent.test-d.tsx → ...s/dts-test/functionalComponent.test-d.tsx
diff --git a/test-dts/h.test-d.ts → packages/dts-test/h.test-d.ts b/test-dts/h.test-d.ts → packages/dts-test/h.test-d.ts
diff --git a/test-dts/index.d.ts → packages/dts-test/index.d.ts b/test-dts/index.d.ts → packages/dts-test/index.d.ts
@@ -1,7 +1,7 @@
 // This directory contains a number of d.ts assertions
 // use \@ts-expect-error where errors are expected.
 
-export * from '@vue/runtime-dom'
+export * from 'vue'
 
 export function describe(_name: string, _fn: () => void): void
 export function test(_name: string, _fn: () => any): void

diff --git a/test-dts/inject.test-d.ts → packages/dts-test/inject.test-d.ts b/test-dts/inject.test-d.ts → packages/dts-test/inject.test-d.ts
diff --git a/packages/dts-test/package.json b/packages/dts-test/package.json
@@ -0,0 +1,10 @@
+{
+  "name": "dts-test",
+  "private": true,
+  "dependencies": {
+    "vue": "workspace:*",
+    "@vue/runtime-core": "workspace:*",
+    "@vue/runtime-dom": "workspace:*",
+    "@vue/reactivity": "workspace:*"
+  }
+}
diff --git a/test-dts/reactivity.test-d.ts → packages/dts-test/reactivity.test-d.ts b/test-dts/reactivity.test-d.ts → packages/dts-test/reactivity.test-d.ts
diff --git a/test-dts/reactivityMacros.test-d.ts → packages/dts-test/reactivityMacros.test-d.ts b/test-dts/reactivityMacros.test-d.ts → packages/dts-test/reactivityMacros.test-d.ts
@@ -1,5 +1,11 @@
-import { WritableComputedRef } from '@vue/reactivity'
-import { expectType, ref, computed, Ref, ComputedRef } from './index'
+import {
+  expectType,
+  ref,
+  computed,
+  Ref,
+  ComputedRef,
+  WritableComputedRef
+} from './index'
 import 'vue/macros-global'
 import { RefType, RefTypes } from 'vue/macros'
 

diff --git a/test-dts/ref.test-d.ts → packages/dts-test/ref.test-d.ts b/test-dts/ref.test-d.ts → packages/dts-test/ref.test-d.ts
diff --git a/test-dts/setupHelpers.test-d.ts → packages/dts-test/setupHelpers.test-d.ts b/test-dts/setupHelpers.test-d.ts → packages/dts-test/setupHelpers.test-d.ts
diff --git a/test-dts/tsconfig.build.json → packages/dts-test/tsconfig.test.json b/test-dts/tsconfig.build.json → packages/dts-test/tsconfig.test.json
diff --git a/test-dts/tsx.test-d.tsx → packages/dts-test/tsx.test-d.tsx b/test-dts/tsx.test-d.tsx → packages/dts-test/tsx.test-d.tsx
diff --git a/test-dts/watch.test-d.ts → packages/dts-test/watch.test-d.ts b/test-dts/watch.test-d.ts → packages/dts-test/watch.test-d.ts
diff --git a/packages/runtime-core/src/apiSetupHelpers.ts b/packages/runtime-core/src/apiSetupHelpers.ts
@@ -1,4 +1,3 @@
-import { ComponentPropsOptions } from '@vue/runtime-core'
 import { isArray, isPromise, isFunction } from '@vue/shared'
 import {
   getCurrentInstance,
@@ -8,7 +7,11 @@ import {
   unsetCurrentInstance
 } from './component'
 import { EmitFn, EmitsOptions } from './componentEmits'
-import { ComponentObjectPropsOptions, ExtractPropTypes } from './componentProps'
+import {
+  ComponentPropsOptions,
+  ComponentObjectPropsOptions,
+  ExtractPropTypes
+} from './componentProps'
 import { warn } from './warning'
 
 // dev only

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/scripts/aliases.mjs b/scripts/aliases.mjs
@@ -22,7 +22,8 @@ const entries = {
 const nonSrcPackages = [
   'sfc-playground',
   'size-check',
-  'template-explorer'
+  'template-explorer',
+  'dts-test'
 ]
 
 for (const dir of dirs) {

diff --git a/test-dts/README.md b/test-dts/README.md
diff --git a/test-dts/tsconfig.json b/test-dts/tsconfig.json
diff --git a/tsconfig.build.json b/tsconfig.build.json
@@ -10,6 +10,6 @@
     "packages/template-explorer",
     "packages/sfc-playground",
     "packages/size-check",
-    "test-dts"
+    "packages/dts-test"
   ]
 }
diff --git a/tsconfig.json b/tsconfig.json
@@ -32,6 +32,6 @@
     "packages/*/src",
     "packages/runtime-dom/types/jsx.d.ts",
     "packages/*/__tests__",
-    "test-dts"
+    "packages/dts-test"
   ]
 }