Merge pull request #3764 from reduxjs/feature/rtk-codemods-vitest

markerikson · web-flow · commit 32a7dcfb95c2 · 2023-10-01T21:10:45.000-04:00
diff --git a/packages/rtk-codemods/.eslintrc.js b/packages/rtk-codemods/.eslintrc.js
@@ -4,7 +4,7 @@ module.exports = {
   },
 
   plugins: ['prettier', 'node'],
-  extends: ['eslint:recommended', 'plugin:prettier/recommended', 'plugin:node/recommended'],
+  extends: ['eslint:recommended', 'plugin:prettier/recommended'],
   env: {
     node: true,
   },
diff --git a/packages/rtk-codemods/jest.config.js b/packages/rtk-codemods/jest.config.js
diff --git a/packages/rtk-codemods/package.json b/packages/rtk-codemods/package.json
@@ -3,8 +3,8 @@
   "version": "0.0.3",
   "scripts": {
     "lint": "eslint --cache .",
-    "test": "codemod-cli test",
-    "test:coverage": "codemod-cli test --coverage",
+    "test": "vitest",
+    "test:coverage": "vitest --coverage",
     "update-docs": "codemod-cli update-docs"
   },
   "bin": "./bin/cli.js",
@@ -22,23 +22,19 @@
     "codemod"
   ],
   "dependencies": {
-    "@types/jest": "^27",
     "@types/jscodeshift": "^0.11.5",
     "codemod-cli": "^3.2.0",
-    "ts-node": "10.4.0",
     "typescript": "^4.8.0"
   },
   "devDependencies": {
     "eslint": "^7.25.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^3.4.0",
-    "jest": "^27",
-    "prettier": "^2.2.1",
-    "ts-jest": "^27"
+    "prettier": "^2.2.1"
   },
   "engines": {
-    "node": ">= 14"
+    "node": ">= 16"
   },
   "publishConfig": {
     "access": "public"
diff --git a/packages/rtk-codemods/transformTestUtils.ts b/packages/rtk-codemods/transformTestUtils.ts
@@ -0,0 +1,61 @@
+import { describe, vi } from 'vitest';
+import type { Transform } from 'jscodeshift';
+import globby from 'globby';
+import fs from 'fs-extra';
+import path from 'path';
+import { runInlineTest } from 'jscodeshift/dist/testUtils';
+
+export function runTransformTest(
+  name: string,
+  transform: Transform,
+  parser: string,
+  fixturePath: string
+) {
+  describe(name, function () {
+    globby
+      .sync('**/*.input.*', {
+        cwd: fixturePath,
+        absolute: true,
+      })
+      .map((entry) => entry.slice(fixturePath.length))
+      .forEach((filename) => {
+        let extension = path.extname(filename);
+        let testName = filename.replace(`.input${extension}`, '');
+        let testInputPath = path.join(fixturePath, `${testName}${extension}`);
+        let inputPath = path.join(fixturePath, `${testName}.input${extension}`);
+        let outputPath = path.join(fixturePath, `${testName}.output${extension}`);
+        let optionsPath = path.join(fixturePath, `${testName}.options.json`);
+        let options = fs.pathExistsSync(optionsPath) ? fs.readFileSync(optionsPath) : '{}';
+
+        describe(testName, function () {
+          beforeEach(function () {
+            process.env.CODEMOD_CLI_ARGS = options;
+          });
+
+          afterEach(function () {
+            process.env.CODEMOD_CLI_ARGS = '';
+          });
+
+          it('transforms correctly', function () {
+            runInlineTest(
+              transform,
+              {},
+              { path: testInputPath, source: fs.readFileSync(inputPath, 'utf8') },
+              fs.readFileSync(outputPath, 'utf8'),
+              { parser }
+            );
+          });
+
+          it('is idempotent', function () {
+            runInlineTest(
+              transform,
+              {},
+              { path: testInputPath, source: fs.readFileSync(outputPath, 'utf8') },
+              fs.readFileSync(outputPath, 'utf8'),
+              { parser }
+            );
+          });
+        });
+      });
+  });
+}
diff --git a/packages/rtk-codemods/transforms/createReducerBuilder/createReducerBuilder.test.ts b/packages/rtk-codemods/transforms/createReducerBuilder/createReducerBuilder.test.ts
@@ -0,0 +1,11 @@
+import path from 'path';
+import transform, { parser } from './index';
+
+import { runTransformTest } from '../../transformTestUtils';
+
+runTransformTest(
+  'createReducerBuilder',
+  transform,
+  parser,
+  path.join(__dirname, '__testfixtures__')
+);
diff --git a/packages/rtk-codemods/transforms/createReducerBuilder/test.js b/packages/rtk-codemods/transforms/createReducerBuilder/test.js
diff --git a/packages/rtk-codemods/transforms/createSliceBuilder/createSliceBuilder.test.ts b/packages/rtk-codemods/transforms/createSliceBuilder/createSliceBuilder.test.ts
@@ -0,0 +1,6 @@
+import path from 'path';
+import transform, { parser } from './index';
+
+import { runTransformTest } from '../../transformTestUtils';
+
+runTransformTest('createSliceBuilder', transform, parser, path.join(__dirname, '__testfixtures__'));
diff --git a/packages/rtk-codemods/transforms/createSliceBuilder/test.js b/packages/rtk-codemods/transforms/createSliceBuilder/test.js
diff --git a/packages/rtk-codemods/vitest.config.ts b/packages/rtk-codemods/vitest.config.ts
@@ -0,0 +1,13 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    globals: true,
+    setupFiles: [],
+    include: ['./transforms/**/*.(spec|test).[jt]s?(x)'],
+    alias: {},
+    deps: {
+      interopDefault: true,
+    },
+  },
+});
diff --git a/yarn.lock b/yarn.lock
@@ -6926,17 +6926,13 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "@reduxjs/rtk-codemods@workspace:packages/rtk-codemods"
   dependencies:
