prettier 1.1.0 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0110d43bf561f7af177d93dce16dd6c8802bff3eb5c6603f6b72460903186b43
-  data.tar.gz: 48dd261628c7127b3baca0c6934c21993b68831c6d545494967642f5783e3d16
+  metadata.gz: 3c6028bdf8198f8cfdd43bdb8d8b577e7a3bae5aaa108af45e0ee065d0b373b3
+  data.tar.gz: 90847afd8a74ba465b5a1bcc3dcfdc146ce57c01df77f1e3fa8c04a8b254c870
 SHA512:
-  metadata.gz: 2caa7e2cb715c7a3c1124210b1a2efa064425ef4b2075abd84b7092e28eae67c66fc1aabf93cd6c5493b86c5c735fe9965c9f0f347be4b57f5690f74690d79b4
-  data.tar.gz: 16f4abe1b2ca8099660cd22a541bac6a220f661db879bf9742e85645abfe0cbf36146872c6dfe33af30bc5c8b303144720abe5233d4a1748390a7ff587e8c005
+  metadata.gz: d99e6fefc109919be2317805e2462c0f38d2cfc7b005df3b200ea9b29ff2ac6f4438617580df94ae58c95a0df21717d87025b9ed6301e35c62fd1b84be63f321
+  data.tar.gz: 97353a101ef9256d63035e8838c32435816a84f735dc9aaf40a6f62b69e699249acbb2cc51ea4075802f848368712fca11ba54d8b5203392050199b1cc1f5f13

data/CHANGELOG.md

@@ -6,6 +6,55 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [1.2.4] - 2021-01-03
+
+### Added
+
+- [@andyw8] - Explain usage with Rubocop, as well as shipping a rubocop.yml config.
+
+### Changed
+
+- [@kddeisz] - Reduce JSON size passing from Ruby process to node process by changing `char_start` -> `sc`, `char_end` -> `ec`, `start` -> `sl`, `end` -> `el`.
+- [@kddeisz] - Up the max buffer size between the Ruby and node processes to 15K.
+
+## [1.2.3] - 2021-01-02
+
+### Changed
+
+- [@lukyth], [@kddeisz] - Ensure if a ternary breaks into an `if..else..end` within a `command_call` node that parentheses are added.
+- [@AlanFoster], [@kddeisz] - Ensure you consume the optional `do` keyword on `while` and `until` loops so that it doesn't confuse the parser.
+- [@AlanFoster], [@kddeisz] - Ensure key-value pairs split on line when the key has a comment attached within a hash.
+- [@AlanFoster], [@kddeisz] - Fix for `for` loops that have multiple index variables.
+- [@AlanFoster], [@kddeisz] - Fix parsing very large files by reducing the size of the JSON output from the parser.
+- [@AlanFoster], [@kddeisz] - Ensure you don't skip parentheses if you're returning a value with the `not` unary operator.
+
+## [1.2.2] - 2021-01-01
+
+### Changed
+
+- [@nathan-beam] - Gem does not work with CMD/Powershell.
+- [@blampe], [@kddeisz] - Comments inside keyword parameters in method declarations are not printed.
+- [@blampe], [@kddeisz] - `command_call` nodes with unary operators incorrectly parse their operator.
+- [@blampe], [@kddeisz] - Returning multiple values where the first has parentheses was incorrectly removing the remaining values.
+- [@johncsnyder], [@kddeisz] - Call chains whose left-most receiver is a no-indent expression should not indent their entire chain.
+
+## [1.2.1] - 2020-12-27
+
+### Changed
+
+- [@kddeisz] - Handle single-line method definitions with parameters.
+- [@kddeisz] - Handle hash and array patterns nested within find patterns.
+- [@kddeisz] - Handle rightward assignment.
+- [@kddeisz] - Handle find patterns with named boundaries.
+- [@kddeisz] - Handle rightward assignment in conditionals.
+
+## [1.2.0] - 2020-12-26
+
+### Added
+
+- [@kddeisz] - Support for the `fndptn` node for Ruby 3.0 pattern matching.
+- [@kddeisz] - Support for Ruby 3.0+ single-line method definitions.
+
 ## [1.1.0] - 2020-12-20
 
 ### Added
@@ -971,7 +1020,11 @@ would previously result in `array[]`, but now prints properly.
 
 - Initial release 🎉
 
