prettier 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1738251faac58ab78438da2dcf568a86708d1ccb651d7ec593f0e3c3efc5075a
-  data.tar.gz: 91666c89e8846d9a908883339238dfec94816adb14c8949fe9232590e493c48b
+  metadata.gz: 2b3f385a13ce2aae0cef657abc5d33e5d3d2fbfb59edf1fb39193ded2828cf87
+  data.tar.gz: 1049cb733eb60e3221a7df64110f5841f39288f8e91cb589f08cc1c23a0ddfbe
 SHA512:
-  metadata.gz: d7df78d09da53ada78d9d9a0d3421e279bc0f1593aaff7a099ef397deea85f4fdde3a044ef91bb88f8f5d6a4f91d52d303e912e60f84b946c35528c0c6f139e1
-  data.tar.gz: 95e810fa06b71063a010f8e3e3dd3cf7302e2cf1b3573f8da4b7e7fed9288ecaf4d75cbd6429c4b04dbc31728dc879cf1605c8c104fc130bdbfc30583c837e5b
+  metadata.gz: ef14696b55d0dd1a544bba5fd45d88e3ab322ab9d2ae34d89b4b6bf84748ac35100022d5e050ed4ef0e5cf5ad93049c1782243cda27e4bae5b7dc87a2f951614
+  data.tar.gz: 1bedee0f2b091bc7b7b10ceb645d183271dcea847f8b843c79cd6db5ebf078bb94d7d91fd255127f77c71eb9edd185dcfa166ffe9c442f315f64beb9ba57f4ee

data/CHANGELOG.md

@@ -6,6 +6,12 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [1.0.1] - 2020-12-12
+
+### Changed
+
+- [@steobrien], [@kddeisz] - Ensure leading comments in empty array and hash literals do not duplicate.
+
 ## [1.0.0] - 2020-12-11
 
 ### Changed
@@ -951,7 +957,8 @@ would previously result in `array[]`, but now prints properly.
 
 - Initial release 🎉
 
