Add support for transformation opt-out

Author: qnighy

CHANGELOG.md

@@ -3,6 +3,10 @@
 - Added
   - Add support for refs
   - Add support for state types
+  - Add support for opt-out in one of:
+    - `@abstract` JSDoc comment
+    - `abstract` modifier
+    - `react-declassify-disable` comment
 - Fixed
   - Keep generator/async flags
   - Fix renaming failure in some cases

src/analysis/head.ts

@@ -10,6 +10,21 @@ export type ComponentHead = {
 };
 
 export function analyzeHead(path: NodePath<ClassDeclaration>): ComponentHead | undefined {
+  if (path.node.leadingComments?.some((comment) => /react-declassify-disable/.test(comment.value))) {
+    // Explicitly disabled
+    return;
+  }
+  if (
+    path.node.leadingComments?.some((comment) =>
+      comment.type === "CommentBlock" &&
+      /^\*/.test(comment.value) &&
+      /@abstract/.test(comment.value)
+    )
+    || path.node.abstract
+  ) {
+    // This is an abstract class to be inherited; do not attempt transformation.
+    return;
+  }
   const superClass = path.get("superClass");
   if (!superClass.isExpression()) {
     return;

src/index.test.ts

@@ -101,7 +101,7 @@ describe("react-declassify", () => {
       class C extends React.Component {}
     `;
     const output = dedent`\
-      /* react-declassify:disabled Cannot perform transformation: Missing render method */
+      /* react-declassify-disable Cannot perform transformation: Missing render method */
       class C extends React.Component {}
     `;
     expect(transform(input)).toBe(output);
@@ -114,7 +114,7 @@ describe("react-declassify", () => {
       }
     `;
     const output = dedent`\
-      /* react-declassify:disabled Cannot perform transformation: Missing render method */
+      /* react-declassify-disable Cannot perform transformation: Missing render method */
       class C extends React.Component {
         rende() {}
       }
@@ -295,6 +295,37 @@ describe("react-declassify", () => {
       `;
       expect(transform(input)).toBe(input);
     });
+
+    describe("opt-out", () => {
+      it("ignores if marked as react-declassify-disable", () => {
+        const input = dedent`\
+          /* react-declassify-disable */
+          class C extends React.Component {
+            render() {}
+          }
+        `;
+        expect(transform(input)).toBe(input);
+      });
+
+      it("ignores if marked as abstract", () => {
+        const input = dedent`\
+          abstract class C extends React.Component {
+            render() {}
+          }
+        `;
+        expect(transform(input, { ts: true })).toBe(input);
+      });
+
+      it("ignores if marked as @abstract", () => {
+        const input = dedent`\
+          /** @abstract */
+          class C extends React.Component {
+            render() {}
+          }
+        `;
+        expect(transform(input)).toBe(input);
+      });
+    });
   });
 
   describe("Class forms", () => {

src/index.ts

@@ -45,7 +45,7 @@ export default function plugin(babel: typeof import("@babel/core")): PluginObj<P
             if (!(e instanceof AnalysisError)) {
               throw e;
             }
-            t.addComment(declPath.node, "leading", ` react-declassify:disabled Cannot perform transformation: ${e.message} `);
+            t.addComment(declPath.node, "leading", ` react-declassify-disable Cannot perform transformation: ${e.message} `);
             refreshComments(declPath.node);
           }
         } else {
@@ -67,7 +67,7 @@ export default function plugin(babel: typeof import("@babel/core")): PluginObj<P
             if (!(e instanceof AnalysisError)) {
               throw e;
             }
-            t.addComment(path.node, "leading", ` react-declassify:disabled Cannot perform transformation: ${e.message} `);
+            t.addComment(path.node, "leading", ` react-declassify-disable Cannot perform transformation: ${e.message} `);
             refreshComments(path.node);
           }
         }