@pob/codemods 0.0.0 → 0.1.1

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## [0.1.1](https://github.com/christophehurpeau/pob/compare/@pob/codemods@0.0.0...@pob/codemods@0.1.1) (2024-06-07)
+
+Note: no notable changes
+
+

package/bin/migrate.mjs

@@ -1,9 +1,9 @@
 #!/usr/bin/env node
 
-import { readdirSync } from 'node:fs';
-import { fileURLToPath } from 'node:url';
-import { glob } from 'glob';
-import runJscodeshift from '../lib/runJscodeshift.cjs';
+import { readdirSync } from "node:fs";
+import { fileURLToPath } from "node:url";
+import { glob } from "glob";
+import runJscodeshift from "../lib/runJscodeshift.cjs";
 
 const argv = process.argv.slice(2);
 
@@ -12,12 +12,12 @@ const globPaths = argv[1];
 
 if (!transformerName || !globPaths) {
   const transformerList = readdirSync(
-    new URL('../lib/transforms/', import.meta.url),
+    new URL("../lib/transforms/", import.meta.url),
   );
   throw new Error(
     `Usage: pob-migrate <transformer-name> <glob-paths>\n${transformerList
       .map((t) => `- "${t.slice(0, -4)}"`)
-      .join('\n')}`,
+      .join("\n")}`,
   );
 }
 
@@ -34,4 +34,4 @@ const res = await runJscodeshift(transformPath, paths, {});
 if (res.errors) {
   process.exitCode = 1;
 }
-console.log('Done!');
+console.log("Done!");

package/lib/runJscodeshift.cjs

@@ -1,6 +1,6 @@
-'use strict';
+"use strict";
 
-const { run: jscodeshift } = require('jscodeshift/src/Runner');
+const { run: jscodeshift } = require("jscodeshift/src/Runner");
 
 module.exports = (...args) => {
   return jscodeshift(...args);

package/lib/transforms/jest-to-node-runner.cjs

@@ -1,23 +1,23 @@
 /* eslint-disable unicorn/prefer-array-some */
 /* eslint-disable unicorn/no-array-method-this-argument */
 
-'use strict';
+"use strict";
 
-const { prependImport } = require('../utils/prependImport.cjs');
+const { prependImport } = require("../utils/prependImport.cjs");
 
 const jestToNodeGlobalMethods = {
-  test: 'test',
-  describe: 'describe',
-  it: 'it',
-  beforeAll: 'before',
-  afterAll: 'after',
-  beforeEach: 'beforeEach',
-  afterEach: 'afterEach',
+  test: "test",
+  describe: "describe",
+  it: "it",
+  beforeAll: "before",
+  afterAll: "after",
+  beforeEach: "beforeEach",
+  afterEach: "afterEach",
 };
 const propertiesMap = {
-  toBe: { default: 'equal', not: 'notEqual' },
-  toStrictEqual: { default: 'equal', not: 'notEqual' },
-  toEqual: { default: 'equal', not: 'notEqual' },
+  toBe: { default: "equal", not: "notEqual" },
+  toStrictEqual: { default: "equal", not: "notEqual" },
+  toEqual: { default: "equal", not: "notEqual" },
 };
 
 // const mocks = {
@@ -29,15 +29,15 @@ const propertiesMap = {
 module.exports = (file, api, options) => {
   if (
     !(
-      file.path.endsWith('.test.js') ||
-      file.path.endsWith('.test.ts') ||
-      file.path.endsWith('.test.tsx')
+      file.path.endsWith(".test.js") ||
+      file.path.endsWith(".test.ts") ||
+      file.path.endsWith(".test.tsx")
     )
   ) {
     throw new Error(`Invalid file: "${file.path}"`);
   }
 
-  const j = api.jscodeshift.withParser('tsx');
+  const j = api.jscodeshift.withParser("tsx");
   const root = j(file.source);
 
   function updateTopLevelMethods() {
@@ -68,7 +68,7 @@ module.exports = (file, api, options) => {
           [...topLevelMethodsUsed].map((method) =>
             j.importSpecifier(j.identifier(method)),
           ),
-          j.stringLiteral('node:test'),
+          j.stringLiteral("node:test"),
         ),
       );
     }
@@ -80,7 +80,7 @@ module.exports = (file, api, options) => {
     root
       .find(j.MemberExpression, {
         object: {
-          callee: { name: 'expect' },
+          callee: { name: "expect" },
         },
       })
       .forEach((memberExpressionPath) => {
@@ -88,7 +88,7 @@ module.exports = (file, api, options) => {
         let memberExpressionPathToReplace = memberExpressionPath;
         let propertyName = memberExpression.property.name;
         let not = false;
-        if (propertyName === 'not') {
+        if (propertyName === "not") {
           not = true;
           memberExpressionPathToReplace = parentPath;
           propertyName = parentPath.value.property.name;
@@ -100,34 +100,35 @@ module.exports = (file, api, options) => {
         }
 
         const assertPropertyName =
-          propertiesMap[propertyName][not ? 'not' : 'default'];
+          propertiesMap[propertyName][not ? "not" : "default"];
         const callExpressionPath = memberExpressionPathToReplace.parentPath;
 
-        const argument0 = callExpressionPath.value.arguments[0];
-        const argument1 = memberExpression.object.arguments[0];
+        const value = memberExpression.object.arguments[0];
+        const expected = callExpressionPath.value.arguments[0];
 
         hasAssertions = true;
         callExpressionPath.value.callee = j.memberExpression(
-          j.identifier('assert'),
+          j.identifier("assert"),
           j.identifier(assertPropertyName),
         );
-        callExpressionPath.value.arguments = [argument0, argument1];
+        callExpressionPath.value.arguments = [value, expected];
       });
 
     if (hasAssertions) {
       root
-        .find(j.ImportDeclaration, { source: { value: 'node:assert' } })
+        .find(j.ImportDeclaration, { source: { value: "node:assert" } })
         .remove();
       if (
+        // eslint-disable-next-line no-constant-condition
         (!root.find(j.ImportDeclaration),
-        { source: { value: 'node:assert/strict' } })
+        { source: { value: "node:assert/strict" } })
       ) {
         prependImport(
           j,
           root,
           j.importDeclaration(
-            [j.importDefaultSpecifier(j.identifier('assert'))],
-            j.stringLiteral('node:assert/strict'),
+            [j.importDefaultSpecifier(j.identifier("assert"))],
+            j.stringLiteral("node:assert/strict"),
           ),
         );
       }
@@ -138,7 +139,7 @@ module.exports = (file, api, options) => {
   updateAssertions();
 
   root
-    .find(j.ImportDeclaration, { source: { value: '@jest/globals' } })
+    .find(j.ImportDeclaration, { source: { value: "@jest/globals" } })
     .remove();
 
   return root.toSource(options);

package/lib/transforms/update-function-component-return-type.cjs

@@ -1,8 +1,8 @@
-'use strict';
+"use strict";
 
 /* eslint-disable complexity */
 module.exports = (file, api, options) => {
-  const j = api.jscodeshift.withParser('tsx');
+  const j = api.jscodeshift.withParser("tsx");
   const root = j(file.source);
   let hasModifications = false;
 
@@ -10,38 +10,38 @@ module.exports = (file, api, options) => {
     const node = path.value;
     const { returnType } = node;
     if (returnType == null) return;
-    if (returnType.type !== 'TSTypeAnnotation') return;
+    if (returnType.type !== "TSTypeAnnotation") return;
     const { typeAnnotation } = returnType;
     if (typeAnnotation == null) return;
 
     if (
-      typeAnnotation.type === 'TSTypeReference' &&
+      typeAnnotation.type === "TSTypeReference" &&
       typeAnnotation.typeName &&
-      typeAnnotation.typeName.type === 'Identifier'
+      typeAnnotation.typeName.type === "Identifier"
     ) {
-      if (typeAnnotation.typeName.name === 'ReactElement') {
-        typeAnnotation.typeName.name = 'ReactNode';
+      if (typeAnnotation.typeName.name === "ReactElement") {
+        typeAnnotation.typeName.name = "ReactNode";
         hasModifications = true;
       }
     } else if (
-      typeAnnotation.type === 'TSUnionType' &&
+      typeAnnotation.type === "TSUnionType" &&
       typeAnnotation.types.every((unionTypeItem) => {
-        if (unionTypeItem.type === 'TSTypeReference') {
+        if (unionTypeItem.type === "TSTypeReference") {
           return (
             unionTypeItem.typeName &&
-            unionTypeItem.typeName.type === 'Identifier' &&
-            unionTypeItem.typeName.name === 'ReactElement'
+            unionTypeItem.typeName.type === "Identifier" &&
+            unionTypeItem.typeName.name === "ReactElement"
           );
         }
 
-        if (unionTypeItem.type === 'TSNullKeyword') {
+        if (unionTypeItem.type === "TSNullKeyword") {
           return true;
         }
 
         return false;
       })
     ) {
-      returnType.typeAnnotation = j.tsTypeReference(j.identifier('ReactNode'));
+      returnType.typeAnnotation = j.tsTypeReference(j.identifier("ReactNode"));
       hasModifications = true;
     }
   }
@@ -51,23 +51,23 @@ module.exports = (file, api, options) => {
   if (hasModifications) {
     root.find(j.ImportDeclaration).forEach((importDeclaration) => {
       const { node } = importDeclaration;
-      if (node.source.value !== 'react') return;
-      if (node.importKind !== 'type') return;
+      if (node.source.value !== "react") return;
+      if (node.importKind !== "type") return;
 
       node.specifiers = node.specifiers.filter((importSpecifier) => {
-        if (importSpecifier.local.name !== 'ReactElement') return true;
-        if (importSpecifier.importKind !== 'value') return true;
+        if (importSpecifier.local.name !== "ReactElement") return true;
+        if (importSpecifier.importKind !== "value") return true;
         return (
           j(importDeclaration)
             .closestScope()
             // eslint-disable-next-line unicorn/no-array-method-this-argument -- not an array
-            .find(j.Identifier, { name: 'ReactElement' })
+            .find(j.Identifier, { name: "ReactElement" })
             .filter((p) => {
               if (p.value.start === importSpecifier.local.start) return false;
-              if (p.parentPath.value.type === 'Property' && p.name === 'key') {
+              if (p.parentPath.value.type === "Property" && p.name === "key") {
                 return false;
               }
-              if (p.name === 'property') return false;
+              if (p.name === "property") return false;
               return true;
             })
             .size() > 0
@@ -76,11 +76,11 @@ module.exports = (file, api, options) => {
       if (
         !node.specifiers.some(
           (specifier) =>
-            specifier.type === 'ImportSpecifier' &&
-            specifier.imported.name === 'ReactNode',
+            specifier.type === "ImportSpecifier" &&
+            specifier.imported.name === "ReactNode",
         )
       ) {
-        node.specifiers.push(j.importSpecifier(j.identifier('ReactNode')));
+        node.specifiers.push(j.importSpecifier(j.identifier("ReactNode")));
       }
     });
   }

package/lib/utils/prependImport.cjs

@@ -1,4 +1,4 @@
-'use strict';
+"use strict";
 
 exports.prependImport = (j, source, importDeclaration) => {
   const existingImports = source.find(j.ImportDeclaration);
@@ -14,7 +14,7 @@ exports.prependImport = (j, source, importDeclaration) => {
     return;
   }
 
-  const firstNode = source.find(j.Program).get('body', 0).node;
+  const firstNode = source.find(j.Program).get("body", 0).node;
   const { comments } = firstNode;
   if (comments?.length) {
     const comment = comments[0];
@@ -23,13 +23,13 @@ exports.prependImport = (j, source, importDeclaration) => {
     // line-level and JSDoc-style comments because these probably belong
     // to the first node, rather than the file.
     if (
-      (comment.type === 'Block' || comment.type === 'CommentBlock') &&
-      !comment.value.startsWith('*')
+      (comment.type === "Block" || comment.type === "CommentBlock") &&
+      !comment.value.startsWith("*")
     ) {
       importDeclaration.comments = comments;
       firstNode.comments = null;
     }
   }
 
-  source.get('program', 'body').unshift(importDeclaration);
+  source.get("program", "body").unshift(importDeclaration);
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pob/codemods",
-  "version": "0.0.0",
+  "version": "0.1.1",
   "description": "codemods for pob",
   "keywords": [],
   "author": "Christophe Hurpeau <302891+christophehurpeau@users.noreply.github.com> (https://christophe.hurpeau.com)",
@@ -34,8 +34,8 @@
   "pob": {},
   "prettier": "@pob/root/prettier-config",
   "dependencies": {
-    "glob": "10.3.10",
-    "jscodeshift": "0.15.1"
+    "glob": "10.4.1",
+    "jscodeshift": "0.15.2"
   },
   "devDependencies": {
     "@types/jscodeshift": "0.11.11"