prettier 0.22.0 → 1.1.0

data/src/printer.js

@@ -20,6 +20,18 @@ function printNode(path, opts, print) {
   throw new Error(`Unsupported node encountered: ${type}\n${ast}`);
 }
 
+// This is an escape-hatch to ignore nodes in the tree. If you have a comment
+// that includes this pattern, then the entire node will be ignored and just the
+// original source will be printed out.
+function hasPrettierIgnore(path) {
+  const node = path.getValue();
+
+  return (
+    node.comments &&
+    node.comments.some((comment) => comment.value.includes("prettier-ignore"))
+  );
+}
+
 const noComments = [
   "args",
   "args_add_block",
@@ -40,8 +52,10 @@ function canAttachComment(node) {
 // where it needs to attach the comments.
 function getCommentChildNodes(node) {
   switch (node.type) {
+    case "heredoc":
+      return [node.beging];
     case "rescue":
-      return node.body[0].concat(node.body.slice(1));
+      return [].concat(node.body[0]).concat(node.body.slice(1));
     case "aryptn":
       return [node.body[0]]
         .concat(node.body[1])
@@ -81,6 +95,7 @@ function isBlockComment(comment) {
 module.exports = {
   embed,
   print: printNode,
+  hasPrettierIgnore,
   canAttachComment,
   getCommentChildNodes,
   printComment,

data/src/ruby.js

@@ -76,44 +76,37 @@ module.exports = {
     ruby: printer
   },
   options: {
-    addTrailingCommas: {
+    rubyArrayLiteral: {
       type: "boolean",
-      category: "Global",
-      default: false,
-      description:
-        "Adds a trailing comma to array literals, hash literals, and method calls."
-    },
-    inlineConditionals: {
-      type: "boolean",
-      category: "Global",
+      category: "Ruby",
       default: true,
       description:
-        "When it fits on one line, allows if and unless statements to use the modifier form."
+        "When possible, favor the use of string and symbol array literals."
     },
-    inlineLoops: {
+    rubyHashLabel: {
       type: "boolean",
-      category: "Global",
+      category: "Ruby",
       default: true,
       description:
-        "When it fits on one line, allows while and until statements to use the modifier form."
+        "When possible, uses the shortened hash key syntax, as opposed to hash rockets."
     },
-    preferHashLabels: {
+    rubyModifier: {
       type: "boolean",
-      category: "Global",
+      category: "Ruby",
       default: true,
       description:
-        "When possible, uses the shortened hash key syntax, as opposed to hash rockets."
+        "When it fits on one line, allows if, unless, while, and until statements to use the modifier form."
     },
-    preferSingleQuotes: {
+    rubySingleQuote: {
       type: "boolean",
-      category: "Global",
+      category: "Ruby",
       default: true,
       description:
         "When double quotes are not necessary for interpolation, prefers the use of single quotes for string literals."
     },
-    toProcTransform: {
+    rubyToProc: {
       type: "boolean",
-      category: "Global",
+      category: "Ruby",
       default: false,
       description:
         "When possible, convert blocks to the more concise Symbol#to_proc syntax."
@@ -121,6 +114,7 @@ module.exports = {
   },
   defaultOptions: {
     printWidth: 80,
-    tabWidth: 2
+    tabWidth: 2,
+    trailingComma: "none"
   }
 };

data/src/toProc.js

@@ -11,8 +11,8 @@ const isCall = (node) => ["::", "."].includes(node) || node.type === "@period";
 //     [1, 2, 3].map(&:to_s)
 //
 // This works with `do` blocks as well.
-const toProc = (path, opts, node) => {
-  if (!node || !opts.toProcTransform) {
+const toProc = (path, node) => {
+  if (!node) {
     return null;
   }
 

data/src/utils.js

@@ -1,8 +1,7 @@
 const { concat } = require("./prettier");
 const isEmptyStmts = require("./utils/isEmptyStmts");
 const literalLineNoBreak = require("./utils/literalLineNoBreak");
-
-const concatBody = (path, opts, print) => concat(path.map(print, "body"));
+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.
@@ -31,6 +30,8 @@ const empty = () => "";
 
 const first = (path, opts, print) => path.call(print, "body", 0);
 
+const getTrailingComma = (opts) => ["all", "es5"].includes(opts.trailingComma);
+
 const hasAncestor = (path, types) => {
   let parent = 0;
   let parentNode = path.getParentNode();
@@ -59,6 +60,15 @@ const makeCall = (path, opts, print) => {
   return operation === "::" ? "." : path.call(print, "body", 1);
 };
 
+const noIndent = [
+  "array",
+  "hash",
+  "heredoc",
+  "if",
+  "method_add_block",
+  "xstring_literal"
+];
+
 const prefix = (value) => (path, opts, print) =>
   concat([value, path.call(print, "body", 0)]);
 
@@ -68,16 +78,18 @@ const skipAssignIndent = (node) =>
   (node.type === "call" && skipAssignIndent(node.body[0]));
 
 module.exports = {
-  concatBody,
   containsAssignment,
   docLength,
   empty,
   first,
+  getTrailingComma,
   hasAncestor,
   isEmptyStmts,
   literal,
   literalLineNoBreak,
   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,57 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: prettier
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Kevin Deisz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-08 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.13'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
+date: 2020-12-20 00:00:00.000000000 Z
+dependencies: []
 description:
 email:
 executables:
@@ -115,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
@@ -134,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: prettier plugin for the Ruby programming language