fix: Better support for .vue. and .svelte files using `jscodeshif…

…t-adapters` (#71)
getsentry · Aug 6, 2024 · 1b25226 · 1b25226
1 parent aa128ad
commit 1b25226
Show file tree

Hide file tree

Showing 20 changed files with 1,652 additions and 1,609 deletions.
diff --git a/package.json b/package.json
@@ -40,6 +40,7 @@
     "chalk": "^5.3.0",
     "globby": "^14.0.1",
     "jscodeshift": "^0.15.2",
+    "jscodeshift-adapters": "1.0.2",
     "node-html-parser": "^6.1.13",
     "semver": "^7.6.0",
     "yargs": "^17.7.2"

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/index.js b/src/index.js
@@ -28,7 +28,7 @@ async function _run() {
     .option('ignoreFilePatterns', {
       alias: 'if',
       describe: 'Glob pattern which files should be ignored',
-      default: ['node_modules', '**/*.svelte'],
+      default: ['node_modules'],
       type: 'string',
       array: true,
     })

diff --git a/src/transformers/addMigrationComments/transform.cjs b/src/transformers/addMigrationComments/transform.cjs
@@ -1,6 +1,6 @@
+const { adapt } = require('jscodeshift-adapters');
 const Sentry = require('@sentry/node');
 
-const { wrapJscodeshift } = require('../../utils/dom.cjs');
 const { addTodoComment } = require('../../utils/jscodeshift.cjs');
 
 /**
@@ -9,94 +9,93 @@ const { addTodoComment } = require('../../utils/jscodeshift.cjs');
  *
  * @type {import('jscodeshift').Transform}
  */
-module.exports = function (fileInfo, api) {
+function addMigrationComments(fileInfo, api) {
   const j = api.jscodeshift;
   const source = fileInfo.source;
-  const fileName = fileInfo.path;
 
-  return wrapJscodeshift(j, source, fileName, (j, source) => {
-    const tree = j(source);
+  const tree = j(source);
 
-    let hasChanges = false;
+  let hasChanges = false;
 
-    const methodCommentMap = new Map([
-      [
-        'startTransaction',
-        'Use `startInactiveSpan()` instead - see https://github.com/getsentry/sentry-javascript/blob/develop/docs/v8-new-performance-apis.md',
-      ],
-      [
-        'startChild',
-        'Use `startInactiveSpan()` instead - see https://github.com/getsentry/sentry-javascript/blob/develop/docs/v8-new-performance-apis.md',
-      ],
-      [
-        'makeMain',
-        'Use `setCurrentClient()` instead - see https://github.com/getsentry/sentry-javascript/blob/develop/docs/v8-initializing.md',
-      ],
-      [
-        'getActiveTransaction',
-        'Use `getActiveSpan()` instead. If you use this only to start a child, use `startInactiveSpan({ onlyIfParent: true })` instead - see https://github.com/getsentry/sentry-javascript/blob/develop/docs/v8-new-performance-apis.md',
-      ],
-    ]);
+  const methodCommentMap = new Map([
+    [
+      'startTransaction',
+      'Use `startInactiveSpan()` instead - see https://github.com/getsentry/sentry-javascript/blob/develop/docs/v8-new-performance-apis.md',
+    ],
+    [
+      'startChild',
+      'Use `startInactiveSpan()` instead - see https://github.com/getsentry/sentry-javascript/blob/develop/docs/v8-new-performance-apis.md',
+    ],
+    [
+      'makeMain',
+      'Use `setCurrentClient()` instead - see https://github.com/getsentry/sentry-javascript/blob/develop/docs/v8-initializing.md',
+    ],
+    [
+      'getActiveTransaction',
+      'Use `getActiveSpan()` instead. If you use this only to start a child, use `startInactiveSpan({ onlyIfParent: true })` instead - see https://github.com/getsentry/sentry-javascript/blob/develop/docs/v8-new-performance-apis.md',
+    ],
+  ]);
 
-    // Find `xxx()` calls
-    tree
-      .find(j.CallExpression, {
-        callee: {
-          type: 'Identifier',
-        },
-      })
-      .forEach(path => {
-        if (path.value.callee.type === 'Identifier') {
-          const comment = methodCommentMap.get(path.value.callee.name);
-          if (comment) {
-            hasChanges = true;
-            addTodoComment(j, path, comment);
-          }
+  // Find `xxx()` calls
+  tree
+    .find(j.CallExpression, {
+      callee: {
+        type: 'Identifier',
+      },
+    })
+    .forEach(path => {
+      if (path.value.callee.type === 'Identifier') {
+        const comment = methodCommentMap.get(path.value.callee.name);
+        if (comment) {
+          hasChanges = true;
+          addTodoComment(j, path, comment);
         }
-      });
+      }
+    });
 
-    // Find `Sentry.xxx()`  calls
-    tree
-      .find(j.CallExpression, {
-        callee: {
-          type: 'MemberExpression',
-          property: {
-            type: 'Identifier',
-          },
+  // Find `Sentry.xxx()`  calls
+  tree
+    .find(j.CallExpression, {
+      callee: {
+        type: 'MemberExpression',
+        property: {
+          type: 'Identifier',
         },
-      })
-      .forEach(path => {
-        if (path.value.callee.type === 'MemberExpression' && path.value.callee.property.type === 'Identifier') {
-          const comment = methodCommentMap.get(path.value.callee.property.name);
-          if (comment) {
-            hasChanges = true;
-            addTodoComment(j, path, comment);
-          }
+      },
+    })
+    .forEach(path => {
+      if (path.value.callee.type === 'MemberExpression' && path.value.callee.property.type === 'Identifier') {
+        const comment = methodCommentMap.get(path.value.callee.property.name);
+        if (comment) {
+          hasChanges = true;
+          addTodoComment(j, path, comment);
         }
-      });
-
-    // Find `new Hub()` & `new Sentry.Hub()`
-    tree.find(j.NewExpression).forEach(path => {
-      if (
-        (path.value.callee.type === 'Identifier' && path.value.callee.name === 'Hub') ||
-        (path.value.callee.type === 'MemberExpression' &&
-          path.value.callee.property.type === 'Identifier' &&
-          path.value.callee.property.name === 'Hub')
-      ) {
-        hasChanges = true;
-        addTodoComment(
-          j,
-          path,
-          'Use `new Scope()` instead - see https://github.com/getsentry/sentry-javascript/blob/develop/docs/v8-initializing.md'
-        );
       }
     });
 
-    if (hasChanges) {
-      Sentry.setTag('added-todo-comments', true);
-      Sentry.metrics.increment('added-todo-comments', 1);
+  // Find `new Hub()` & `new Sentry.Hub()`
+  tree.find(j.NewExpression).forEach(path => {
+    if (
+      (path.value.callee.type === 'Identifier' && path.value.callee.name === 'Hub') ||
+      (path.value.callee.type === 'MemberExpression' &&
+        path.value.callee.property.type === 'Identifier' &&
+        path.value.callee.property.name === 'Hub')
+    ) {
+      hasChanges = true;
+      addTodoComment(
+        j,
+        path,
+        'Use `new Scope()` instead - see https://github.com/getsentry/sentry-javascript/blob/develop/docs/v8-initializing.md'
+      );
     }
-
-    return hasChanges ? tree.toSource() : undefined;
   });
-};
+
+  if (hasChanges) {
+    Sentry.setTag('added-todo-comments', true);
+    Sentry.metrics.increment('added-todo-comments', 1);
+  }
+
+  return hasChanges ? tree.toSource() : undefined;
+}
+
+module.exports = adapt(addMigrationComments);