-[unreleased]: https://github.com/prettier/plugin-ruby/compare/v1.1.0...HEAD
+[unreleased]: https://github.com/prettier/plugin-ruby/compare/v1.2.3...HEAD
+[1.2.3]: https://github.com/prettier/plugin-ruby/compare/v1.2.2...v1.2.3
+[1.2.2]: https://github.com/prettier/plugin-ruby/compare/v1.2.1...v1.2.2
+[1.2.1]: https://github.com/prettier/plugin-ruby/compare/v1.2.0...v1.2.1
+[1.2.0]: https://github.com/prettier/plugin-ruby/compare/v1.1.0...v1.2.0
 [1.1.0]: https://github.com/prettier/plugin-ruby/compare/v1.0.1...v1.1.0
 [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
@@ -1032,6 +1085,7 @@ would previously result in `array[]`, but now prints properly.
 [@andyw8]: https://github.com/andyw8
 [@ashfurrow]: https://github.com/ashfurrow
 [@awinograd]: https://github.com/awinograd
+[@blampe]: https://github.com/blampe
 [@bugthing]: https://github.com/bugthing
 [@cbothner]: https://github.com/cbothner
 [@christoomey]: https://github.com/christoomey
@@ -1065,12 +1119,14 @@ would previously result in `array[]`, but now prints properly.
 [@kmcq]: https://github.com/kmcq
 [@krachtstefan]: https://github.com/krachtstefan
 [@localhostdotdev]: https://github.com/localhostdotdev
+[@lukyth]: https://github.com/lukyth
 [@marcmaniez]: https://github.com/MarcManiez
 [@masqita]: https://github.com/masqita
 [@matt-wratt]: https://github.com/matt-wratt
 [@meleyal]: https://github.com/meleyal
 [@mmainz]: https://github.com/mmainz
 [@mmcnl]: https://github.com/mmcnl
+[@nathan-beam]: https://github.com/nathan-beam
 [@noahtheduke]: https://github.com/NoahTheDuke
 [@overload119]: https://github.com/Overload119
 [@petevk]: https://github.com/petevk

data/CONTRIBUTING.md

@@ -22,7 +22,7 @@ In order to get printed, the code goes through a couple of transformations. The
 
 ### Text to AST
 
-When the prettier process first spins up, it examines which files it's going to print and selects an appropriate plugin for each one. Once selected, it runs that plugin's `parse` function, seen [here](src/parser.js). For the case of the Ruby plugin, that entails spawning a Ruby process that runs [parser.rb](src/parser.rb) with the input code preloaded on stdin.
+When the prettier process first spins up, it examines which files it's going to print and selects an appropriate plugin for each one. Once selected, it runs that plugin's `parse` function, seen [here](src/ruby/parser.js). For the case of the Ruby plugin, that entails spawning a Ruby process that runs [parser.rb](src/ruby/parser.rb) with the input code preloaded on stdin.
 
 `parser.rb` will read the text off of stdin and then feed it to a new `Ripper` instance, which is a Ruby standard library recursive-descent parser. Briefly, the way that `Ripper` works is by tokenizing the input and then matching those tokens against a grammar to form s-expressions. To extend `Ripper`, you overwrite the methods that control how those s-expressions are formed, e.g., to modify the s-expression that is formed when `Ripper` encounters a string literal, you would override the `#on_string_literal` method. Below is an example for seeing that in action.
 
@@ -71,7 +71,7 @@ Now that the text has been transformed into an AST that we can work with, `parse
 
 ### AST to Doc
 
-Once prettier has a working AST, it will take it and call the selected plugin's [`printNode` function](src/printer.js), whose purpose is to convert that AST into prettier's intermediate representation called Docs. It does this by handing the print function a `FastPath` object that keeps track of the state of the printing as it goes, and allows accessing various parts of the AST quickly.
+Once prettier has a working AST, it will take it and call the selected plugin's [`printNode` function](src/ruby/printer.js), whose purpose is to convert that AST into prettier's intermediate representation called Docs. It does this by handing the print function a `FastPath` object that keeps track of the state of the printing as it goes, and allows accessing various parts of the AST quickly.
 
 Effectively, it walks the AST in the reverse direction from the way `Ripper` built it (top-down instead of bottom-up). The first node that gets passed into the `print` function is the `program` node as that's always on top. Then it is the `program` node's responsibility to recursively call print on its child nodes as it best sees fit.
 

data/README.md

@@ -120,7 +120,7 @@ The `prettier` executable is now installed and ready for use:
 
 ## Configuration
 
-Below are the options (from [`src/ruby.js`](src/ruby.js)) that `@prettier/plugin-ruby` currently supports:
+Below are the options (from [`src/plugin.js`](src/plugin.js)) that `@prettier/plugin-ruby` currently supports:
 
 | API Option         | CLI Option             | Default | Description                                                                                                                          |
 | ------------------ | ---------------------- | :-----: | ------------------------------------------------------------------------------------------------------------------------------------ |
@@ -149,6 +149,19 @@ Or, they can be passed to `prettier` as arguments:
 prettier --ruby-single-quote false --write '**/*.rb'
 ```
 
+### Usage with RuboCop
+
+RuboCop and Prettier for Ruby serve different purposes, but there is overlap
+with some of RuboCop's functionality.
+
+Prettier provides a RuboCop configuration fle to disable the rules which clash.
+To enable, add the following config at the top of your project's `.rubocop.yml`:
+
+```yaml
+inherit_gem:
+  prettier: rubocop.yml
+```
+
 ## Contributing
 
 Check out our [contributing guide](CONTRIBUTING.md). Bug reports and pull requests are welcome on GitHub at https://github.com/prettier/plugin-ruby.
@@ -230,6 +243,8 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     <td align="center"><a href="https://github.com/rindek"><img src="https://avatars1.githubusercontent.com/u/881209?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Jacek Jakubik</b></sub></a><br /><a href="https://github.com/prettier/plugin-ruby/issues?q=author%3Arindek" title="Bug reports">🐛</a></td>
     <td align="center"><a href="https://twitter.com/ykpythemind"><img src="https://avatars2.githubusercontent.com/u/22209702?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Yukito Ito</b></sub></a><br /><a href="https://github.com/prettier/plugin-ruby/issues?q=author%3Aykpythemind" title="Bug reports">🐛</a> <a href="https://github.com/prettier/plugin-ruby/commits?author=ykpythemind" title="Code">💻</a></td>
     <td align="center"><a href="https://studyfied.com/"><img src="https://avatars2.githubusercontent.com/u/45869605?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Karan Mandal</b></sub></a><br /><a href="https://github.com/prettier/plugin-ruby/issues?q=author%3Akaranmandal" title="Bug reports">🐛</a></td>
+    <td align="center"><a href="http://nathanbeam.codes/"><img src="https://avatars3.githubusercontent.com/u/24681333?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Nathan Beam</b></sub></a><br /><a href="https://github.com/prettier/plugin-ruby/issues?q=author%3Anathan-beam" title="Bug reports">🐛</a> <a href="https://github.com/prettier/plugin-ruby/commits?author=nathan-beam" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/blampe"><img src="https://avatars3.githubusercontent.com/u/848843?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Bryce Lampe</b></sub></a><br /><a href="https://github.com/prettier/plugin-ruby/issues?q=author%3Ablampe" title="Bug reports">🐛</a></td>
   </tr>
 </table>
 

data/lib/prettier.rb

@@ -9,8 +9,8 @@ module Prettier
 
   class << self
     def run(args)
-      quoted = args.map { |arg| arg.start_with?('-') ? arg : "'#{arg}'" }
-      command = "node #{BINARY} --plugin '#{PLUGIN}' #{quoted.join(' ')}"
+      quoted = args.map { |arg| arg.start_with?('-') ? arg : "\"#{arg}\"" }
+      command = "node #{BINARY} --plugin \"#{PLUGIN}\" #{quoted.join(' ')}"
 
       system({ 'RBPRETTIER' => '1' }, command)
     end

data/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@prettier/plugin-ruby",
-  "version": "1.1.0",
+  "version": "1.2.4",
   "description": "prettier plugin for the Ruby programming language",
-  "main": "src/ruby.js",
+  "main": "src/plugin.js",
   "scripts": {
     "check-format": "prettier --check '**/*'",
     "lint": "eslint --cache .",

data/rubocop.yml

@@ -0,0 +1,26 @@
+# Disabling all Layout/* rules, as they're unnecessary when the user is using
+# prettier to handle all of the formatting.
+
+Layout:
+  Enabled: false
+
+# Disabling all of the following options because they could conflict with a
+# prettier configuration setting.
+
+Style/MultilineIfModifier: # rubyModifier
+  Enabled: false
+
+Style/SymbolArray: # rubyArrayLiteral
+  Enabled: false
+
+Style/WordArray: # rubyArrayLiteral
+  Enabled: false
+
+Style/TrailingCommaInArguments: # trailingComma
+  Enabled: false
+
+Style/TrailingCommaInArrayLiteral: # trailingComma
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral: # trailingComma
+  Enabled: false

data/src/{ruby.js → plugin.js}

@@ -1,5 +1,5 @@
-const printer = require("./printer");
-const parser = require("./parser");
+const printer = require("./ruby/printer");
+const parser = require("./ruby/parser");
 
 /*
  * metadata mostly pulled from linguist and rubocop:

data/src/prettier.js

@@ -1,6 +1,7 @@
 // If `RBPRETTIER` is set, then this is being run from the `Prettier::run` ruby
 // method. In that case, we need to pull `prettier` from the node_modules
 // directly, as it's been shipped with the gem.
+/* istanbul ignore next */
 const source = process.env.RBPRETTIER ? "../node_modules/prettier" : "prettier";
 
 const prettier = require(source);

data/src/{embed.js → ruby/embed.js}

@@ -6,9 +6,9 @@ const {
   mapDoc,
   markAsRoot,
   stripTrailingHardline
-} = require("./prettier");
+} = require("../prettier");
 
-const { literalLineNoBreak } = require("./utils");
+const { literalLineNoBreak } = require("../utils");
 
 const parsers = {
   css: "css",
@@ -20,6 +20,10 @@ const parsers = {
   scss: "scss"
 };
 
+// This function is in here because it handles embedded parser values. I don't
+// have a test that exercises it because I'm not sure for which parser it is
+// necessary, but since it's in prettier core I'm keeping it here.
+/* istanbul ignore next */
 const replaceNewlines = (doc) =>
   mapDoc(doc, (currentDoc) =>
     typeof currentDoc === "string" && currentDoc.includes("\n")

data/src/{nodes → ruby/nodes}/alias.js

@@ -5,7 +5,7 @@ const {
   group,
   hardline,
   line
-} = require("../prettier");
+} = require("../../prettier");
 
 // In general, return the printed doc of the argument at the provided index.
 // Special handling is given for symbol literals that are not bare words, as we

data/src/{nodes → ruby/nodes}/aref.js

@@ -1,4 +1,11 @@
-const { concat, group, indent, join, line, softline } = require("../prettier");
+const {
+  concat,
+  group,
+  indent,
+  join,
+  line,
+  softline
+} = require("../../prettier");
 
 // `aref` nodes are when you're pulling a value out of a collection at a
 // specific index. Put another way, it's any time you're calling the method

data/src/{nodes → ruby/nodes}/args.js

@@ -6,10 +6,10 @@ const {
   join,
   line,
   softline
-} = require("../prettier");
+} = require("../../prettier");
+const { getTrailingComma } = require("../../utils");
 
 const toProc = require("../toProc");
-const { getTrailingComma } = require("../utils");
 
 function printArgParen(path, opts, print) {
   const argsNode = path.getValue().body[0];

data/src/{nodes → ruby/nodes}/arrays.js

@@ -6,9 +6,8 @@ const {
   join,
   line,
   softline
-} = require("../prettier");
-
-const { getTrailingComma, printEmptyCollection } = require("../utils");
+} = require("../../prettier");
+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

data/src/{nodes → ruby/nodes}/assign.js

@@ -1,5 +1,5 @@
-const { concat, group, indent, join, line } = require("../prettier");
-const { first, skipAssignIndent } = require("../utils");
+const { concat, group, indent, join, line } = require("../../prettier");
+const { skipAssignIndent } = require("../../utils");
 
 function printAssign(path, opts, print) {
   const [_targetNode, valueNode] = path.getValue().body;
@@ -31,9 +31,17 @@ function printOpAssign(path, opts, print) {
   );
 }
 
+function printVarField(path, opts, print) {
+  return path.getValue().body ? path.call(print, "body", 0) : "";
+}
+
+function printVarRef(path, opts, print) {
+  return path.call(print, "body", 0);
+}
+
 module.exports = {
   assign: printAssign,
   opassign: printOpAssign,
-  var_field: first,
-  var_ref: first
+  var_field: printVarField,
+  var_ref: printVarRef
 };

data/src/ruby/nodes/blocks.js

@@ -0,0 +1,90 @@
+const {
+  breakParent,
+  concat,
+  group,
+  ifBreak,
+  indent,
+  join,
+  removeLines,
+  softline
+} = require("../../prettier");
+const { hasAncestor } = require("../../utils");
+
+function printBlockVar(path, opts, print) {
+  const parts = ["|", removeLines(path.call(print, "body", 0))];
+
+  // The second part of this node is a list of optional block-local variables
+  if (path.getValue().body[1]) {
+    parts.push("; ", join(", ", path.map(print, "body", 1)));
+  }
+
+  parts.push("| ");
+  return concat(parts);
+}
+
+function printBlock(braces) {
+  return function printBlockWithBraces(path, opts, print) {
+    const [variables, statements] = path.getValue().body;
+    const stmts =
+      statements.type === "stmts" ? statements.body : statements.body[0].body;
+
+    let doBlockBody = "";
+    if (
+      stmts.length !== 1 ||
+      stmts[0].type !== "void_stmt" ||
+      stmts[0].comments
+    ) {
+      doBlockBody = indent(concat([softline, path.call(print, "body", 1)]));
+    }
+
+    // If this block is nested underneath a command or command_call node, then
+    // we can't use `do...end` because that will get associated with the parent
+    // node as opposed to the current node (because of the difference in
+    // operator precedence). Instead, we still use a multi-line format but
+    // switch to using braces instead.
+    const useBraces = braces && hasAncestor(path, ["command", "command_call"]);
+
+    const doBlock = concat([
+      useBraces ? " {" : " do",
+      variables ? concat([" ", path.call(print, "body", 0)]) : "",
+      doBlockBody,
+      concat([softline, useBraces ? "}" : "end"])
+    ]);
+
+    // We can hit this next pattern if within the block the only statement is a
+    // comment.
+    if (
+      stmts.length === 1 &&
+      stmts[0].type === "void_stmt" &&
+      stmts[0].comments
+    ) {
+      return concat([breakParent, doBlock]);
+    }
+
+    const blockReceiver = path.getParentNode().body[0];
+
+    // If the parent node is a command node, then there are no parentheses
+    // around the arguments to that command, so we need to break the block
+    if (["command", "command_call"].includes(blockReceiver.type)) {
+      return concat([breakParent, doBlock]);
+    }
+
+    const hasBody = stmts.some(({ type }) => type !== "void_stmt");
+    const braceBlock = concat([
+      " {",
+      hasBody || variables ? " " : "",
+      variables ? path.call(print, "body", 0) : "",
+      path.call(print, "body", 1),
+      hasBody ? " " : "",
+      "}"
+    ]);
+
+    return group(ifBreak(doBlock, braceBlock));
+  };
+}
+
+module.exports = {
+  block_var: printBlockVar,
+  brace_block: printBlock(true),
+  do_block: printBlock(false)
+};

data/src/{nodes → ruby/nodes}/calls.js

@@ -5,8 +5,8 @@ const {
   ifBreak,
   indent,
   softline
-} = require("../prettier");
-const { first, makeCall, noIndent } = require("../utils");
+} = require("../../prettier");
+const { makeCall, noIndent } = require("../../utils");
 
 const toProc = require("../toProc");
 
