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>

Author: ontanj

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!

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": {

packages/query-codemods/src/utils/index.js renamed to packages/query-codemods/src/utils/index.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',
+})

packages/query-codemods/src/utils/transformers/query-cache-transformer.js renamed to packages/query-codemods/src/utils/transformers/query-cache-transformer.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',
   {

packages/query-codemods/src/utils/transformers/query-client-transformer.js renamed to packages/query-codemods/src/utils/transformers/query-client-transformer.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,