fix(codemods): Use .cjs extension for CommonJS files (#7333)

* bug(codemods): rename CommonJS files to .cjs Rename CommonJS files in codemods to distinguish them from ES module files otherwise used in this project. Resolve an issue occuring since package.json in codemods is removed when publishing causing module type data to be lost. Fix issue #7154 * Fix knip errors * Add file extension to tests * Update migration doc --------- Co-authored-by: Lachlan Collins <1667261+lachlancollins@users.noreply.github.com>
TanStack · Apr 25, 2024 · 2aca521 · 2aca521
1 parent 2ffd9fb
commit 2aca521
Show file tree

Hide file tree

Showing 28 changed files with 90 additions and 78 deletions.
diff --git a/docs/framework/react/guides/migrating-to-v5.md b/docs/framework/react/guides/migrating-to-v5.md
@@ -91,7 +91,7 @@ If you want to run it against `.js` or `.jsx` files, please use the command belo
 ```
 npx jscodeshift@latest ./path/to/src/ \
   --extensions=js,jsx \
-  --transform=./node_modules/@tanstack/react-query/build/codemods/src/v5/remove-overloads/remove-overloads.js
+  --transform=./node_modules/@tanstack/react-query/build/codemods/src/v5/remove-overloads/remove-overloads.cjs
 ```
 
 If you want to run it against `.ts` or `.tsx` files, please use the command below:
@@ -100,7 +100,7 @@ If you want to run it against `.ts` or `.tsx` files, please use the command belo
 npx jscodeshift@latest ./path/to/src/ \
   --extensions=ts,tsx \
   --parser=tsx \
-  --transform=./node_modules/@tanstack/react-query/build/codemods/src/v5/remove-overloads/remove-overloads.js
+  --transform=./node_modules/@tanstack/react-query/build/codemods/src/v5/remove-overloads/remove-overloads.cjs
 ```
 
 Please note in the case of `TypeScript` you need to use `tsx` as the parser; otherwise, the codemod won't be applied properly!

diff --git a/knip.json b/knip.json
@@ -3,7 +3,7 @@
   "ignoreWorkspaces": ["examples/**", "integrations/**"],
   "workspaces": {
     "packages/query-codemods": {
-      "entry": ["src/v4/*.js", "src/v5/*/*.js"],
+      "entry": ["src/v4/**/*.cjs", "src/v5/**/*.cjs"],
       "ignore": ["**/__testfixtures__/**"]
     },
     "packages/vue-query": {

diff --git a/packages/query-codemods/src/utils/index.js → packages/query-codemods/src/utils/index.cjs b/packages/query-codemods/src/utils/index.js → packages/query-codemods/src/utils/index.cjs
diff --git a/...s/transformers/query-cache-transformer.js → .../transformers/query-cache-transformer.cjs b/...s/transformers/query-cache-transformer.js → .../transformers/query-cache-transformer.cjs
diff --git a/.../transformers/query-client-transformer.js → ...transformers/query-client-transformer.cjs b/.../transformers/query-client-transformer.js → ...transformers/query-client-transformer.cjs
diff --git a/...ransformers/use-query-like-transformer.js → ...ansformers/use-query-like-transformer.cjs b/...ransformers/use-query-like-transformer.js → ...ansformers/use-query-like-transformer.cjs
diff --git a/packages/query-codemods/src/v4/__tests__/key-transformation.test.cjs b/packages/query-codemods/src/v4/__tests__/key-transformation.test.cjs
@@ -0,0 +1,38 @@
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const defineTest = require('jscodeshift/dist/testUtils').defineTest
+
+defineTest(__dirname, 'key-transformation.cjs', null, 'default-import', {
+  parser: 'tsx',
+})
+
+defineTest(__dirname, 'key-transformation.cjs', null, 'named-import', {
+  parser: 'tsx',
+})
+
+defineTest(__dirname, 'key-transformation.cjs', null, 'namespaced-import', {
+  parser: 'tsx',
+})
+
+defineTest(
+  __dirname,
+  'key-transformation.cjs',
+  null,
+  'parameter-is-identifier',
+  {
+    parser: 'tsx',
+  },
+)
+
+defineTest(
+  __dirname,
+  'key-transformation.cjs',
+  null,
+  'parameter-is-object-expression',
+  {
+    parser: 'tsx',
+  },
+)
+
+defineTest(__dirname, 'key-transformation.cjs', null, 'type-arguments', {
+  parser: 'tsx',
+})
diff --git a/packages/query-codemods/src/v4/__tests__/key-transformation.test.js b/packages/query-codemods/src/v4/__tests__/key-transformation.test.js
diff --git a/..._tests__/replace-import-specifier.test.js → ...tests__/replace-import-specifier.test.cjs b/..._tests__/replace-import-specifier.test.js → ...tests__/replace-import-specifier.test.cjs
@@ -3,7 +3,7 @@ const defineTest = require('jscodeshift/dist/testUtils').defineTest
 
 defineTest(
   __dirname,
-  'replace-import-specifier',
+  'replace-import-specifier.cjs',
   null,
   'replace-import-specifier',
   {

diff --git a/...ery-codemods/src/v4/key-transformation.js → ...ry-codemods/src/v4/key-transformation.cjs b/...ery-codemods/src/v4/key-transformation.js → ...ry-codemods/src/v4/key-transformation.cjs
@@ -1,13 +1,13 @@
 // eslint-disable-next-line @typescript-eslint/no-var-requires
-const createUtilsObject = require('../utils')
+const createUtilsObject = require('../utils/index.cjs')
 // eslint-disable-next-line @typescript-eslint/no-var-requires
-const createKeyReplacer = require('./utils/replacers/key-replacer')
+const createKeyReplacer = require('./utils/replacers/key-replacer.cjs')
 // eslint-disable-next-line @typescript-eslint/no-var-requires
-const createUseQueryLikeTransformer = require('../utils/transformers/use-query-like-transformer')
+const createUseQueryLikeTransformer = require('../utils/transformers/use-query-like-transformer.cjs')
 // eslint-disable-next-line @typescript-eslint/no-var-requires
-const createQueryClientTransformer = require('../utils/transformers/query-client-transformer')
+const createQueryClientTransformer = require('../utils/transformers/query-client-transformer.cjs')
 // eslint-disable-next-line @typescript-eslint/no-var-requires
-const createQueryCacheTransformer = require('../utils/transformers/query-cache-transformer')
+const createQueryCacheTransformer = require('../utils/transformers/query-cache-transformer.cjs')
 
 const transformQueryClientUsages = ({
   jscodeshift,

diff --git a/...demods/src/v4/replace-import-specifier.js → ...emods/src/v4/replace-import-specifier.cjs b/...demods/src/v4/replace-import-specifier.js → ...emods/src/v4/replace-import-specifier.cjs
diff --git a/...ds/src/v4/utils/replacers/key-replacer.js → ...s/src/v4/utils/replacers/key-replacer.cjs b/...ds/src/v4/utils/replacers/key-replacer.js → ...s/src/v4/utils/replacers/key-replacer.cjs
diff --git a/...-hydrate/__tests__/rename-hydrate.test.js → .../is-loading/__tests__/is-loading.test.cjs b/...-hydrate/__tests__/rename-hydrate.test.js → .../is-loading/__tests__/is-loading.test.cjs
@@ -1,10 +1,10 @@
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const defineTest = require('jscodeshift/dist/testUtils').defineTest
 
-defineTest(__dirname, 'rename-hydrate', null, 'default-import', {
+defineTest(__dirname, 'is-loading.cjs', null, 'default-import', {
   parser: 'tsx',
 })
 
-defineTest(__dirname, 'rename-hydrate', null, 'named-import', {
+defineTest(__dirname, 'is-loading.cjs', null, 'named-import', {
   parser: 'tsx',
 })
diff --git a/...-codemods/src/v5/is-loading/is-loading.js → ...codemods/src/v5/is-loading/is-loading.cjs b/...-codemods/src/v5/is-loading/is-loading.js → ...codemods/src/v5/is-loading/is-loading.cjs
@@ -1,9 +1,9 @@
 // eslint-disable-next-line @typescript-eslint/no-var-requires
-const createUtilsObject = require('../../utils')
+const createUtilsObject = require('../../utils/index.cjs')
 // eslint-disable-next-line @typescript-eslint/no-var-requires
-const createUseQueryLikeTransformer = require('../../utils/transformers/use-query-like-transformer')
+const createUseQueryLikeTransformer = require('../../utils/transformers/use-query-like-transformer.cjs')
 // eslint-disable-next-line @typescript-eslint/no-var-requires
-const createQueryClientTransformer = require('../../utils/transformers/query-client-transformer')
+const createQueryClientTransformer = require('../../utils/transformers/query-client-transformer.cjs')
 
 const originalName = 'isLoading'
 const newName = 'isPending'

diff --git a/...data/__tests__/keep-previous-data.test.js → ...ata/__tests__/keep-previous-data.test.cjs b/...data/__tests__/keep-previous-data.test.js → ...ata/__tests__/keep-previous-data.test.cjs
@@ -1,10 +1,10 @@
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const defineTest = require('jscodeshift/dist/testUtils').defineTest
 
-defineTest(__dirname, 'keep-previous-data', null, 'default', {
+defineTest(__dirname, 'keep-previous-data.cjs', null, 'default', {
   parser: 'tsx',
 })
 
-defineTest(__dirname, 'keep-previous-data', null, 'named', {
+defineTest(__dirname, 'keep-previous-data.cjs', null, 'named', {
   parser: 'tsx',
 })
diff --git a/.../keep-previous-data/keep-previous-data.js → ...keep-previous-data/keep-previous-data.cjs b/.../keep-previous-data/keep-previous-data.js → ...keep-previous-data/keep-previous-data.cjs
@@ -1,11 +1,11 @@
 // eslint-disable-next-line @typescript-eslint/no-var-requires
-const createUtilsObject = require('../../utils')
+const createUtilsObject = require('../../utils/index.cjs')
 // eslint-disable-next-line @typescript-eslint/no-var-requires
-const createUseQueryLikeTransformer = require('../../utils/transformers/use-query-like-transformer')
+const createUseQueryLikeTransformer = require('../../utils/transformers/use-query-like-transformer.cjs')
 // eslint-disable-next-line @typescript-eslint/no-var-requires
-const createQueryClientTransformer = require('../../utils/transformers/query-client-transformer')
+const createQueryClientTransformer = require('../../utils/transformers/query-client-transformer.cjs')
 // eslint-disable-next-line @typescript-eslint/no-var-requires
-const AlreadyHasPlaceholderDataProperty = require('./utils/already-has-placeholder-data-property')
+const AlreadyHasPlaceholderDataProperty = require('./utils/already-has-placeholder-data-property.cjs')
 
 /**
  * @param {import('jscodeshift')} jscodeshift

diff --git a/.../already-has-placeholder-data-property.js → ...already-has-placeholder-data-property.cjs b/.../already-has-placeholder-data-property.js → ...already-has-placeholder-data-property.cjs
diff --git a/...5/is-loading/__tests__/is-loading.test.js → ...loads/__tests__/remove-overloads.test.cjs b/...5/is-loading/__tests__/is-loading.test.js → ...loads/__tests__/remove-overloads.test.cjs
@@ -1,10 +1,10 @@
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const defineTest = require('jscodeshift/dist/testUtils').defineTest
 
-defineTest(__dirname, 'is-loading', null, 'default-import', {
+defineTest(__dirname, 'remove-overloads.cjs', null, 'default-import', {
   parser: 'tsx',
 })
 
-defineTest(__dirname, 'is-loading', null, 'named-import', {
+defineTest(__dirname, 'remove-overloads.cjs', null, 'bug-reports', {
   parser: 'tsx',
 })
diff --git a/...c/v5/remove-overloads/remove-overloads.js → .../v5/remove-overloads/remove-overloads.cjs b/...c/v5/remove-overloads/remove-overloads.js → .../v5/remove-overloads/remove-overloads.cjs
@@ -1,9 +1,9 @@
 // eslint-disable-next-line @typescript-eslint/no-var-requires
-const createUtilsObject = require('../../utils')
+const createUtilsObject = require('../../utils/index.cjs')
 // eslint-disable-next-line @typescript-eslint/no-var-requires
-const transformFilterAwareUsages = require('./transformers/filter-aware-usage-transformer')
+const transformFilterAwareUsages = require('./transformers/filter-aware-usage-transformer.cjs')
 // eslint-disable-next-line @typescript-eslint/no-var-requires
-const transformQueryFnAwareUsages = require('./transformers/query-fn-aware-usage-transformer')
+const transformQueryFnAwareUsages = require('./transformers/query-fn-aware-usage-transformer.cjs')
 
 module.exports = (file, api) => {
   const jscodeshift = api.jscodeshift

diff --git a/...formers/filter-aware-usage-transformer.js → ...ormers/filter-aware-usage-transformer.cjs b/...formers/filter-aware-usage-transformer.js → ...ormers/filter-aware-usage-transformer.cjs
@@ -1,13 +1,13 @@
 // eslint-disable-next-line @typescript-eslint/no-var-requires
-const createV5UtilsObject = require('../utils')
+const createV5UtilsObject = require('../utils/index.cjs')
 // eslint-disable-next-line @typescript-eslint/no-var-requires
-const UnknownUsageError = require('../utils/unknown-usage-error')
+const UnknownUsageError = require('../utils/unknown-usage-error.cjs')
 // eslint-disable-next-line @typescript-eslint/no-var-requires
-const createQueryClientTransformer = require('../../../utils/transformers/query-client-transformer')
+const createQueryClientTransformer = require('../../../utils/transformers/query-client-transformer.cjs')
 // eslint-disable-next-line @typescript-eslint/no-var-requires
-const createQueryCacheTransformer = require('../../../utils/transformers/query-cache-transformer')
+const createQueryCacheTransformer = require('../../../utils/transformers/query-cache-transformer.cjs')
 // eslint-disable-next-line @typescript-eslint/no-var-requires
-const createUseQueryLikeTransformer = require('../../../utils/transformers/use-query-like-transformer')
+const createUseQueryLikeTransformer = require('../../../utils/transformers/use-query-like-transformer.cjs')
 
 /**
  * @param {import('jscodeshift').api} jscodeshift

diff --git a/...rmers/query-fn-aware-usage-transformer.js → ...mers/query-fn-aware-usage-transformer.cjs b/...rmers/query-fn-aware-usage-transformer.js → ...mers/query-fn-aware-usage-transformer.cjs
@@ -1,9 +1,9 @@
 // eslint-disable-next-line @typescript-eslint/no-var-requires
-const createV5UtilsObject = require('../utils')
+const createV5UtilsObject = require('../utils/index.cjs')
 // eslint-disable-next-line @typescript-eslint/no-var-requires
-const UnknownUsageError = require('../utils/unknown-usage-error')
+const UnknownUsageError = require('../utils/unknown-usage-error.cjs')
 // eslint-disable-next-line @typescript-eslint/no-var-requires
-const createQueryClientTransformer = require('../../../utils/transformers/query-client-transformer')
+const createQueryClientTransformer = require('../../../utils/transformers/query-client-transformer.cjs')
 
 /**
  * @param {import('jscodeshift').api} jscodeshift

diff --git a/...ds/src/v5/remove-overloads/utils/index.js → ...s/src/v5/remove-overloads/utils/index.cjs b/...ds/src/v5/remove-overloads/utils/index.js → ...s/src/v5/remove-overloads/utils/index.cjs
@@ -1,5 +1,5 @@
 // eslint-disable-next-line @typescript-eslint/no-var-requires
-const UnknownUsageError = require('./unknown-usage-error')
+const UnknownUsageError = require('./unknown-usage-error.cjs')
 
 module.exports = ({ jscodeshift, utils }) => {
   /**

diff --git a/...ve-overloads/utils/unknown-usage-error.js → ...e-overloads/utils/unknown-usage-error.cjs b/...ve-overloads/utils/unknown-usage-error.js → ...e-overloads/utils/unknown-usage-error.cjs
diff --git a/...rloads/__tests__/remove-overloads.test.js → ...hydrate/__tests__/rename-hydrate.test.cjs b/...rloads/__tests__/remove-overloads.test.js → ...hydrate/__tests__/rename-hydrate.test.cjs
@@ -1,10 +1,10 @@
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const defineTest = require('jscodeshift/dist/testUtils').defineTest
 
-defineTest(__dirname, 'remove-overloads', null, 'default-import', {
+defineTest(__dirname, 'rename-hydrate.cjs', null, 'default-import', {
   parser: 'tsx',
 })
 
-defineTest(__dirname, 'remove-overloads', null, 'bug-reports', {
+defineTest(__dirname, 'rename-hydrate.cjs', null, 'named-import', {
   parser: 'tsx',
 })
diff --git a/...s/src/v5/rename-hydrate/rename-hydrate.js → .../src/v5/rename-hydrate/rename-hydrate.cjs b/...s/src/v5/rename-hydrate/rename-hydrate.js → .../src/v5/rename-hydrate/rename-hydrate.cjs
diff --git a/packages/query-codemods/src/v5/rename-properties/__tests__/rename-properties.test.cjs b/packages/query-codemods/src/v5/rename-properties/__tests__/rename-properties.test.cjs
@@ -0,0 +1,16 @@
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const defineTest = require('jscodeshift/dist/testUtils').defineTest
+
+defineTest(__dirname, 'rename-properties.cjs', null, 'rename-cache-time', {
+  parser: 'tsx',
+})
+
+defineTest(
+  __dirname,
+  'rename-properties.cjs',
+  null,
+  'rename-use-error-boundary',
+  {
+    parser: 'tsx',
+  },
+)
diff --git a/packages/query-codemods/src/v5/rename-properties/__tests__/rename-properties.test.js b/packages/query-codemods/src/v5/rename-properties/__tests__/rename-properties.test.js
diff --git a/...v5/rename-properties/rename-properties.js → ...5/rename-properties/rename-properties.cjs b/...v5/rename-properties/rename-properties.js → ...5/rename-properties/rename-properties.cjs