Allow to write typetests by tsd

igorkamyshev · Jul 7, 2022 · 69cf11b · 69cf11b
1 parent ffff105
commit 69cf11b
Show file tree

Hide file tree

Showing 11 changed files with 372 additions and 20 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -27,6 +27,7 @@ jobs:
           cache: 'pnpm'
       - run: pnpm install --frozen-lockfile
       - run: pnpm nx affected:test
+      - run: pnpm nx affected --target=typetest
       - run: pnpm nx affected:lint
       - run: pnpm nx format:check
       - run: pnpm typecheck

diff --git a/README.md b/README.md
@@ -70,6 +70,7 @@ Continue reading about `farfetched` in the [documentation](./docs/README.md). It
 - make changes
 - make sure that your changes is passing checks:
   - run tests via `pnpm nx affected:test`
+  - run type tests via `pnpm nx affected --target=typetest`
   - run linter via `pnpm nx affected:lint`
   - format code via `pnpm nx format:write`
   - type correctness via `pnpm typecheck`

diff --git a/package.json b/package.json
@@ -8,6 +8,7 @@
   "private": true,
   "devDependencies": {
     "@nrwl/cli": "14.4.1",
+    "@nrwl/devkit": "^14.4.2",
     "@nrwl/eslint-plugin-nx": "14.4.1",
     "@nrwl/jest": "14.4.1",
     "@nrwl/js": "14.4.1",
@@ -25,6 +26,7 @@
     "prettier": "^2.6.2",
     "ts-jest": "27.1.4",
     "ts-node": "~10.8.0",
+    "tsd": "^0.22.0",
     "typescript": "~4.7.2"
   }
 }
diff --git a/packages/core/project.json b/packages/core/project.json
@@ -5,16 +5,12 @@
   "targets": {
     "build": {
       "executor": "@nrwl/js:tsc",
-      "outputs": [
-        "{options.outputPath}"
-      ],
+      "outputs": ["{options.outputPath}"],
       "options": {
         "outputPath": "dist/packages/core",
         "main": "packages/core/src/index.ts",
         "tsConfig": "packages/core/tsconfig.lib.json",
-        "assets": [
-          "packages/core/*.md"
-        ]
+        "assets": ["packages/core/*.md"]
       }
     },
     "publish": {
@@ -31,28 +27,23 @@
     },
     "lint": {
       "executor": "@nrwl/linter:eslint",
-      "outputs": [
-        "{options.outputFile}"
-      ],
+      "outputs": ["{options.outputFile}"],
       "options": {
-        "lintFilePatterns": [
-          "packages/core/**/*.ts"
-        ]
+        "lintFilePatterns": ["packages/core/**/*.ts"]
       }
     },
     "test": {
       "executor": "@nrwl/jest:jest",
-      "outputs": [
-        "coverage/packages/core"
-      ],
+      "outputs": ["coverage/packages/core"],
       "options": {
         "jestConfig": "packages/core/jest.config.ts",
         "passWithNoTests": true
       }
+    },
+    "typetest": {
+      "executor": "./tools/executors/tsd:tsd"
     }
   },
-  "implicitDependencies": [
-    "!test-utils"
-  ],
+  "implicitDependencies": ["!test-utils"],
   "tags": []
-}
+}
diff --git a/packages/core/src/query/__tests__/create_query.spec.ts b/packages/core/src/query/__tests__/create_query.spec.ts
@@ -1,5 +1,5 @@
 import { allSettled, createEffect, fork } from 'effector';
-import { Contract } from '../../contract/type';
+
 import { createQuery } from '../create_query';
 
 describe('core/createQuery/handler', () => {

diff --git a/packages/core/src/query/__tests__/create_query.type_spec.ts b/packages/core/src/query/__tests__/create_query.type_spec.ts
@@ -0,0 +1,3 @@
+import { expectType } from 'tsd';
+
+expectType<number>(1 as number);
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		import { expectType } from 'tsd';

		expectType<number>(1 as number);