babel-plugin-transform-replace-expressions - npm Package Compare versions

Comparing version 0.1.1 to 0.2.0

index.js

@@ -5,16 +5,45 @@ const { parseExpression } = require("@babel/parser");
   const replace = options.replace || {};
+  const allowConflictingReplacements = !!options.allowConflictingReplacements;
 
+  function asArray(obj) {
+    if (Array.isArray(obj)) {
+      return obj;
+    }
+    return Object.keys(obj).map(key => [key, obj[key]]);
+  }
+
   const types = new Map();
-  const values = new Set();
-  Object.keys(replace).forEach(key => {
+  asArray(replace).forEach(([key, value]) => {
     const kNode = parseExpression(key);
-    const vNode = parseExpression(replace[key]);
+    const vNode = parseExpression(value);
 
     const candidates = types.get(kNode.type) || [];
-    candidates.push({ key: kNode, value: vNode });
+    candidates.push({ key: kNode, value: vNode, originalKey: key });
     types.set(kNode.type, candidates);
 
-    values.add(vNode);
+    for (let i = 0; i < candidates.length - 1; i++) {
+      if (!t.isNodesEquivalent(candidates[i].key, kNode)) {
+        continue;
+      }
+
+      if (allowConflictingReplacements) {
+        candidates[i] = candidates.pop();
+        break;
+      }
+
+      throw new Error(
+        `Expressions ${JSON.stringify(
+          candidates[i].originalKey
+        )} and ${JSON.stringify(key)} conflict`
+      );
+    }
   });
 
+  const values = new Set();
+  types.forEach(candidates => {
+    candidates.forEach(candidate => {
+      values.add(candidate.value);
+    });
+  });
+
   return {
@@ -21,0 +50,0 @@ name: "transform-replace-expressions",

package.json

 {
   "name": "babel-plugin-transform-replace-expressions",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Replace JavaScript expressions with other expressions",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -1,2 +0,2 @@
-# babel-plugin-transform-replace-expressions [![CircleCI](https://circleci.com/gh/jviide/babel-plugin-transform-replace-expressions.svg?style=shield)](https://circleci.com/gh/jviide/babel-plugin-transform-replace-expressions) ![npm](https://img.shields.io/npm/v/babel-plugin-transform-replace-expressions.svg)
+# babel-plugin-transform-replace-expressions [![CircleCI](https://circleci.com/gh/jviide/babel-plugin-transform-replace-expressions.svg?style=shield)](https://circleci.com/gh/jviide/babel-plugin-transform-replace-expressions) [![npm](https://img.shields.io/npm/v/babel-plugin-transform-replace-expressions.svg)](https://www.npmjs.com/package/babel-plugin-transform-replace-expressions)
 
@@ -47,2 +47,25 @@ Replace JavaScript expressions with other expressions.
 
+## Conflict resolution
+
+A conflict happens when two replacements have the same Babel [abstract syntax tree](https://en.wikipedia.org/wiki/Abstract_syntax_tree) representation. For example expressions `typeof A` and `typeof (A)` are formatted differently but have the same AST representation as far as the plugin is concerned. In those situations the default is to raise an error, and can be overwritten by setting the option `allowConflictingReplacements` to `true`. 
+
+You can also always give the replacements as an array of key-value pairs. When `allowConflictingReplacements` is set to `true` the _last_ conflicting replacement gets selected.
+
+```js
+{
+  "plugins": [
+    [
+      "babel-plugin-transform-replace-expressions",
+      {
+        "replace": [
+          ["typeof A", "B"],
+          ["typeof (A)", "C"]
+        ],
+        "allowConflictingReplacements": true
+      }
+    ]
+  ]
+}
+```
+
 ## Notes
@@ -49,0 +72,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

6414

increased by36.61%

Lines of code

69

increased by56.82%

Number of lines in readme file

93

increased by32.86%

No dependency changes