prettier 2.0.0.pre.rc1 → 2.0.0.pre.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1015fa9f7c5b4f580afa9c6b24042c8799762e5d13835dbb492abfe33f676b8
-  data.tar.gz: 53045f82f75561082c6120d836d3abdffb07cccb31e5272442ef2608014f8f6d
+  metadata.gz: 63604b2dbf27994c44f507ef2e0b22d257c5371f45e66a78fa805c82313c5166
+  data.tar.gz: 546196f52a8a0ac8034e8cf4d170f61a916f9948f109d9bba18ff0d60160b100
 SHA512:
-  metadata.gz: 4f4541af3e4e4047f03c4c34890506b25126d34e052b92023d40e7bb68b5184cfce9c91ba5794478b21b61952e1823d4f7e08d51b52d468a9de61f270f9d61a0
-  data.tar.gz: 983d6da92e456dae0f081a2ee4b77f4a47d540415f991c51d91006a2847ac38937574e76f82bd376fb9e47401deeb5bd77414c10b3ab80a9d4adaa7a7e66499e
+  metadata.gz: 034daa67861d8ac125b501dc00729b3830889a9182befa40c147f4459118b62565cc1ff458ed691a6e16d290f3ba2690aa241a620f38cfe17970fd5660a332aa
+  data.tar.gz: 7d5d1bd5e45859d32df6d7bc151fc229bcec702d5eb556b16b5b21a58986f5d319d891aa082aff1eac68a962b120593415fa0160b37e8ee99e835453a6fec4ee

data/CHANGELOG.md

