prettier 1.5.3 → 1.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1247c9f95d56f0bd5171d119a1376dc155670f372dcf2d09d8c082f35d89903a
-  data.tar.gz: f85697402fa353f3355312e70b267b4e53b9edf9540fa2ace6ea31dbe84ddacb
+  metadata.gz: 2c23f6803729e7a50ce180a31626443c85d3a622b16b2c49d4d0b80e8a89eb99
+  data.tar.gz: ba8d7d3939ac37e7ed8bb4b2c5efa68c06ac2cb9b217bac839779ee0901f1321
 SHA512:
-  metadata.gz: dd77c84b3f038ff3026814fd347602588d0bc5170c756873adb4dee7630aed45305f0e9353718e006b41eca8b10798a383e804a4f77993635e74a34b699a5522
-  data.tar.gz: 6836a386fccfbc80916b2abe99f23d4a44e1c52f859f7aaed7d8a3f8b27c104a3222c547860e09f198f4310988666e6f205751c1ae5f6afaed0950968338d459
+  metadata.gz: e8bb12d0468a507b63049340ab4709ac4cf001f9cb2941a3f83b4e22d265158b12efcc24f2a6e342b0e20eee39d6125549be9b224e76472be2c34c286d82b1af
+  data.tar.gz: 1187d27608c659d69f8e7c2d966002f451a0e43245110506814fcc5c6d54e865ef2d382bc6a66fabf4818994d0f82eff3e1c02c9108492026d44314ce85c34d4

data/CHANGELOG.md

