@bpmn-io/codemods 0.2.1 → 0.3.1

package/esm/README.md

@@ -52,11 +52,12 @@ For every `.js`, `.jsx`, `.mjs`, `.cjs`, `.ts` and `.tsx` file below the target
    - Relative and bare (`node_modules`) specifiers are both handled.
    - TypeScript / JSX sources are written with a `.js` specifier (NodeNext
      convention), even though the file on disk is `.ts`/`.tsx`.
+   - Relative directory imports are expanded to `<dir>/index.js` when an
+     `index` file exists in that directory (e.g. `./lib` → `./lib/index.js`).
 4. Specifiers that already carry an extension, and bare package roots
    (e.g. `diagram-js`, `react`), are left untouched.
-5. Anything that still cannot be resolved (e.g. a directory import that would
-   need `/index.js`, or a genuinely missing file) is **reported** for manual
-   review — never silently changed.
+5. Anything that still cannot be resolved (e.g. a genuinely missing file) is
+   **reported** for manual review — never silently changed.
 
 Only the source string is edited; surrounding formatting is preserved exactly.
 
@@ -74,5 +75,4 @@ By design, the mod does **not**:
 
 - rewrite `require()` calls,
 - rewrite dynamic imports with a non-literal argument (`import(name)`),
-- add `/index.js` for directory imports,
 - guess at unresolvable imports — these are reported instead.

package/esm/lib/resolve.js

@@ -72,6 +72,11 @@ export function resolveImport(specifier, fromFile, options = {}) {
     return { status: 'skip', specifier };
   }
 
+  // bare subpath covered by package.json exports → already valid for ESM
+  if (bare && isSubpathExported(specifier, fromFile)) {
+    return { status: 'skip', specifier };
+  }
+
   const rewritten = bare
     ? resolveBare(specifier, fromFile)
     : resolveRelative(specifier, fromFile);
@@ -86,7 +91,19 @@ export function resolveImport(specifier, fromFile, options = {}) {
 function resolveRelative(specifier, fromFile) {
   const base = path.resolve(path.dirname(fromFile), specifier);
 
-  return resolveCandidates(base, specifier, RELATIVE_CANDIDATES);
+  const direct = resolveCandidates(base, specifier, RELATIVE_CANDIDATES);
+  if (direct) return direct;
+
+  // directory import: specifier points to a directory, try <dir>/index.*
+  if (isDirectory(base)) {
+    return resolveCandidates(
+      path.join(base, 'index'),
+      specifier + '/index',
+      RELATIVE_CANDIDATES
+    );
+  }
+
+  return null;
 }
 
 function resolveBare(specifier, fromFile) {
@@ -98,7 +115,20 @@ function resolveBare(specifier, fromFile) {
     return null;
   }
 
-  return resolveCandidates(path.join(pkgDir, subpath), specifier, BARE_CANDIDATES);
+  const basePath = path.join(pkgDir, subpath);
+
+  const direct = resolveCandidates(basePath, specifier, BARE_CANDIDATES);
+  if (direct) return direct;
+
+  if (isDirectory(basePath)) {
+    return resolveCandidates(
+      path.join(basePath, 'index'),
+      specifier + '/index',
+      BARE_CANDIDATES
+    );
+  }
+
+  return null;
 }
 
 function resolveCandidates(basePath, specifier, candidates) {
@@ -113,7 +143,8 @@ function resolveCandidates(basePath, specifier, candidates) {
 
 /**
  * Locate a package directory by walking up the `node_modules` chain, starting
- * from the importing file's directory.
+ * from the importing file's directory. Also handles self-referencing: if a
+ * directory's own `package.json` names the package, that directory is returned.
  */
 function findPackageDir(pkg, fromDir) {
   let dir = fromDir;
@@ -125,6 +156,10 @@ function findPackageDir(pkg, fromDir) {
       return candidate;
     }
 
+    if (readJson(path.join(dir, 'package.json'))?.name === pkg) {
+      return dir;
+    }
+
     const parent = path.dirname(dir);
 
     if (parent === dir) {
@@ -189,3 +224,49 @@ function isDirectory(p) {
     return false;
   }
 }
+
+function readJson(filePath) {
+  try {
+    return JSON.parse(fs.readFileSync(filePath, 'utf8'));
+  } catch {
+    return null;
+  }
+}
+
+/**
+ * Returns true if the bare subpath import is declared in the package's
+ * `exports` field, meaning it is already valid for ESM and should not be
+ * rewritten.
+ */
+function isSubpathExported(specifier, fromFile) {
+  const { pkg, subpath } = parseBare(specifier);
+  if (!subpath) return false;
+
+  const pkgDir = findPackageDir(pkg, path.dirname(fromFile));
+  if (!pkgDir) return false;
+
+  const exports = readJson(path.join(pkgDir, 'package.json'))?.exports;
+  if (!exports || typeof exports !== 'object') return false;
+
+  const key = './' + subpath;
+
+  if (key in exports) return true;
+
+  for (const [ pattern, valueTemplate ] of Object.entries(exports)) {
+    if (!pattern.includes('*') || typeof valueTemplate !== 'string') {
+      continue;
+    }
+
+    const escaped = pattern.replace(/[.+?^${}()|[\]\\]/g, '\\$&').replace(/\*/g, '(.*)');
+    const match = new RegExp('^' + escaped + '$').exec(key);
+
+    if (!match) continue;
+
+    // wildcard matched: only treat as already-valid if the resolved target
+    // is an actual file — a directory target still needs rewriting to index.js
+    const resolved = valueTemplate.replace(/\*/g, match[1]);
+    if (isFile(path.join(pkgDir, resolved))) return true;
+  }
+
+  return false;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bpmn-io/codemods",
-  "version": "0.2.1",
+  "version": "0.3.1",
   "description": "A collection of codemods for the bpmn.io ecosystem.",
   "type": "module",
   "bin": {