@@ -6,6 +6,17 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [2.0.0-rc2]
+
+### Added
+
+- [#979](https://github.com/prettier/plugin-ruby/issues/979) - ronocod, kddnewton - Alignment of `to_not` is explicitly allowed to not indent to better support rspec.
+- [#894](https://github.com/prettier/plugin-ruby/issues/894) - mister-what, kddnewton - Add a warning that this plugin will not function with the plug'n'play filesystem provided by yarn berry.
+
+### Changed
+
+- [#943](https://github.com/prettier/plugin-ruby/issues/943) - valscion, kddnewton - Trailing call operators that are followed by comments should stay on the first line.
+
 ## [2.0.0-rc1]
 
 ### Added
@@ -1151,7 +1162,8 @@ would previously result in `array[]`, but now prints properly.
 
 - Initial release 🎉
 
-[unreleased]: https://github.com/prettier/plugin-ruby/compare/v2.0.0-rc1...HEAD
+[unreleased]: https://github.com/prettier/plugin-ruby/compare/v2.0.0-rc2...HEAD
+[2.0.0-rc2]: https://github.com/prettier/plugin-ruby/compare/v2.0.0-rc1...v2.0.0-rc2
 [2.0.0-rc1]: https://github.com/prettier/plugin-ruby/compare/v1.6.1...v2.0.0-rc1
 [1.6.1]: https://github.com/prettier/plugin-ruby/compare/v1.6.0...v1.6.1
 [1.6.0]: https://github.com/prettier/plugin-ruby/compare/v1.5.5...v1.6.0

data/dist/parser/parseSync.js

@@ -95,12 +95,26 @@ function spawnServer() {
     const [cmd, ...args] = info.stdout.toString().split(" ");
     return { cmd, args };
 }
+// If we're in a yarn Plug'n'Play environment, then the relative paths being
+// used by the parser server and the various scripts used to communicate
+// therein are not going to work with its virtual file system. Presumably
+// there's a way to fix this but I haven't figured out how yet.
+function checkPnP() {
+    if (process_1.default.versions.pnp) {
+        throw new Error(`
+      @prettier/plugin-ruby does not current work within the yarn Plug'n'Play
+      virtual file system. If you would like to help support the effort to fix
+      this, please see https://github.com/prettier/plugin-ruby/issues/894.
+    `);
+    }
+}
 // Formats and sends a request to the parser server. We use netcat (or something
 // like it) here since Prettier requires the results of `parse` to be
 // synchronous and Node.js does not offer a mechanism for synchronous socket
 // requests.
 function parseSync(parser, source) {
     if (!parserArgs) {
+        checkPnP();
         parserArgs = spawnServer();
     }
     const response = (0, child_process_1.spawnSync)(parserArgs.cmd, parserArgs.args, {

data/dist/ruby/nodes/calls.js

@@ -9,6 +9,10 @@ const utils_1 = require("../../utils");
 const toProc_1 = __importDefault(require("../toProc"));
 const { group, hardline, ifBreak, indent, join, softline } = prettier_1.default;
 const chained = ["call", "method_add_arg", "method_add_block"];
+function hasLeadingComments(node) {
+    var _a;
+    return (_a = node.comments) === null || _a === void 0 ? void 0 : _a.some(({ leading }) => leading);
+}
 const printCall = (path, opts, print) => {
     const node = path.getValue();
     const [receiverNode, , messageNode] = node.body;
@@ -18,26 +22,40 @@ const printCall = (path, opts, print) => {
     // In this case, "call" is returned for the 3rd child node. We don't alter
     // call syntax so if `call` is implicit, we don't print it out.
     const messageDoc = messageNode === "call" ? "" : path.call(print, "body", 2);
+    // Create some arrays that are going to represent each side of our call.
+    let leftSideDoc = [receiverDoc];
+    let rightSideDoc = [operatorDoc, messageDoc];
+    // If there are leading comments on the right side of the call, then it means
+    // we have a structure where there's a receiver and an operator together, then
+    // a comment, then the message, as in:
+    //
+    //     foo.
+    //       # comment
+    //       baz
+    //
+    // In the case we need to group the receiver and the operator together or
+    // we'll end up with a syntax error.
+    const operatorIsTrailing = messageNode !== "call" && hasLeadingComments(messageNode);
+    if (operatorIsTrailing) {
+        leftSideDoc = [receiverDoc, operatorDoc];
+        rightSideDoc = [messageDoc];
+    }
     // For certain left sides of the call nodes, we want to attach directly to
     // the } or end.
     if (utils_1.noIndent.includes(receiverNode.type)) {
-        return [receiverDoc, operatorDoc, messageDoc];
+        return [leftSideDoc, rightSideDoc];
     }
-    // The right side of the call node, as in everything including the operator
-    // and beyond.
-    let rightSideDoc = [
-        receiverNode.comments ? hardline : softline,
-        operatorDoc,
-        messageDoc
-    ];
-    // This is very specialized behavior wherein we group .where.not calls
-    // together because it looks better. For more information, see
-    // https://github.com/prettier/plugin-ruby/issues/862.
     if (receiverNode.type === "call" &&
         receiverNode.body[2] !== "call" &&
         receiverNode.body[2].body === "where" &&
         messageDoc === "not") {
-        rightSideDoc = [operatorDoc, messageDoc];
+        // This is very specialized behavior wherein we group .where.not calls
+        // together because it looks better. For more information, see
+        // https://github.com/prettier/plugin-ruby/issues/862.
+    }
+    else {
+        // Otherwise, we're going to put a line node into the right side doc.
+        rightSideDoc.unshift(receiverNode.comments ? hardline : softline);
     }
     // Get a reference to the parent node so we can check if we're inside a chain
     const parentNode = path.getParentNode();
@@ -46,8 +64,30 @@ const printCall = (path, opts, print) => {
     if (chained.includes(parentNode.type) && !node.comments) {
         parentNode.chain = (node.chain || 0) + 1;
         parentNode.callChain = (node.callChain || 0) + 1;
-        parentNode.breakDoc = (node.breakDoc || [receiverDoc]).concat(rightSideDoc);
         parentNode.firstReceiverType = node.firstReceiverType || receiverNode.type;
+        // Here we're going to determine what doc nodes to send up to the parent
+        // node to represent when we're in the multi-line form.
+        let breakDocLHS;
+        if (node.breakDoc && operatorIsTrailing) {
+            // Here we already have a child node that has passed up its
+            // representation. In this case node.breakDoc represents the receiver
+            // without any lines inserted. With regard to this node, it means it's
+            // everything up until the operator. So we're just going to append the
+            // operator.
+            breakDocLHS = node.breakDoc.concat(operatorDoc);
+        }
+        else if (node.breakDoc) {
+            // Here we don't need a trailing operator, so we're just going to use the
+            // existing node.breakDoc. The operator will be a part of the rightSideDoc
+            // variable.
+            breakDocLHS = node.breakDoc;
+        }
+        else {
+            // Here we're at the bottom of the chain, so there's no representation yet
+            // for the receiver. So we're just going to pass up the left side.
+            breakDocLHS = leftSideDoc;
+        }
+        parentNode.breakDoc = breakDocLHS.concat(rightSideDoc);
     }
     // If we're at the top of a chain, then we're going to print out a nice
     // multi-line layout if this doesn't break into multiple lines.
@@ -55,11 +95,11 @@ const printCall = (path, opts, print) => {
         (node.chain || 0) >= 3 &&
         node.breakDoc) {
         return ifBreak(group(indent(node.breakDoc.concat(rightSideDoc))), [
-            receiverDoc,
+            leftSideDoc,
             group(rightSideDoc)
         ]);
     }
-    return group([receiverDoc, group(indent(rightSideDoc))]);
+    return group([leftSideDoc, group(indent(rightSideDoc))]);
 };
 exports.printCall = printCall;
 const printMethodAddArg = (path, opts, print) => {

data/dist/ruby/nodes/commands.js

@@ -62,8 +62,8 @@ function hasDef(node) {
 //
 // In this case the arguments are aligned to the left side as opposed to being
 // aligned with the `receive` call.
-function skipArgsAlign(path) {
-    return ["to", "not_to"].includes(path.getValue().body[2].body);
+function skipArgsAlign(node) {
+    return ["to", "not_to", "to_not"].includes(node.body[2].body);
 }
 // If there is a ternary argument to a command and it's going to get broken
 // into multiple lines, then we're going to have to use parentheses around the
@@ -110,7 +110,7 @@ const printCommandCall = (path, opts, print) => {
         breakDoc = parts.concat("(", indent([softline, argDocs]), softline, ")");
         parts.push(" ");
     }
-    else if (skipArgsAlign(path)) {
+    else if (skipArgsAlign(node)) {
         parts.push(" ");
         breakDoc = parts.concat(argDocs);
     }

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prettier/plugin-ruby",
-  "version": "2.0.0-rc1",
+  "version": "2.0.0-rc2",
   "description": "prettier plugin for the Ruby programming language",
   "main": "dist/plugin.js",
   "scripts": {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prettier
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre.rc1
+  version: 2.0.0.pre.rc2
 platform: ruby
 authors:
 - Kevin Newton