prettier 0.17.0 → 0.18.0

data/CONTRIBUTING.md

@@ -107,7 +107,7 @@ Once every node has been printed like the `binary` node above, the `print` node
 
 ### Doc to text
 
-At this point, this is where `prettier`'s printer takes over. Because the remainder of the process is language-agnostic and `prettier` knows how to handle its own `Doc` representation, the Ruby plugin now longer has a job to do. `prettier` will walk its own `Doc` nodes and print them out according to the rules established by the structure.
+At this point, this is where `prettier`'s printer takes over. Because the remainder of the process is language-agnostic and `prettier` knows how to handle its own `Doc` representation, the Ruby plugin no longer has a job to do. `prettier` will walk its own `Doc` nodes and print them out according to the rules established by the structure.
 
 ## FAQ
 

data/README.md

@@ -8,8 +8,8 @@
   <a href="https://gitter.im/jlongster/prettier">
     <img alt="Gitter" src="https://img.shields.io/gitter/room/jlongster/prettier.svg?style=flat-square">
   </a>
-  <a href="https://travis-ci.org/prettier/plugin-ruby">
-    <img alt="Travis" src="https://img.shields.io/travis/prettier/plugin-ruby/master.svg?style=flat-square">
+  <a href="https://github.com/prettier/plugin-ruby/actions">
+    <img alt="GitHub Actions" src="https://img.shields.io/github/workflow/status/prettier/plugin-ruby/Main?style=flat-square">
   </a>
   <a href="https://www.npmjs.com/package/@prettier/plugin-ruby">
     <img alt="NPM Version" src="https://img.shields.io/npm/v/@prettier/plugin-ruby.svg?style=flat-square">
@@ -120,16 +120,16 @@ The `prettier` executable is now installed and ready for use:
 
 Below are the options (from [`src/ruby.js`](src/ruby.js)) that `@prettier/plugin-ruby` currently supports:
 