-[unreleased]: https://github.com/prettier/plugin-ruby/compare/v1.0.0...HEAD
+[unreleased]: https://github.com/prettier/plugin-ruby/compare/v1.0.1...HEAD
+[1.0.1]: https://github.com/prettier/plugin-ruby/compare/v1.0.0...v1.0.1
 [1.0.0]: https://github.com/prettier/plugin-ruby/compare/v1.0.0-rc2...v1.0.0
 [1.0.0-rc2]: https://github.com/prettier/plugin-ruby/compare/v1.0.0-rc1...v1.0.0-rc2
 [1.0.0-rc1]: https://github.com/prettier/plugin-ruby/compare/v0.22.0...v1.0.0-rc1

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prettier/plugin-ruby",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "prettier plugin for the Ruby programming language",
   "main": "src/ruby.js",
   "scripts": {

data/src/nodes/arrays.js

@@ -1,7 +1,6 @@
 const {
   concat,
   group,
-  hardline,
   ifBreak,
   indent,
   join,
@@ -9,7 +8,7 @@ const {
   softline
 } = require("../prettier");
 
-const { getTrailingComma } = require("../utils");
+const { getTrailingComma, printEmptyCollection } = require("../utils");
 
 // Checks that every argument within this args node is a string_literal node
 // that has no spaces or interpolations. This means we're dealing with an array
@@ -93,24 +92,6 @@ function printSpecialArray(start) {
   };
 }
 
-function printEmptyArrayWithComments(path, opts) {
-  const arrayNode = path.getValue();
-
-  const printComment = (commentPath, index) => {
-    arrayNode.comments[index].printed = true;
-    return opts.printer.printComment(commentPath);
-  };
-
-  return concat([
-    "[",
-    indent(
-      concat([hardline, join(hardline, path.map(printComment, "comments"))])
-    ),
-    line,
-    "]"
-  ]);
-}
-
 // An array node is any literal array in Ruby. This includes all of the special
 // array literals as well as regular arrays. If it is a special array literal
 // then it will have one child that represents the special array, otherwise it
@@ -122,7 +103,7 @@ function printArray(path, opts, print) {
   // If there is no inner arguments node, then we're dealing with an empty
   // array, so we can go ahead and return.
   if (args === null) {
-    return array.comments ? printEmptyArrayWithComments(path, opts) : "[]";
+    return printEmptyCollection(path, opts, "[", "]");
   }
 
   // If we have an array that contains only simple string literals with no

data/src/nodes/hashes.js

@@ -1,14 +1,11 @@
-const {
-  concat,
-  group,
-  hardline,
-  ifBreak,
-  indent,
-  join,
-  line
-} = require("../prettier");
+const { concat, group, ifBreak, indent, join, line } = require("../prettier");
 
-const { getTrailingComma, prefix, skipAssignIndent } = require("../utils");
+const {
+  getTrailingComma,
+  prefix,
+  printEmptyCollection,
+  skipAssignIndent
+} = require("../utils");
 
 // When attempting to convert a hash rocket into a hash label, you need to take
 // care because only certain patterns are allowed. Ruby source says that they
@@ -96,26 +93,6 @@ function printHashContents(path, opts, print) {
   return join(concat([",", line]), path.map(print, "body"));
 }
 
-function printEmptyHashWithComments(path, opts) {
-  const hashNode = path.getValue();
-
-  const printComment = (commentPath, index) => {
-    hashNode.comments[index].printed = true;
-    return opts.printer.printComment(commentPath);
-  };
-
-  return group(
-    concat([
-      "{",
-      indent(
-        concat([hardline, join(hardline, path.map(printComment, "comments"))])
-      ),
-      line,
-      "}"
-    ])
-  );
-}
-
 function printHash(path, opts, print) {
   const hashNode = path.getValue();
 
@@ -123,7 +100,7 @@ function printHash(path, opts, print) {
   // missing, then it means we're dealing with an empty hash, so we can just
   // exit here and print.
   if (hashNode.body[0] === null) {
-    return hashNode.comments ? printEmptyHashWithComments(path, opts) : "{}";
+    return printEmptyCollection(path, opts, "{", "}");
   }
 
   return group(

data/src/nodes/statements.js

@@ -98,8 +98,8 @@ module.exports = {
       stmts[0].comments
     ) {
       const comments = path.map(
-        (commentPath, index) => {
-          stmts[0].comments[index].printed = true;
+        (commentPath) => {
+          commentPath.getValue().printed = true;
           return opts.printer.printComment(commentPath);
         },
         "body",

data/src/utils.js

@@ -1,6 +1,7 @@
 const { concat } = require("./prettier");
 const isEmptyStmts = require("./utils/isEmptyStmts");
 const literalLineNoBreak = require("./utils/literalLineNoBreak");
+const printEmptyCollection = require("./utils/printEmptyCollection");
 
 // If the node is a type of assignment or if the node is a paren and nested
 // inside that paren is a node that is a type of assignment.
@@ -89,5 +90,6 @@ module.exports = {
   makeCall,
   noIndent,
   prefix,
+  printEmptyCollection,
   skipAssignIndent
 };

data/src/utils/printEmptyCollection.js

@@ -0,0 +1,42 @@
+const { concat, group, hardline, indent, join, line } = require("../prettier");
+
+// Empty collections are array or hash literals that do not contain any
+// contents. They can, however, have comments inside the body. You can solve
+// this by having a child node inside the array that gets the comments attached
+// to it, but that requires modifying the parser. Instead, we can just manually
+// print out the non-leading comments here.
+function printEmptyCollection(path, opts, startToken, endToken) {
+  const node = path.getValue();
+
+  // If there are no comments or only leading comments, then we can just print
+  // out the start and end token and be done, as there are no comments inside
+  // the body of this node.
+  if (!node.comments || !node.comments.some((comment) => !comment.leading)) {
+    return `${startToken}${endToken}`;
+  }
+
+  const comments = [];
+
+  // For each comment, go through its path and print it out manually.
+  const printComment = (commentPath) => {
+    const comment = commentPath.getValue();
+
+    if (!comment.leading) {
+      comment.printed = true;
+      comments.push(opts.printer.printComment(commentPath));
+    }
+  };
+
+  path.each(printComment, "comments");
+
+  return group(
+    concat([
+      startToken,
+      indent(concat([hardline, join(hardline, comments)])),
+      line,
+      endToken
+    ])
+  );
+}
+
+module.exports = printEmptyCollection;

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prettier
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Kevin Deisz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-11 00:00:00.000000000 Z
+date: 2020-12-12 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -73,6 +73,7 @@ files:
 - src/utils/inlineEnsureParens.js
 - src/utils/isEmptyStmts.js
 - src/utils/literalLineNoBreak.js
+- src/utils/printEmptyCollection.js
 homepage: https://github.com/prettier/plugin-ruby#readme
 licenses:
 - MIT