Revert removal of pipe-operator smart mix

For backwards compatibility until next major change. To maintain simplicity in the code before smart mix is removed, smart mix was modified to match the new Hack-pipe proposal: • No early errors for sequences in pipe heads or bodies. • Function declarations and if/catch/for/with statements do not hide outer topics.
babel · Apr 14, 2021 · 11a7a49 · 11a7a49
1 parent f58fcf6
commit 11a7a49
Show file tree

Hide file tree

Showing 61 changed files with 1,066 additions and 59 deletions.
diff --git a/packages/babel-generator/src/generators/types.ts b/packages/babel-generator/src/generators/types.ts
@@ -236,6 +236,7 @@ export function DecimalLiteral(this: Printer, node: t.DecimalLiteral) {
   this.word(node.value + "m");
 }
 
+// Hack pipe operator
 export function TopicReference(this: Printer) {
   const { topicToken } = this.format;
   switch (topicToken) {
@@ -250,3 +251,22 @@ export function TopicReference(this: Printer) {
     }
   }
 }
+
+// Smart-mix pipe operator
+export function PipelineTopicExpression(
+  this: Printer,
+  node: t.PipelineTopicExpression,
+) {
+  this.print(node.expression, node);
+}
+
+export function PipelineBareFunction(
+  this: Printer,
+  node: t.PipelineBareFunction,
+) {
+  this.print(node.callee, node);
+}
+
+export function PipelinePrimaryTopicReference(this: Printer) {
+  this.token("#");
+}
diff --git a/packages/babel-generator/test/fixtures/types/PipelinePrimaryTopicReference/input.js b/packages/babel-generator/test/fixtures/types/PipelinePrimaryTopicReference/input.js
@@ -0,0 +1 @@
+2 + 3 |> #.toString(16);
diff --git a/packages/babel-generator/test/fixtures/types/PipelinePrimaryTopicReference/options.json b/packages/babel-generator/test/fixtures/types/PipelinePrimaryTopicReference/options.json
@@ -0,0 +1,3 @@
+{
+  "plugins": [["pipelineOperator", { "proposal": "smart" }]]
+}
diff --git a/packages/babel-generator/test/fixtures/types/PipelinePrimaryTopicReference/output.js b/packages/babel-generator/test/fixtures/types/PipelinePrimaryTopicReference/output.js
@@ -0,0 +1 @@
+2 + 3 |> #.toString(16);
diff --git a/packages/babel-parser/ast/spec.md b/packages/babel-parser/ast/spec.md
@@ -1393,3 +1393,52 @@ interface ExportAllDeclaration <: ModuleDeclaration {
 ```
 
 An export batch declaration, e.g., `export * from "mod";`.
+
+### Smart-mix pipelines
+
+They are used by the smart-mix pipe operator to determine
+the type of a pipe expression's the body expression.
+The Hack and F# pipe operators use simple `BinaryExpression`s.
+
+#### PipelineBody
+
+```js
+interface PipelineBody <: NodeBase {
+    type: "PipelineBody";
+}
+```
+
+#### PipelineBareFunctionBody
+
+```js
+interface PipelineBody <: NodeBase {
+    type: "PipelineBareFunctionBody";
+    callee: Expression;
+}
+```
+
+#### PipelineBareConstructorBody
+
+```js
+interface PipelineBareConstructorBody <: NodeBase {
+    type: "PipelineBareConstructorBody";
+    callee: Expression;
+}
+```
+
+#### PipelineBareAwaitedFunctionBody
+
+```js
+interface PipelineBareConstructorBody <: NodeBase {
+    type: "PipelineTopicBody";
+    expression: Expression;
+}
+```
+
+#### PipelineTopicBody
+
+```js
+interface PipelineBareConstructorBody <: NodeBase {
+    type: "PipelineBareAwaitedFunctionBody";
+    callee: Expression;
+}
diff --git a/packages/babel-parser/src/parser/error-message.js b/packages/babel-parser/src/parser/error-message.js
@@ -132,7 +132,7 @@ export const ErrorMessages = Object.freeze({
   PipeBodyCannotBeArrow:
     'Unexpected arrow "=>" after pipeline body; arrow function acting as pipe body must be parenthesized due to operator precedence.',
   PipeTopicRequiresHackPipes:
-    'Topic reference is used, but the pipelineOperator plugin was not passed a "proposal": "hack" option.',
+    'Topic reference is used, but the pipelineOperator plugin was not passed a "proposal": "hack" or "smart" option.',
   PipeTopicUnbound:
     "Topic reference is unbound; it must be inside a Hack-style pipe body.",
   PipeTopicUnused:

diff --git a/packages/babel-parser/src/parser/expression.js b/packages/babel-parser/src/parser/expression.js
@@ -464,6 +464,13 @@ export default class ExpressionParser extends LValParser {
               this.checkHackPipeBodyEarlyErrors(startPos);
               return bodyExpr;
             });
+
+          case "smart":
+            return this.withTopicBindingContext(() => {
+              const childExpr = this.parseExprOpBaseRightExpr(op, prec);
+              return this.parseSmartPipelineBodyInStyle(childExpr);
+            });
+
           case "fsharp":
             return this.withSoloAwaitPermittingContext(() => {
               return this.parseFSharpPipelineBody(prec);
@@ -1149,9 +1156,17 @@ export default class ExpressionParser extends LValParser {
         if (this.state.inPipeline) {
           node = this.startNode();
 
-          if (this.getPluginOption("pipelineOperator", "proposal") !== "hack") {
-            this.raise(node.start, Errors.PipeTopicRequiresHackPipes);
-          }
+          const proposal = this.getPluginOption("pipelineOperator", "proposal");
+          const proposalToNodeType = {
+            hack: "TopicReference",
+            smart: "PipelinePrimaryTopicReference",
+          };
+          const throwPipeTopicRequiresHackPipesError = () => {
+            throw this.raise(node.start, Errors.PipeTopicRequiresHackPipes);
+          };
+          const nodeType =
+            proposalToNodeType[proposal] ||
+            throwPipeTopicRequiresHackPipesError();
 
           this.next();
 
@@ -1160,7 +1175,8 @@ export default class ExpressionParser extends LValParser {
           }
 
           this.registerTopicReference();
-          return this.finishNode(node, "TopicReference");
+
+          return this.finishNode(node, nodeType);
         }
 
         // https://tc39.es/proposal-private-fields-in-in
@@ -2474,12 +2490,42 @@ export default class ExpressionParser extends LValParser {
     if (this.match(tt.arrow)) {
       throw this.raise(this.state.start, Errors.PipeBodyCannotBeArrow);
     }
+
     // A Hack pipe body must use the topic reference at least once.
     else if (!this.topicReferenceWasUsedInCurrentContext()) {
       this.raise(startPos, Errors.PipeTopicUnused);
     }
   }
 
+  parseSmartPipelineBodyInStyle(
+    childExpr: N.Expression,
+    startPos: number,
+    startLoc: Position,
+  ): N.PipelineBody {
+    const bodyNode = this.startNodeAt(startPos, startLoc);
+    if (this.isSimpleReference(childExpr)) {
+      bodyNode.callee = childExpr;
+      return this.finishNode(bodyNode, "PipelineBareFunction");
+    } else {
+      this.checkHackPipeBodyEarlyErrors(startPos);
+      bodyNode.expression = childExpr;
+      return this.finishNode(bodyNode, "PipelineTopicExpression");
+    }
+  }
+
+  isSimpleReference(expression: N.Expression): boolean {
+    switch (expression.type) {
+      case "MemberExpression":
+        return (
+          !expression.computed && this.isSimpleReference(expression.object)
+        );
+      case "Identifier":
+        return true;
+      default:
+        return false;
+    }
+  }
+
   // Enable topic references from outer contexts within Hack-style pipe bodies.
   // The function modifies the parser's topic-context state to enable or disable
   // the use of topic references.

diff --git a/packages/babel-parser/src/plugin-utils.js b/packages/babel-parser/src/plugin-utils.js
@@ -38,7 +38,7 @@ export function getPluginOption(
   return null;
 }
 
-const PIPELINE_PROPOSALS = ["minimal", "fsharp", "hack"];
+const PIPELINE_PROPOSALS = ["minimal", "fsharp", "hack", "smart"];
 const TOPIC_TOKENS = ["#"];
 const RECORD_AND_TUPLE_SYNTAX_TYPES = ["hash", "bar"];
 

diff --git a/packages/babel-parser/src/types.js b/packages/babel-parser/src/types.js
@@ -609,6 +609,26 @@ export type TopicReference = NodeBase & {
   type: "TopicReference",
 };
 
+// Smart-mix pipe operator
+
+export type PipelineBody = NodeBase & {
+  type: "PipelineBody",
+};
+
+export type PipelineBareFunctionBody = NodeBase & {
+  type: "PipelineBareFunctionBody",
+  callee: Expression,
+};
+
+export type PipelineTopicBody = NodeBase & {
+  type: "PipelineTopicBody",
+  expression: Expression,
+};
+
+export type PipelinePrimaryTopicReference = NodeBase & {
+  type: "PipelinePrimaryTopicReference",
+};
+
 // Template Literals
 
 export type TemplateLiteral = NodeBase & {

diff --git a/...r/test/fixtures/experimental/pipeline-operator/fsharp-proposal-invalid-topic/options.json b/...r/test/fixtures/experimental/pipeline-operator/fsharp-proposal-invalid-topic/options.json
@@ -1,3 +1,4 @@
 {
-  "plugins": [["pipelineOperator", { "proposal": "fsharp" }]]
+  "plugins": [["pipelineOperator", { "proposal": "fsharp" }]],
+  "throws": "Topic reference is used, but the pipelineOperator plugin was not passed a \"proposal\": \"hack\" or \"smart\" option. (1:5)"
 }
diff --git a/...er/test/fixtures/experimental/pipeline-operator/fsharp-proposal-invalid-topic/output.json b/...er/test/fixtures/experimental/pipeline-operator/fsharp-proposal-invalid-topic/output.json
diff --git a/...s/babel-parser/test/fixtures/experimental/pipeline-operator/invalid-proposal/options.json b/...s/babel-parser/test/fixtures/experimental/pipeline-operator/invalid-proposal/options.json
@@ -8,5 +8,5 @@
     ],
     "estree"
   ],
-  "throws": "\"pipelineOperator\" requires \"proposal\" option whose value must be one of: \"minimal\", \"fsharp\", \"hack\"."
+  "throws": "\"pipelineOperator\" requires \"proposal\" option whose value must be one of: \"minimal\", \"fsharp\", \"hack\", \"smart\"."
 }
diff --git a/...al-nested-pipelines-with-arrow-function-and-tacit-function-call-with-outer-topic/input.js b/...al-nested-pipelines-with-arrow-function-and-tacit-function-call-with-outer-topic/input.js
@@ -0,0 +1 @@
+x |> (() => # |> f)
diff --git a/...ested-pipelines-with-arrow-function-and-tacit-function-call-with-outer-topic/options.json b/...ested-pipelines-with-arrow-function-and-tacit-function-call-with-outer-topic/options.json
@@ -0,0 +1,3 @@
+{
+  "plugins": [["pipelineOperator", { "proposal": "smart" }]]
+}
diff --git a/...nested-pipelines-with-arrow-function-and-tacit-function-call-with-outer-topic/output.json b/...nested-pipelines-with-arrow-function-and-tacit-function-call-with-outer-topic/output.json
@@ -0,0 +1,73 @@
+{
+  "type": "File",
+  "start":0,"end":19,"loc":{"start":{"line":1,"column":0},"end":{"line":1,"column":19}},
+  "program": {
+    "type": "Program",
+    "start":0,"end":19,"loc":{"start":{"line":1,"column":0},"end":{"line":1,"column":19}},
+    "sourceType": "script",
+    "interpreter": null,
+    "body": [
+      {
+        "type": "ExpressionStatement",
+        "start":0,"end":19,"loc":{"start":{"line":1,"column":0},"end":{"line":1,"column":19}},
+        "expression": {
+          "type": "BinaryExpression",
+          "start":0,"end":19,"loc":{"start":{"line":1,"column":0},"end":{"line":1,"column":19}},
+          "left": {
+            "type": "Identifier",
+            "start":0,"end":1,"loc":{"start":{"line":1,"column":0},"end":{"line":1,"column":1},"identifierName":"x"},
+            "name": "x"
+          },
+          "operator": "|>",
+          "right": {
+            "type": "PipelineTopicExpression",
+            "end": 19,
+            "loc": {
+              "end": {
+                "line": 1,
+                "column": 19
+              }
+            },
+            "expression": {
+              "type": "ArrowFunctionExpression",
+              "start":6,"end":18,"loc":{"start":{"line":1,"column":6},"end":{"line":1,"column":18}},
+              "extra": {
+                "parenthesized": true,
+                "parenStart": 5
+              },
+              "id": null,
+              "generator": false,
+              "async": false,
+              "params": [],
+              "body": {
+                "type": "BinaryExpression",
+                "start":12,"end":18,"loc":{"start":{"line":1,"column":12},"end":{"line":1,"column":18}},
+                "left": {
+                  "type": "PipelinePrimaryTopicReference",
+                  "start":12,"end":13,"loc":{"start":{"line":1,"column":12},"end":{"line":1,"column":13}}
+                },
+                "operator": "|>",
+                "right": {
+                  "type": "PipelineBareFunction",
+                  "end": 18,
+                  "loc": {
+                    "end": {
+                      "line": 1,
+                      "column": 18
+                    }
+                  },
+                  "callee": {
+                    "type": "Identifier",
+                    "start":17,"end":18,"loc":{"start":{"line":1,"column":17},"end":{"line":1,"column":18},"identifierName":"f"},
+                    "name": "f"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    ],
+    "directives": []
+  }
+}
diff --git a/...nested-pipelines-with-arrow-function-and-tacit-function-call-without-outer-topic/input.js b/...nested-pipelines-with-arrow-function-and-tacit-function-call-without-outer-topic/input.js
@@ -0,0 +1 @@
+x |> ($ => $ |> f)
diff --git a/...ed-pipelines-with-arrow-function-and-tacit-function-call-without-outer-topic/options.json b/...ed-pipelines-with-arrow-function-and-tacit-function-call-without-outer-topic/options.json
@@ -0,0 +1,3 @@
+{
+  "plugins": [["pipelineOperator", { "proposal": "smart" }]]
+}