@@ -41,15 +41,18 @@ function printCall(path, opts, print) {
     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;
   }
 
   // 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.
   if (!chained.includes(parentNode.type) && (node.chain || 0) >= 3) {
-    return ifBreak(
-      group(indent(concat(node.breakDoc.concat(rightSideDoc)))),
-      concat([receiverDoc, group(rightSideDoc)])
-    );
+    let breakDoc = concat(node.breakDoc.concat(rightSideDoc));
+    if (!noIndent.includes(node.firstReceiverType)) {
+      breakDoc = indent(breakDoc);
+    }
+
+    return ifBreak(group(breakDoc), concat([receiverDoc, group(rightSideDoc)]));
   }
 
   // For certain left sides of the call nodes, we want to attach directly to
@@ -105,6 +108,7 @@ function printMethodAddArg(path, opts, print) {
   if (chained.includes(parentNode.type)) {
     parentNode.chain = (node.chain || 0) + 1;
     parentNode.breakDoc = (node.breakDoc || [methodDoc]).concat(argsDoc);
+    parentNode.firstReceiverType = node.firstReceiverType;
   }
 
   // If we're at the top of a chain, then we're going to print out a nice
@@ -152,7 +156,7 @@ function isSorbetTypeAnnotation(node) {
     callNode.body[0].body[0].body === "sig" &&
     callNode.body[1].type === "args" &&
     callNode.body[1].body.length === 0 &&
-    blockNode.type === "brace_block"
+    blockNode
   );
 }
 
@@ -198,6 +202,7 @@ function printMethodAddBlock(path, opts, print) {
   if (chained.includes(parentNode.type)) {
     parentNode.chain = (node.chain || 0) + 1;
     parentNode.breakDoc = (node.breakDoc || [callDoc]).concat(blockDoc);
+    parentNode.firstReceiverType = node.firstReceiverType;
   }
 
   // If we're at the top of a chain, then we're going to print out a nice
@@ -212,10 +217,14 @@ function printMethodAddBlock(path, opts, print) {
   return concat([callDoc, blockDoc]);
 }
 
+function printCallContainer(path, opts, print) {
+  return path.call(print, "body", 0);
+}
+
 module.exports = {
   call: printCall,
-  fcall: first,
+  fcall: printCallContainer,
   method_add_arg: printMethodAddArg,
   method_add_block: printMethodAddBlock,
-  vcall: first
+  vcall: printCallContainer
 };