-| Name                 | Default | Description                                                                                                   |
-| -------------------- | :-----: | ------------------------------------------------------------------------------------------------------------- |
-| `printWidth`         |  `80`   | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#print-width)).              |
-| `requirePragma`      | `false` | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#require-pragma)).           |
-| `tabWidth`           |   `2`   | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#tab-width)).                |
-| `addTrailingCommas`  | `false` | Adds a trailing comma to array literals, hash literals, and method calls.                                     |
-| `inlineConditionals` | `true`  | When it fits on one line, allows if and unless statements to use the modifier form.                           |
-| `inlineLoops`        | `true`  | When it fits on one line, allows while and until statements to use the modifier form.                         |
-| `preferHashLabels`   | `true`  | When possible, uses the shortened hash key syntax, as opposed to hash rockets.                                |
-| `preferSingleQuotes` | `true`  | When double quotes are not necessary for interpolation, prefers the use of single quotes for string literals. |
+| API Option           | CLI Option               | Default | Description                                                                                                   |
+| -------------------- | ------------------------ | :-----: | ------------------------------------------------------------------------------------------------------------- |
+| `printWidth`         | `--print-width`          |  `80`   | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#print-width)).              |
+| `requirePragma`      | `--require-pragma`       | `false` | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#require-pragma)).           |
+| `tabWidth`           | `--tab-width`            |   `2`   | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#tab-width)).                |
+| `addTrailingCommas`  | `--add-trailing-commas`  | `false` | Adds a trailing comma to array literals, hash literals, and method calls.                                     |
+| `inlineConditionals` | `--inline-conditionals`  | `true`  | When it fits on one line, allows if and unless statements to use the modifier form.                           |
+| `inlineLoops`        | `--inline-loops`         | `true`  | When it fits on one line, allows while and until statements to use the modifier form.                         |
+| `preferHashLabels`   | `--prefer-hash-labels`   | `true`  | When possible, uses the shortened hash key syntax, as opposed to hash rockets.                                |
+| `preferSingleQuotes` | `--prefer-single-quotes` | `true`  | When double quotes are not necessary for interpolation, prefers the use of single quotes for string literals. |
 
 Any of these can be added to your existing [prettier configuration
 file](https://prettier.io/docs/en/configuration.html). For example:
@@ -199,6 +199,15 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     <td align="center"><a href="http://vesalaakso.com"><img src="https://avatars2.githubusercontent.com/u/482561?v=4" width="100px;" alt=""/><br /><sub><b>Vesa Laakso</b></sub></a><br /><a href="https://github.com/prettier/plugin-ruby/commits?author=valscion" title="Documentation">📖</a></td>
     <td align="center"><a href="https://github.com/jrdioko"><img src="https://avatars0.githubusercontent.com/u/405288?v=4" width="100px;" alt=""/><br /><sub><b>jrdioko</b></sub></a><br /><a href="https://github.com/prettier/plugin-ruby/issues?q=author%3Ajrdioko" title="Bug reports">🐛</a></td>
     <td align="center"><a href="http://gin0606.hatenablog.com"><img src="https://avatars2.githubusercontent.com/u/795891?v=4" width="100px;" alt=""/><br /><sub><b>gin0606</b></sub></a><br /><a href="https://github.com/prettier/plugin-ruby/issues?q=author%3Agin0606" title="Bug reports">🐛</a> <a href="https://github.com/prettier/plugin-ruby/commits?author=gin0606" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/tobyndockerill"><img src="https://avatars1.githubusercontent.com/u/5688326?v=4" width="100px;" alt=""/><br /><sub><b>Tobyn</b></sub></a><br /><a href="https://github.com/prettier/plugin-ruby/commits?author=tobyndockerill" title="Code">💻</a></td>
+    <td align="center"><a href="http://ianks.com"><img src="https://avatars0.githubusercontent.com/u/3303032?v=4" width="100px;" alt=""/><br /><sub><b>Ian Ker-Seymer</b></sub></a><br /><a href="https://github.com/prettier/plugin-ruby/commits?author=ianks" title="Code">💻</a></td>
+    <td align="center"><a href="https://huangzhimin.com"><img src="https://avatars2.githubusercontent.com/u/66836?v=4" width="100px;" alt=""/><br /><sub><b>Richard Huang</b></sub></a><br /><a href="https://github.com/prettier/plugin-ruby/commits?author=flyerhzm" title="Code">💻</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://github.com/pje"><img src="https://avatars1.githubusercontent.com/u/319655?v=4" width="100px;" alt=""/><br /><sub><b>Patrick Ellis</b></sub></a><br /><a href="https://github.com/prettier/plugin-ruby/issues?q=author%3Apje" title="Bug reports">🐛</a></td>
+    <td align="center"><a href="https://www.piesync.com/"><img src="https://avatars0.githubusercontent.com/u/161271?v=4" width="100px;" alt=""/><br /><sub><b>Peter De Berdt</b></sub></a><br /><a href="https://github.com/prettier/plugin-ruby/issues?q=author%3Amasqita" title="Bug reports">🐛</a></td>
+    <td align="center"><a href="https://github.com/hafley66"><img src="https://avatars0.githubusercontent.com/u/6750483?v=4" width="100px;" alt=""/><br /><sub><b>Chris Hafley</b></sub></a><br /><a href="https://github.com/prettier/plugin-ruby/issues?q=author%3Ahafley66" title="Bug reports">🐛</a></td>
+    <td align="center"><a href="http://fruetel.de"><img src="https://avatars1.githubusercontent.com/u/8015212?v=4" width="100px;" alt=""/><br /><sub><b>Thomas Frütel</b></sub></a><br /><a href="https://github.com/prettier/plugin-ruby/issues?q=author%3AFruetel" title="Bug reports">🐛</a></td>
   </tr>
 </table>
 

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prettier/plugin-ruby",
-  "version": "0.17.0",
+  "version": "0.18.0",
   "description": "prettier plugin for the Ruby programming language",
   "main": "src/ruby.js",
   "scripts": {
@@ -22,12 +22,12 @@
     "prettier": ">=1.10"
   },
   "devDependencies": {
-    "all-contributors-cli": "^6.1.2",
-    "eslint": "^6.0.1",
+    "all-contributors-cli": "^6.12.0",
+    "eslint": "^6.8.0",
     "eslint-config-airbnb-base": "^14.0.0",
-    "eslint-config-prettier": "^6.0.0",
-    "eslint-plugin-import": "^2.16.0",
-    "jest": "^24.0.0"
+    "eslint-config-prettier": "^6.9.0",
+    "eslint-plugin-import": "^2.20.0",
+    "jest": "^25.1.0"
   },
   "jest": {
     "setupFilesAfterEnv": [

data/src/haml/nodes/silentScript.js

@@ -1,5 +1,21 @@
 const { concat, group, hardline, indent, join } = require("../../prettier");
 
+const findKeywordIndices = (children, keywords) => {
+  const indices = [];
+
+  children.forEach((child, index) => {
+    if (child.type !== "silent_script") {
+      return;
+    }
+
+    if (keywords.includes(child.value.keyword)) {
+      indices.push(index);
+    }
+  });
+
+  return indices;
+};
+
 // http://haml.info/docs/yardoc/file.REFERENCE.html#running-ruby--
 const silentScript = (path, opts, print) => {
   const { children, value } = path.getValue();
@@ -9,13 +25,26 @@ const silentScript = (path, opts, print) => {
     const scripts = path.map(print, "children");
 
     if (value.keyword === "case") {
+      const keywordIndices = findKeywordIndices(children, ["when", "else"]);
+
+      parts.push(
+        concat(
+          scripts.map((script, index) => {
+            const concated = concat([hardline, script]);
+
+            return keywordIndices.includes(index) ? concated : indent(concated);
+          })
+        )
+      );
+    } else if (["if", "unless"].includes(value.keyword)) {
+      const keywordIndices = findKeywordIndices(children, ["elsif", "else"]);
+
       parts.push(
-        join(
-          "",
+        concat(
           scripts.map((script, index) => {
             const concated = concat([hardline, script]);
 
-            return index % 2 === 0 ? concated : indent(concated);
+            return keywordIndices.includes(index) ? concated : indent(concated);
           })
         )
       );

data/src/haml/nodes/tag.js

@@ -71,7 +71,7 @@ const getHeader = (value, opts) => {
   }
 
   if (attributes.class) {
-    parts.push(`.${attributes.class.replace(" ", ".")}`);
+    parts.push(`.${attributes.class.replace(/ /g, ".")}`);
   }
 
   if (attributes.id) {

data/src/haml/parse.rb

@@ -1,6 +1,8 @@
 #!/usr/bin/env ruby
 
 require 'json'
+
+require 'bundler/setup' if ENV['CI']
 require 'haml'
 
 class Haml::Parser::ParseNode

data/src/nodes/args.js

@@ -17,6 +17,13 @@ module.exports = {
       return "";
     }
 
+    // Here we can skip the entire rest of the method by just checking if it's
+    // an args_forward node, as we're guaranteed that there are no other arg
+    // nodes.
+    if (path.getValue().body[0].type === "args_forward") {
+      return "(...)";
+    }
+
     const { addTrailingCommas } = opts;
     const { args, heredocs } = makeArgs(path, opts, print, 0);
 

data/src/nodes/blocks.js

@@ -8,7 +8,7 @@ const {
   removeLines,
   softline
 } = require("../prettier");
-const { empty, first, hasAncestor } = require("../utils");
+const { empty, hasAncestor } = require("../utils");
 
 const printBlock = (path, opts, print) => {
   const [variables, statements] = path.getValue().body;
@@ -76,6 +76,5 @@ module.exports = {
   },
   brace_block: printBlock,
   do_block: printBlock,
-  excessed_comma: empty,
-  number_arg: first
+  excessed_comma: empty
 };

data/src/nodes/calls.js

@@ -23,7 +23,7 @@ module.exports = {
     }
 
     return group(
-      concat([receiver, indent(concat([softline, operator, name]))])
+      concat([receiver, group(indent(concat([softline, operator, name])))])
     );
   },
   fcall: concatBody,

data/src/nodes/commands.js

@@ -5,7 +5,7 @@ const hasDef = node =>
   node.body[1].type === "args_add_block" &&
   node.body[1].body[0].type === "args" &&
   node.body[1].body[0].body[0] &&
-  node.body[1].body[0].body[0].type === "def";
+  ["def", "defs"].includes(node.body[1].body[0].body[0].type);
 
 // Very special handling case for rspec matchers. In general with rspec matchers
 // you expect to see something like:

data/src/nodes/conditionals.js

@@ -75,20 +75,17 @@ const printTernary = (path, _opts, print) => {
   );
 };
 
-const makeSingleBlockForm = (keyword, path, print) =>
-  concat([
+// Prints an `if_mod` or `unless_mod` node. Because it was previously in the
+// modifier form, we're guaranteed to not have an additional node, so we can
+// just work with the predicate and the body.
+const printSingle = keyword => (path, { inlineConditionals }, print) => {
+  const multiline = concat([
     `${keyword} `,
     align(keyword.length + 1, path.call(print, "body", 0)),
     indent(concat([softline, path.call(print, "body", 1)])),
     concat([softline, "end"])
   ]);
 
-// Prints an `if_mod` or `unless_mod` node. Because it was previously in the
-// modifier form, we're guaranteed to not have an additional node, so we can
-// just work with the predicate and the body.
-const printSingle = keyword => (path, { inlineConditionals }, print) => {
-  const multiline = makeSingleBlockForm(keyword, path, print);
-
   const [_predicate, stmts] = path.getValue().body;
   const hasComments =
     stmts.type === "stmts" && stmts.body.some(stmt => stmt.type === "@comment");
@@ -230,7 +227,12 @@ const printConditional = keyword => (path, { inlineConditionals }, print) => {
   // know for sure that it doesn't impact the body of the conditional, so we
   // have to default to the block form.
   if (containsAssignment(predicate)) {
-    return makeSingleBlockForm(keyword, path, print);
+    return concat([
+      `${keyword} `,
+      align(keyword.length + 1, path.call(print, "body", 0)),
+      indent(concat([hardline, path.call(print, "body", 1)])),
+      concat([hardline, "end"])
+    ]);
   }
 
   return printSingle(keyword)(path, { inlineConditionals }, print);

data/src/nodes/ints.js

@@ -11,7 +11,7 @@ module.exports = {
     // If the number is a base 10 number, is sufficiently large, and is not
     // already formatted with underscores, then add them in in between the
     // numbers every three characters starting from the right.
-    if (!body.startsWith("0") && body.length >= 4 && !body.includes("_")) {
+    if (!body.startsWith("0") && body.length >= 5 && !body.includes("_")) {
       return `  ${body}`
         .slice((body.length + 2) % 3)
         .match(/.{3}/g)

data/src/nodes/loops.js

@@ -10,6 +10,22 @@ const {
 const { containsAssignment } = require("../utils");
 
 const printLoop = (keyword, modifier) => (path, { inlineLoops }, print) => {
+  const [_predicate, statements] = path.getValue().body;
+
+  // If the only statement inside this while loop is a void statement, then we
+  // can shorten to just displaying the predicate and then a semicolon.
+  if (statements.body.length === 1 && statements.body[0].type === "void_stmt") {
+    return group(
+      concat([
+        keyword,
+        " ",
+        path.call(print, "body", 0),
+        ifBreak(softline, "; "),
+        "end"
+      ])
+    );
+  }
+
   let inlineParts = [
     path.call(print, "body", 1),
     ` ${keyword} `,

data/src/nodes/params.js

@@ -1,4 +1,5 @@
 const { concat, group, join, line } = require("../prettier");
+const { literal } = require("../utils");
 
 const printGenericRestParam = symbol => (path, opts, print) =>
   path.getValue().body[0]
@@ -53,7 +54,7 @@ const printParams = (path, opts, print) => {
   }
 
   if (kwargRest) {
-    parts.push(path.call(print, "body", 5));
+    parts.push(kwargRest === "nil" ? "**nil" : path.call(print, "body", 5));
   }
 
   if (block) {
@@ -79,6 +80,7 @@ const paramError = () => {
 };
 
 module.exports = {
+  args_forward: literal("..."),
   kwrest_param: printGenericRestParam("**"),
   rest_param: printGenericRestParam("*"),
   params: printParams,

data/src/nodes/strings.js

@@ -7,8 +7,8 @@ const {
   softline,
   join
 } = require("../prettier");
+
 const { concatBody, empty, makeList, prefix, surround } = require("../utils");
-const escapePattern = require("../escapePattern");
 
 // If there is some part of this string that matches an escape sequence or that
 // contains the interpolation pattern ("#{"), then we are locked into whichever
@@ -19,7 +19,7 @@ const isQuoteLocked = string =>
   string.body.some(
     part =>
       part.type === "@tstring_content" &&
-      (escapePattern.test(part.body) || part.body.includes("#{"))
+      (part.body.includes("#{") || part.body.includes("\\"))
   );
 
 // A string is considered to be able to use single quotes if it contains only
@@ -29,17 +29,9 @@ const isSingleQuotable = string =>
     part => part.type === "@tstring_content" && !part.body.includes("'")
   );
 
-const getStringQuote = (string, preferSingleQuotes) => {
-  if (isQuoteLocked(string)) {
-    return string.quote;
-  }
-
-  return preferSingleQuotes && isSingleQuotable(string) ? "'" : '"';
-};
-
 const quotePattern = new RegExp("\\\\([\\s\\S])|(['\"])", "g");
 
-const makeString = (content, enclosingQuote, originalQuote) => {
+const normalizeQuotes = (content, enclosingQuote, originalQuote) => {
   const replaceOther = ["'", '"'].includes(originalQuote);
   const otherQuote = enclosingQuote === '"' ? "'" : '"';
 
@@ -62,51 +54,24 @@ const makeString = (content, enclosingQuote, originalQuote) => {
   });
 };
 
-// The `parts` argument that comes into this function is an array of either
-// printed embedded expressions or plain strings (that themselves can contain
-// newlines). What we want to return is an array where each element represents a
-// line in the original text. So we end up tracking every line as we go and
-// pushing onto a `currentLine` variable, then when we hit a new line we push
-// the current line onto the `lines` variable until we've used up every part.
-const makeHeredocLines = parts => {
-  let lines = [];
-  let currentLine = [];
-
-  parts.forEach(part => {
-    if (part.type === "group" || !part.includes("\n")) {
-      // In this case we've either hit an embedded expression or the piece of
-      // the current line that we're looking at is in the middle of two of them,
-      // so we just push onto the current line and continue on.
-      currentLine.push(part);
-      return;
-    }
-
-    let splits = part.split("\n");
-    if (splits[splits.length - 1] === "") {
-      // If a line ends with a newline, then we end up with an empty string at
-      // the end of the splits, we just pop it off here since we'll handle the
-      // newlines later.
-      splits = splits.slice(0, -1);
-    }
-
-    if (currentLine.length > 0) {
-      lines.push(concat(currentLine.concat(splits[0])));
-      currentLine = [];
-    } else {
-      lines.push(splits[0]);
-    }
+const quotePairs = {
+  "(": ")",
+  "[": "]",
+  "{": "}",
+  "<": ">"
+};
 
-    if (splits.length > 1) {
-      lines = lines.concat(splits.slice(1, -1));
-      currentLine.push(splits[splits.length - 1]);
-    }
-  });
+const getClosingQuote = quote => {
+  if (!quote.startsWith("%")) {
+    return quote;
+  }
 
-  if (currentLine.length > 0) {
-    lines = lines.concat(currentLine);
+  const boundary = /%q?(.)/.exec(quote)[1];
+  if (boundary in quotePairs) {
+    return quotePairs[boundary];
   }
 
-  return lines;
+  return boundary;
 };
 
 module.exports = {
@@ -121,21 +86,24 @@ module.exports = {
     return body.length === 2 ? concat([quote, body.slice(1), quote]) : body;
   },
   dyna_symbol: (path, opts, print) => {
-    const { quote } = path.getValue().body[0];
+    const { quote } = path.getValue();
 
     return concat([":", quote, concat(path.call(print, "body", 0)), quote]);
   },
   heredoc: (path, opts, print) => {
-    const { beging, ending } = path.getValue();
-    const lines = makeHeredocLines(path.map(print, "body"));
-
-    return concat([
-      beging,
-      literalline,
-      join(literalline, lines),
-      literalline,
-      ending
-    ]);
+    const { beging, body, ending } = path.getValue();
+
+    const parts = body.map((part, index) => {
+      if (part.type !== "@tstring_content") {
+        // In this case, the part of the string is an embedded expression
+        return path.call(print, "body", index);
+      }
+
+      // In this case, the part of the string is just regular string content
+      return join(literalline, part.body.split("\n"));
+    });
+
+    return concat([beging, literalline, concat(parts), ending]);
   },
   string: makeList,
   string_concat: (path, opts, print) =>
@@ -162,7 +130,8 @@ module.exports = {
     );
   },
   string_literal: (path, { preferSingleQuotes }, print) => {
-    const string = path.getValue().body[0];
+    const stringLiteral = path.getValue();
+    const string = stringLiteral.body[0];
 
     // If this string is actually a heredoc, bail out and return to the print
     // function for heredocs
@@ -176,20 +145,28 @@ module.exports = {
       return preferSingleQuotes ? "''" : '""';
     }
 
-    const quote = getStringQuote(string, preferSingleQuotes);
-    const parts = [];
+    // Determine the quote that should enclose the new string
+    let quote;
+    if (isQuoteLocked(string)) {
+      ({ quote } = stringLiteral);
+    } else {
+      quote = preferSingleQuotes && isSingleQuotable(string) ? "'" : '"';
+    }
 
-    string.body.forEach((part, index) => {
-      if (part.type === "@tstring_content") {
-        // In this case, the part of the string is just regular string content
-        parts.push(makeString(part.body, quote, string.quote));
-      } else {
+    const parts = string.body.map((part, index) => {
+      if (part.type !== "@tstring_content") {
         // In this case, the part of the string is an embedded expression
-        parts.push(path.call(print, "body", 0, "body", index));
+        return path.call(print, "body", 0, "body", index);
       }
+
+      // In this case, the part of the string is just regular string content
+      return join(
+        literalline,
+        normalizeQuotes(part.body, quote, stringLiteral.quote).split("\n")
+      );
     });
 
-    return concat([quote].concat(parts).concat([quote]));
+    return concat([quote].concat(parts).concat(getClosingQuote(quote)));
   },
   symbol: prefix(":"),
   symbol_literal: concatBody,