react-remove-props-loader 1.0.4 → 1.1.3

package/README.md

@@ -2,6 +2,7 @@
 
 [![Version](https://img.shields.io/npm/v/react-remove-props-loader.svg)](https://www.npmjs.com/package/react-remove-props-loader)
 [![Downloads](https://img.shields.io/npm/dt/react-remove-props-loader.svg)](https://www.npmjs.com/package/react-remove-props-loader)
+[![CI](https://github.com/Mercateo/react-remove-props-loader/actions/workflows/main.yml/badge.svg?branch=master)](https://github.com/Mercateo/react-remove-props-loader/actions/workflows/main.yml?query=branch%3Amaster)
 
 A webpack loader for removing React props or JSX attributes in TypeScript/JavaScript code.
 
@@ -30,8 +31,10 @@ module.exports = {
             loader: "react-remove-props-loader",
             options: {
               props: ["data-testid", "data-test-id"],
-              // Optionally, set the kind of the script. Defaults to `ScriptKind.JSX`.
+              // (Optional) Set the kind of the script. Defaults to `ScriptKind.JSX`.
               scriptKind: ScriptKind.TSX,
+              // (Optional) Set whether to remove specified props from objects. Defaults to `false`.
+              removeFromObjects: true,
             },
           },
         ],
@@ -40,3 +43,37 @@ module.exports = {
   },
 };
 ```
+
+## Example
+
+### Source
+
+```tsx
+import React, { FC } from "react";
+
+export const ExampleComponent: FC = () => {
+  const propsObject = { "data-test-id": "example-prop" };
+  return (
+    <div data-testid="example-prop" {...propsObject}>
+      Example Component
+    </div>
+  );
+};
+```
+
+### Transformed
+
+Code transformed with the sample settings above.
+
+```tsx
+import React, { FC } from "react";
+
+export const ExampleComponent: FC = () => {
+  const propsObject = { };
+  return (
+    <div {...propsObject}>
+      Example Component
+    </div>
+  );
+};
+```

package/dist/loader.d.ts

@@ -5,6 +5,8 @@ export interface LoaderOptions {
     props: string[];
     /** The kind of script to remove the React props from. For example, `ScriptKind.TSX`. */
     scriptKind?: ScriptKind;
+    /** Whether to remove specified props from objects. */
+    removeFromObjects?: boolean;
 }
 declare const loader: LoaderDefinitionFunction<LoaderOptions>;
 export default loader;

package/dist/loader.js

@@ -12,10 +12,15 @@ const loader = function (content) {
         scriptKind,
         overwrite: true,
     });
-    const jsxAttributes = sourceFile.getDescendantsOfKind(ts_morph_1.SyntaxKind.JsxAttribute);
-    for (const attribute of jsxAttributes) {
-        if (propsToRemove.includes(attribute.getName())) {
-            attribute.remove();
+    let descendants = sourceFile.getDescendantsOfKind(ts_morph_1.SyntaxKind.JsxAttribute);
+    if (options.removeFromObjects) {
+        const objectProps = sourceFile.getDescendantsOfKind(ts_morph_1.SyntaxKind.PropertyAssignment);
+        descendants = descendants.concat(objectProps);
+    }
+    for (const descendant of descendants) {
+        const descendantName = descendant.getName().replace(/['"]+/g, "");
+        if (propsToRemove.includes(descendantName)) {
+            descendant.remove();
         }
     }
     sourceFile.saveSync();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-remove-props-loader",
-  "version": "1.0.4",
+  "version": "1.1.3",
   "description": "Webpack loader for removing React props or JSX attributes in TypeScript/JavaScript code.",
   "main": "dist/index",
   "repository": "https://github.com/Mercateo/react-remove-props-loader.git",
@@ -18,16 +18,16 @@
     "prepublishOnly": "yarn build"
   },
   "dependencies": {
-    "ts-morph": "^11.0.3"
+    "ts-morph": "^13.0.2"
   },
   "devDependencies": {
-    "@types/jest": "^26.0.24",
-    "jest": "^27.0.6",
-    "ts-jest": "^27.0.3",
-    "typescript": "^4.3.5",
-    "webpack": "^5.44.0"
+    "@types/jest": "^27.0.3",
+    "jest": "^27.4.4",
+    "ts-jest": "^27.1.1",
+    "typescript": "^4.5.3",
+    "webpack": "^5.65.0"
   },
   "peerDependencies": {
-    "webpack": ">5.0.0"
+    "webpack": ">=5.0.0"
   }
 }