@@ -6,6 +6,14 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [1.5.4] - 2021-03-17
+
+### Changed
+
+- [#835](https://github.com/prettier/plugin-ruby/issues/835) - valscion, kddeisz - Array splat operator should not get moved by leading comments.
+- [#836](https://github.com/prettier/plugin-ruby/issues/836) - valscion, kddeisz - Array splat operator should not get moved by trailing comments.
+- [#821](https://github.com/prettier/plugin-ruby/issues/821) - jscheid, kddeisz - Better error handling when using GNU netcat.
+
 ## [1.5.3] - 2021-02-28
 
 ### Changed
@@ -1085,7 +1093,9 @@ would previously result in `array[]`, but now prints properly.
 
 - Initial release 🎉
 
-[unreleased]: https://github.com/prettier/plugin-ruby/compare/v1.5.2...HEAD
+[unreleased]: https://github.com/prettier/plugin-ruby/compare/v1.5.4...HEAD
+[1.5.4]: https://github.com/prettier/plugin-ruby/compare/v1.5.3...v1.5.4
+[1.5.3]: https://github.com/prettier/plugin-ruby/compare/v1.5.2...v1.5.3
 [1.5.2]: https://github.com/prettier/plugin-ruby/compare/v1.5.1...v1.5.2
 [1.5.1]: https://github.com/prettier/plugin-ruby/compare/v1.5.0...v1.5.1
 [1.5.0]: https://github.com/prettier/plugin-ruby/compare/v1.4.0...v1.5.0

data/README.md

@@ -128,17 +128,19 @@ The `prettier` executable is now installed and ready for use:
 
 Below are the options (from [`src/plugin.js`](src/plugin.js)) that `@prettier/plugin-ruby` currently supports:
 
-| 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)).                                  |
-| `rubyArrayLiteral` | `--ruby-array-literal` | `true`  | When possible, favor the use of string and symbol array literals.                                                                    |
-| `rubyHashLabel`    | `--ruby-hash-label`    | `true`  | When possible, uses the shortened hash key syntax, as opposed to hash rockets.                                                       |
-| `rubyModifier`     | `--ruby-modifier`      | `true`  | When it fits on one line, allows while and until statements to use the modifier form.                                                |
-| `rubySingleQuote`  | `--ruby-single-quote`  | `true`  | When double quotes are not necessary for interpolation, prefers the use of single quotes for string literals.                        |
-| `rubyToProc`       | `--ruby-to-proc`       | `false` | When possible, convert blocks to the more concise `Symbol#to_proc` syntax.                                                           |
-| `tabWidth`         | `--tab-width`          |   `2`   | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#tab-width)).                                       |
-| `trailingComma`    | `--trailing-comma`     | `false` | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#trailing-comma)). `"es5"` is equivalent to `true`. |
+| 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)).                                                                                      |
+| `rubyArrayLiteral`  | `--ruby-array-literal`  | `true`  | When possible, favor the use of string and symbol array literals.                                                                                                                        |
+| `rubyHashLabel`     | `--ruby-hash-label`     | `true`  | When possible, uses the shortened hash key syntax, as opposed to hash rockets.                                                                                                           |
+| `rubyModifier`      | `--ruby-modifier`       | `true`  | When it fits on one line, allows while and until statements to use the modifier form.                                                                                                    |
+| `rubyNetcatCommand` | `--ruby-netcat-command` |         | The prefix of the command to execute to communicate between the node.js process and the Ruby process. (For example, `"nc -U"` or `"telnet -u"`) Normally you should not set this option. |
+
+| `rubySingleQuote` | `--ruby-single-quote` | `true` | When double quotes are not necessary for interpolation, prefers the use of single quotes for string literals. |
+| `rubyToProc` | `--ruby-to-proc` | `false` | When possible, convert blocks to the more concise `Symbol#to_proc` syntax. |
+| `tabWidth` | `--tab-width` | `2` | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#tab-width)). |
+| `trailingComma` | `--trailing-comma` | `false` | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#trailing-comma)). `"es5"` is equivalent to `true`. |
 
 Any of these can be added to your existing [prettier configuration
 file](https://prettier.io/docs/en/configuration.html). For example:
@@ -163,11 +165,20 @@ with some of RuboCop's functionality.
 Prettier provides a RuboCop configuration file to disable the rules which clash.
 To enable, add the following config at the top of your project's `.rubocop.yml`:
 
+#### Ruby gem
+
 ```yaml
 inherit_gem:
   prettier: rubocop.yml
 ```
 
+#### `npm` package
+
+```yaml
+inherit_from:
+  - node_modules/@prettier/plugin-ruby/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.

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prettier/plugin-ruby",
-  "version": "1.5.3",
+  "version": "1.5.4",
   "description": "prettier plugin for the Ruby programming language",
   "main": "src/plugin.js",
   "scripts": {
@@ -22,7 +22,7 @@
     "prettier": ">=1.10"
   },
   "devDependencies": {
-    "eslint": "^7.21.0",
+    "eslint": "^7.22.0",
     "eslint-config-prettier": "^8.0.0",
     "husky": "^5.0.9",
     "jest": "^26.0.0",

data/src/haml/parser.js

@@ -1,7 +1,7 @@
 const parseSync = require("../parser/parseSync");
 
-const parse = (text, _parsers, _opts) => {
-  return parseSync("haml", text);
+const parse = (text, _parsers, opts) => {
+  return parseSync("haml", text, opts);
 };
 
 const pragmaPattern = /^\s*-#\s*@(prettier|format)/;

data/src/parser/getNetcat.js

@@ -16,35 +16,42 @@ function hasCommand(name) {
 
 // Finds an netcat-like adapter to use for sending data to a socket. We order
 // these by likelihood of being found so we can avoid some shell-outs.
-function getCommandAndArg() {
+function getCommandAndArgs() {
   if (hasCommand("nc")) {
-    return ["nc", "-U"];
+    return ["nc", ["-U"]];
   }
 
   if (hasCommand("telnet")) {
-    return ["telnet", "-u"];
+    return ["telnet", ["-u"]];
   }
 
   if (hasCommand("ncat")) {
-    return ["ncat", "-U"];
+    return ["ncat", ["-U"]];
   }
 
   if (hasCommand("socat")) {
-    return ["socat", "-"];
+    return ["socat", ["-"]];
   }
 
-  return ["node", require.resolve("./netcat.js")];
+  return ["node", [require.resolve("./netcat.js")]];
 }
 
 let command;
-let arg;
+let args;
 
-function getNetcat() {
+function getNetcat(opts) {
   if (!command) {
-    [command, arg] = getCommandAndArg();
+    if (opts.rubyNetcatCommand) {
+      const splits = opts.rubyNetcatCommand.split(" ");
+
+      command = splits[0];
+      args = splits.slice(1);
+    } else {
+      [command, args] = getCommandAndArgs();
+    }
   }
 
-  return { command, arg };
+  return { command, args };
 }
 
 module.exports = getNetcat;

data/src/parser/netcat.js

@@ -5,11 +5,9 @@
 const { createConnection } = require("net");
 
 const sock = process.argv[process.argv.length - 1];
-
 const client = createConnection(sock, () => process.stdin.pipe(client));
 
 client.on("data", (data) => process.stdout.write(data));
-
 client.on("error", (error) => {
   console.error(error);
 });

data/src/parser/parseSync.js

@@ -4,9 +4,24 @@ const requestParse = require("./requestParse");
 // 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) {
-  const { stdout, stderr, status } = requestParse(parser, source);
+function parseSync(parser, source, opts) {
+  const { stdout, stderr, status } = requestParse(parser, source, opts);
 
+  // We need special handling in case the user's version of nc doesn't support
+  // using unix sockets.
+  if (stderr.includes("invalid option -- U")) {
+    throw new Error(`
+      @prettier/plugin-ruby uses netcat to communicate over unix sockets between
+      the node.js process running prettier and an underlying Ruby process used
+      for parsing. Unfortunately the version of netcat that you have installed
+      (GNU netcat) does not support unix sockets. To solve this either uninstall
+      GNU netcat and use a different implementation, or change the value of the
+      rubyNetcatCommand option in your prettier configuration.
+    `);
+  }
+
+  // If we didn't receive anything over stdout or we have a bad exit status,
+  // then throw whatever we can.
   if (stdout.length === 0 || (status !== null && status !== 0)) {
     throw new Error(stderr || "An unknown error occurred");
   }

data/src/parser/requestParse.js

@@ -54,11 +54,11 @@ function ensureParseServer() {
 }
 
 // Sends a request to the parse server to parse the given content.
-function requestParse(parser, source) {
+function requestParse(parser, source, opts) {
   ensureParseServer();
 
-  const { command, arg } = getNetcat();
-  const { stdout, stderr, status } = spawnSync(command, [arg, sockfile], {
+  const { command, args } = getNetcat(opts);
+  const { stdout, stderr, status } = spawnSync(command, args.concat(sockfile), {
     input: `${parser}|${source}`,
     maxBuffer: 15 * 1024 * 1024
   });

data/src/plugin.js

@@ -119,6 +119,12 @@ module.exports = {
       description:
         "When it fits on one line, allows if, unless, while, and until statements to use the modifier form."
     },
+    rubyNetcatCommand: {
+      type: "string",
+      category: "Ruby",
+      description:
+        'The prefix of the command to execute to communicate between the node.js process and the Ruby process. (For example, "nc -U" or "telnet -u") Normally you should not set this option.'
+    },
     rubySingleQuote: {
       type: "boolean",
       category: "Ruby",

data/src/rbs/parser.js

@@ -4,8 +4,8 @@ const parseSync = require("../parser/parseSync");
 // to prettier a JavaScript object that is the equivalent AST that represents
 // the code stored in that string. We accomplish this by spawning a new Ruby
 // process of parser.rb and reading JSON off STDOUT.
-function parse(text, _parsers, _opts) {
-  return parseSync("rbs", text);
+function parse(text, _parsers, opts) {
+  return parseSync("rbs", text, opts);
 }
 
 const pragmaPattern = /#\s*@(prettier|format)/;

data/src/ruby/nodes/args.js

@@ -147,9 +147,16 @@ function printArgsAddStar(path, opts, print) {
     //       *values
     //     ]
     //
+    // or if we have an array like:
+    //
+    //     [
+    //       *values # comment
+    //     ]
+    //
     // then we need to make sure we don't accidentally prepend the operator
     // before the comment.
-    docs[1].parts[2] = concat(["*", docs[1].parts[2]]);
+    const index = node.body[1].comments.filter(({ leading }) => leading).length;
+    docs[1].parts[index] = concat(["*", docs[1].parts[index]]);
   } else {
     // If we don't have any comments, we can just prepend the operator
     docs[1] = concat(["*", docs[1]]);

data/src/ruby/parser.js

@@ -4,8 +4,8 @@ const parseSync = require("../parser/parseSync");
 // to prettier a JavaScript object that is the equivalent AST that represents
 // the code stored in that string. We accomplish this by spawning a new Ruby
 // process of parser.rb and reading JSON off STDOUT.
-function parse(text, _parsers, _opts) {
-  return parseSync("ruby", text);
+function parse(text, _parsers, opts) {
+  return parseSync("ruby", text, opts);
 }
 
 const pragmaPattern = /#\s*@(prettier|format)/;

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prettier
 version: !ruby/object:Gem::Version
-  version: 1.5.3
+  version: 1.5.4
 platform: ruby
 authors:
 - Kevin Deisz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-28 00:00:00.000000000 Z
+date: 2021-03-17 00:00:00.000000000 Z
 dependencies: []
 description:
 email: