feat(create-require-from-path): introduce (#111)

Co-authored-by: Aviv Keller <[email protected]>

Author: AugustinMauroy

package-lock.json

@@ -0,0 +1,25 @@
+# `createRequireFromPath` DEP0130
+
+This recipe transforms the usage of `createRequireFromPath` to use the `createRequire` function from the `node:module` module.
+
+See [DEP0130](https://nodejs.org/api/deprecations.html#DEP0130).
+
+## Example
+
+**Before:**
+```js
+const { createRequireFromPath } = require('node:module');
+
+// Using createRequireFromPath
+const requireFromPath = createRequireFromPath('/path/to/module');
+const myModule = requireFromPath('./myModule.cjs');
+```
+
+**After:**
+```js
+ const { createRequire } = require('node:module');
+
+// Using createRequire with a specific path
+const require = createRequire('/path/to/module');
+const myModule = require('./myModule.cjs');
+```

recipes/create-require-from-path/README.md

@@ -0,0 +1,21 @@
+schema_version: "1.0"
+name: nodejs/create-require-from-path
+version: 0.0.1
+description: Handle DEP0130 via transforming `createRequireFromPath` to `createRequire`.
+author: Augustin Mauroy
+license: MIT
+workflow: workflow.yaml
+category: migration
+
+targets:
+  languages:
+    - javascript
+    - typescript
+
+keywords:
+  - transformation
+  - migration
+
+registry:
+  access: public
+  visibility: public

recipes/create-require-from-path/codemod.yml

@@ -0,0 +1,25 @@
+{
+  "name": "@nodejs/create-require-from-path",
+  "version": "0.0.1",
+  "description": "Handle DEP0130 via transforming `createRequireFromPath` to `createRequire`.",
+  "type": "module",
+  "scripts": {
+    "test": "npx codemod@next jssg test -l typescript ./src/workflow.ts ./"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nodejs/userland-migrations.git",
+    "directory": "recipes/create-require-from-path",
+    "bugs": "https://github.com/nodejs/userland-migrations/issues"
+  },
+  "author": "Augustin Mauroy",
+  "license": "MIT",
+  "homepage": "https://github.com/nodejs/userland-migrations/blob/main/recipes/create-require-from-path/README.md",
+  "devDependencies": {
+    "@types/node": "^24.0.3",
+    "@codemod.com/jssg-types": "^1.0.3"
+  },
+  "dependencies": {
+    "@nodejs/codemod-utils": "0.0.0"
+  }
+}

recipes/create-require-from-path/package.json

@@ -0,0 +1,93 @@
+import { getNodeImportStatements } from "@nodejs/codemod-utils/ast-grep/import-statement";
+import { getNodeRequireCalls } from "@nodejs/codemod-utils/ast-grep/require-call";
+import type { SgRoot, Edit } from "@codemod.com/jssg-types/main";
+
+/**
+ * Transform function that updates code to replace deprecated `createRequireFromPath` usage
+ * with the modern `createRequire` API from the `module` or `node:module` package.
+ *
+ * Handles:
+ * 1. Updates import/require statements that import `createRequireFromPath`:
+ *    - `const { createRequireFromPath } = require('module')` -> `const { createRequire } = require('module')`
+ *    - `const { createRequireFromPath } = require('node:module')` -> `const { createRequire } = require('node:module')`
+ *    - `import { createRequireFromPath } from 'module'` -> `import { createRequire } from 'module'`
+ *    - `import { createRequireFromPath } from 'node:module'` -> `import { createRequire } from 'node:module'`
+ *
+ * 2. Updates variable declarations that use `createRequireFromPath`:
+ *    - `const myRequire = createRequireFromPath(arg)` -> `const myRequire = createRequire(arg)`
+ *    - `let myRequire = createRequireFromPath(arg)` -> `let myRequire = createRequire(arg)`
+ *    - `var myRequire = createRequireFromPath(arg)` -> `var myRequire = createRequire(arg)`
+ *
+ * 3. Preserves original variable names and declaration types.
+ */
+export default function transform(root: SgRoot): string | null {
+  const rootNode = root.root();
+  const edits: Edit[] = [];
+  let hasChanges = false;
+
+  // Step 1: Find and update destructuring assignments from require('module') or require('node:module')
+	// @ts-ignore - ast-grep types are not fully compatible with JSSG types
+  const requireStatements = getNodeRequireCalls(root, "module")
+
+  for (const statement of requireStatements) {
+    // Find the object pattern (destructuring)
+    const objectPattern = statement.find({
+      rule: {
+        kind: "object_pattern"
+      }
+    });
+
+    if (objectPattern) {
+      const originalText = objectPattern.text();
+
+      if (originalText.includes("createRequireFromPath")) {
+        const newText = originalText.replace(/\bcreateRequireFromPath\b/g, "createRequire");
+        edits.push(objectPattern.replace(newText));
+        hasChanges = true;
+      }
+    }
+  }
+
+	// @ts-ignore - ast-grep types are not fully compatible with JSSG types
+  const importStatements = getNodeImportStatements(root, "module");
+
+  for (const statement of importStatements) {
+    // Find the named imports
+    const namedImports = statement.find({
+      rule: {
+        kind: "named_imports"
+      }
+    });
+
+    if (namedImports) {
+      const originalText = namedImports.text();
+
+      if (originalText.includes("createRequireFromPath")) {
+        const newText = originalText.replace(/\bcreateRequireFromPath\b/g, "createRequire");
+        edits.push(namedImports.replace(newText));
+        hasChanges = true;
+      }
+    }
+  }
+
+  // Step 2: Find and replace createRequireFromPath function calls
+  const functionCalls = rootNode.findAll({
+    rule: {
+      pattern: "createRequireFromPath($ARG)"
+    }
+  });
+
+  for (const call of functionCalls) {
+    const argMatch = call.getMatch("ARG");
+    if (argMatch) {
+      const arg = argMatch.text();
+      const replacement = `createRequire(${arg})`;
+      edits.push(call.replace(replacement));
+      hasChanges = true;
+    }
+  }
+
+  if (!hasChanges) return null;
+
+  return rootNode.commitEdits(edits);
+}

recipes/create-require-from-path/src/workflow.ts

@@ -0,0 +1,5 @@
+/* we use createRequireFromPath beause ...*/ const { createRequire } /* we use createRequireFromPath beause ...*/ = require('module'); // we use createRequireFromPath beause ...
+
+var r1 = createRequire('/path/to/module');
+let r2 = createRequire('/path/to/module');
+const r3 = createRequire('/path/to/module');

recipes/create-require-from-path/tests/expected/edge-case.js

@@ -0,0 +1,5 @@
+const { createRequire } = require('module');
+
+// no semicolon is needed for test
+const require = createRequire('/path/to/module')
+const myModule = require('./myModule.cjs');

recipes/create-require-from-path/tests/expected/file-1.js

@@ -0,0 +1,4 @@
+import { createRequire } from 'module';
+
+const require = createRequire(import.meta.url);
+const data = require('./data.json');

recipes/create-require-from-path/tests/expected/file-1.mjs

@@ -0,0 +1,4 @@
+const { createRequire, otherFunction } = require('node:module');
+
+const require = createRequire(__filename);
+const pkg = require('./package.json');

recipes/create-require-from-path/tests/expected/file-2.js

@@ -0,0 +1,4 @@
+import { createRequire, resolve } from 'node:module';
+
+const require = createRequire('/some/path');
+const lib = require('some-library');