-    "@types/jest": ^27
     "@types/jscodeshift": ^0.11.5
     codemod-cli: ^3.2.0
     eslint: ^7.25.0
     eslint-config-prettier: ^8.3.0
     eslint-plugin-node: ^11.1.0
     eslint-plugin-prettier: ^3.4.0
-    jest: ^27
     prettier: ^2.2.1
-    ts-jest: ^27
-    ts-node: 10.4.0
     typescript: ^4.8.0
   bin:
     rtk-codemods: ./bin/cli.js
@@ -19107,7 +19103,7 @@ fsevents@^1.2.7:
   languageName: node
   linkType: hard
 
-"jest-util@npm:^27.0.0, jest-util@npm:^27.5.1":
+"jest-util@npm:^27.5.1":
   version: 27.5.1
   resolution: "jest-util@npm:27.5.1"
   dependencies:
@@ -19275,7 +19271,7 @@ fsevents@^1.2.7:
   languageName: node
   linkType: hard
 
-"jest@npm:^27, jest@npm:^27.4.3":
+"jest@npm:^27.4.3":
   version: 27.5.1
   resolution: "jest@npm:27.5.1"
   dependencies:
@@ -19593,15 +19589,6 @@ fsevents@^1.2.7:
   languageName: node
   linkType: hard
 
-"json5@npm:2.x, json5@npm:^2.1.2, json5@npm:^2.2.0, json5@npm:^2.2.1":
-  version: 2.2.1
-  resolution: "json5@npm:2.2.1"
-  bin:
-    json5: lib/cli.js
-  checksum: 74b8a23b102a6f2bf2d224797ae553a75488b5adbaee9c9b6e5ab8b510a2fc6e38f876d4c77dea672d4014a44b2399e15f2051ac2b37b87f74c0c7602003543b
-  languageName: node
-  linkType: hard
-
 "json5@npm:^1.0.1":
   version: 1.0.1
   resolution: "json5@npm:1.0.1"
@@ -19613,6 +19600,15 @@ fsevents@^1.2.7:
   languageName: node
   linkType: hard
 
+"json5@npm:^2.1.2, json5@npm:^2.2.0, json5@npm:^2.2.1":
+  version: 2.2.1
+  resolution: "json5@npm:2.2.1"
+  bin:
+    json5: lib/cli.js
+  checksum: 74b8a23b102a6f2bf2d224797ae553a75488b5adbaee9c9b6e5ab8b510a2fc6e38f876d4c77dea672d4014a44b2399e15f2051ac2b37b87f74c0c7602003543b
+  languageName: node
+  linkType: hard
+
 "json5@npm:^2.2.3":
   version: 2.2.3
   resolution: "json5@npm:2.2.3"
@@ -28222,39 +28218,6 @@ fsevents@^1.2.7:
   languageName: node
   linkType: hard
 
-"ts-jest@npm:^27":
-  version: 27.1.5
-  resolution: "ts-jest@npm:27.1.5"
-  dependencies:
-    bs-logger: 0.x
-    fast-json-stable-stringify: 2.x
-    jest-util: ^27.0.0
-    json5: 2.x
-    lodash.memoize: 4.x
-    make-error: 1.x
-    semver: 7.x
-    yargs-parser: 20.x
-  peerDependencies:
-    "@babel/core": ">=7.0.0-beta.0 <8"
-    "@types/jest": ^27.0.0
-    babel-jest: ">=27.0.0 <28"
-    jest: ^27.0.0
-    typescript: ">=3.8 <5.0"
-  peerDependenciesMeta:
-    "@babel/core":
-      optional: true
-    "@types/jest":
-      optional: true
-    babel-jest:
-      optional: true
-    esbuild:
-      optional: true
-  bin:
-    ts-jest: cli.js
-  checksum: 3ef51c538b82f49b3f529331c1a017871a2f90e7a9a6e69333304755036d121818c6b120e2ce32dd161ff8bb2487efec0c790753ecd39b46a9ed1ce0d241464c
-  languageName: node
-  linkType: hard
-
 "ts-jest@npm:^29":
   version: 29.0.5
   resolution: "ts-jest@npm:29.0.5"
@@ -30675,7 +30638,7 @@ fsevents@^1.2.7:
   languageName: node
   linkType: hard
 
-"yargs-parser@npm:20.2.9, yargs-parser@npm:20.x, yargs-parser@npm:^20.2.2":
+"yargs-parser@npm:20.2.9, yargs-parser@npm:^20.2.2":
   version: 20.2.9
   resolution: "yargs-parser@npm:20.2.9"
   checksum: 8bb69015f2b0ff9e17b2c8e6bfe224ab463dd00ca211eece72a4cd8a906224d2703fb8a326d36fdd0e68701e201b2a60ed7cf81ce0fd9b3799f9fe7745977ae3
