prettier 2.0.0.pre.rc3 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8aa6c76fdc06048c17f4ae26b2179b181e2e10f4210c6d840d8059c661becdb5
-  data.tar.gz: 186e3d071167018e2eeb16d50818be1a1684710a0007226f2b3b3c403a190cd1
+  metadata.gz: 34ffeeada2b06900ec6759f31a42ca387c8748a6a22843a1792fd906bfb4ffda
+  data.tar.gz: ddbceb38e8263f881fd12f66560615db880cf7870f0cb926671c2da656aad6f8
 SHA512:
-  metadata.gz: 31b4ebe0dc6c6a382c858f1349f4de1161e311df22d122c2f8935d833417e2ed235e42f075ded605f5e6924d3d2a2fb545123b9a5f66bfb89615c4cde3216758
-  data.tar.gz: 81a4467f636867133da2a93c5fc2f9a595e54dae597f9cde5ba45e98c0485cb3e2ab890151ce6e2da765881b753f1ce140b758bba70f25dcd1e64e950326a6ba
+  metadata.gz: 300acaf432b28f15d5b7690effbe7ca8fff778af699c5f79d0872c15f3241ec9be2e8fd83f86a9e65e6807cd152504b78d79760b30926c418bc7358d5d9f7524
+  data.tar.gz: a7d658200446e7dde838d07b502303fa30e168e800f3053e48e6cf05940fbb92892d0eaca9c48304a48b13d6c94dce09019bb7a2c18acc18c48b3c241d4d4637

data/CHANGELOG.md

@@ -6,14 +6,53 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
-## [2.0.0-rc3]
+## [2.1.0] - 2022-04-04
+
+### Added
+
+- [#1065](https://github.com/prettier/plugin-ruby/issues/1065) - langalex, kddnewton - The ability to set the `PRETTIER_RUBY_TIMEOUT_MS` environment variable to control how long to wait for the parser server to spin up.
+- [#1173](https://github.com/prettier/plugin-ruby/pull/1173) - dleavitt - Support for RBS 2.x on Ruby 3.1.
+
+### Changed
+
+- [#1028](https://github.com/prettier/plugin-ruby/issues/1028) - levymetal, kddnewton - Fix up some nested formatting with very complicated RSpec assertions.
+- [#1035](https://github.com/prettier/plugin-ruby/issues/1035) - qcn, kddnewton - Ensure we don't try to print `return` incorrectly when multiple statements are contained within parentheses.
+- [#1048](https://github.com/prettier/plugin-ruby/pull/1048) - kddnewton - Completely refactor the Ruby parser to use classes instead of hashes. Also remove a lot of the `body` keys are replace them with actual names.
+- [#1042](https://github.com/prettier/plugin-ruby/issues/1042) - JoshuaKGoldberg, kddnewton - Ensure blocks are printed correctly when there are trailing comments on the `do` keyword.
+- [#1134](https://github.com/prettier/plugin-ruby/pull/1134) - mhssmnn - Fix piping for STDIN to the gem process.
+- [#1167](https://github.com/prettier/plugin-ruby/pull/1167) - dleavitt - More consistent assignment indentation.
+- [#1074](https://github.com/prettier/plugin-ruby/issues/1074) - wagenet, kddnewton - Fix up `return` when nodes return arrays of docs.
+
+### Removed
+
+- [#1048](https://github.com/prettier/plugin-ruby/pull/1048) - kddnewton - Drop support for Ruby 2.5.
+
+## [2.0.0] - 2021-10-28
+
+### Changed
+
+- [#1018](https://github.com/prettier/plugin-ruby/issues/1018) - rindek, kddnewton - Ensure brackets are used when matching an array pattern with a single element.
+- [#906](https://github.com/prettier/plugin-ruby/issues/906) - Hansenq, kddnewton - Turn off the `Style/MultilineBlockChain` rubocop rule in our shipped configuration because multiple chained method calls with blocks can potentially conflict with rubocop's desired output.
+
+## [2.0.0-rc4] - 2021-10-18
+
+### Added
+
+- [#993](https://github.com/prettier/plugin-ruby/pull/993) - kddnewton - Nicer error message if you don't have the necessary JavaScript files to run prettier.
+- [#996](https://github.com/prettier/plugin-ruby/pull/996) - nbudin - Allow `@prettier/plugin-ruby` to run in yarn's plug'n'play mode.
+
+### Changed
+
+- [#1000](https://github.com/prettier/plugin-ruby/pull/1000) - nbudin, kddnewton - Fix for rescuing single top-level exceptions in `rescue` clauses.
+
+## [2.0.0-rc3] - 2021-10-01
 
 ### Changed
 
 - [#987](https://github.com/prettier/plugin-ruby/pull/9870) - valscion - Ignore stderr when checking for node <-> ruby connection clients, restoring the behavior of v1.x
 - [#989](https://github.com/prettier/plugin-ruby/issues/989) - hubertjakubiak, kddnewton - Make sure comments after the keyword/lbrace are not moved inside the body of the statements of do and brace blocks.
 
-## [2.0.0-rc2]
+## [2.0.0-rc2] - 2021-09-30
 
 ### Added
 
@@ -24,7 +63,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 - [#943](https://github.com/prettier/plugin-ruby/issues/943) - valscion, kddnewton - Trailing call operators that are followed by comments should stay on the first line.
 
-## [2.0.0-rc1]
+## [2.0.0-rc1] - 2021-09-30
 
 ### Added
 
@@ -1169,7 +1208,10 @@ would previously result in `array[]`, but now prints properly.
 
 - Initial release 🎉
 
-[unreleased]: https://github.com/prettier/plugin-ruby/compare/v2.0.0-rc3...HEAD
+[unreleased]: https://github.com/prettier/plugin-ruby/compare/v2.1.0...HEAD
+[2.1.0]: https://github.com/prettier/plugin-ruby/compare/v2.0.0...v2.1.0
+[2.0.0]: https://github.com/prettier/plugin-ruby/compare/v2.0.0-rc4...v2.0.0
+[2.0.0-rc4]: https://github.com/prettier/plugin-ruby/compare/v2.0.0-rc3...v2.0.0-rc4
 [2.0.0-rc3]: https://github.com/prettier/plugin-ruby/compare/v2.0.0-rc2...v2.0.0-rc3
 [2.0.0-rc2]: https://github.com/prettier/plugin-ruby/compare/v2.0.0-rc1...v2.0.0-rc2
 [2.0.0-rc1]: https://github.com/prettier/plugin-ruby/compare/v1.6.1...v2.0.0-rc1

data/dist/haml/parser.rb

@@ -44,6 +44,12 @@ class Haml::Parser::ParseNode
         if hash
           # Explicitly not using Enumerable#to_h here to support Ruby 2.5
           hash.each_with_object({}) do |(key, value), response|
+            # For attributes that starts with @, wrap the attribute in quotes
+            # For other attributes, remove the quotes
+            # AlpineJS uses @-attributes
+            # {'type': 'submit'} => {type: 'submit'}
+            # {'@click': 'open'} => {'@click': 'open'}
+            key = "\'#{key}\'" if key.start_with?('@')
             response[key] = parse_value(value, level + 1)
           end
         else

data/dist/parser/getInfo.js

@@ -1,12 +1,19 @@
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const { existsSync, readFileSync } = require("fs");
 
+// This is how long to wait for the parser to spin up. For the most part, 5
+// seconds is plenty of time. But in some environments, it may be necessary to
+// increase this value.
+const timeoutMs = parseInt(process.env.PRETTIER_RUBY_TIMEOUT_MS || "5000", 10);
+
 const filepath = process.argv[process.argv.length - 1];
 
 const timeout = setTimeout(() => {
   clearInterval(interval);
-  throw new Error("Failed to get information from parse server in time.");
-}, 5000);
+  throw new Error(`Failed to get information from parse server in time. If this
+    happens repeatedly, try increasing the PRETTIER_RUBY_TIMEOUT_MS environment
+    variable beyond 5000.`);
+}, timeoutMs);
 
 const interval = setInterval(() => {
   if (existsSync(filepath)) {

data/dist/parser/parseSync.js

@@ -58,8 +58,53 @@ exports.getInfoFilepath = getInfoFilepath;
 // will read that information in order to enable us to connect to it in the
 // spawnSync function.
 function spawnServer() {
+    const tempDir = (0, fs_1.mkdtempSync)(path_1.default.join(os_1.default.tmpdir(), "prettier-plugin-ruby-"));
     const filepath = getInfoFilepath();
-    const server = (0, child_process_1.spawn)("ruby", [path_1.default.join(__dirname, "./server.rb"), filepath], {
+    let serverRbPath = path_1.default.join(__dirname, "./server.rb");
+    let getInfoJsPath = path_1.default.join(__dirname, "./getInfo.js");
+    let cleanupTempFiles;
+    if (runningInPnPZip()) {
+        // If we're running in a Yarn PnP environment inside a ZIP file, it's not possible to run
+        // the Ruby server or the getInfo.js script directly.  Instead, we need to copy them and all
+        // the files they depend on to a temporary directory.
+        const sourceFiles = [
+            "parser/server.rb",
+            "parser/getInfo.js",
+            "parser/netcat.js",
+            "ruby/parser.rb",
+            "rbs/parser.rb",
+            "haml/parser.rb"
+        ];
+        serverRbPath = path_1.default.join(tempDir, "parser", "server.rb");
+        getInfoJsPath = path_1.default.join(tempDir, "parser", "getInfo.js");
+        sourceFiles.forEach((rubyFile) => {
+            const destDir = path_1.default.join(tempDir, path_1.default.dirname(rubyFile));
+            if (!(0, fs_1.existsSync)(destDir)) {
+                (0, fs_1.mkdirSync)(destDir);
+            }
+            (0, fs_1.copyFileSync)(path_1.default.join(__dirname, "..", rubyFile), path_1.default.join(tempDir, rubyFile));
+        });
+        cleanupTempFiles = () => {
+            [
+                getInfoJsPath,
+                ...sourceFiles.map((rubyFile) => path_1.default.join(tempDir, rubyFile))
+            ].forEach((tmpFilePath) => {
+                if ((0, fs_1.existsSync)(tmpFilePath)) {
+                    (0, fs_1.unlinkSync)(tmpFilePath);
+                }
+            });
+            sourceFiles.forEach((rubyFile) => {
+                const tempSubdir = path_1.default.join(tempDir, path_1.default.dirname(rubyFile));
+                if ((0, fs_1.existsSync)(tempSubdir)) {
+                    (0, fs_1.rmdirSync)(tempSubdir);
+                }
+            });
+            if ((0, fs_1.existsSync)(tempDir)) {
+                (0, fs_1.rmdirSync)(tempDir);
+            }
+        };
+    }
+    const server = (0, child_process_1.spawn)("ruby", [serverRbPath, filepath], {
         env: Object.assign({}, process_1.default.env, { LANG: getLang() }),
         detached: true,
         stdio: "inherit"
@@ -69,6 +114,9 @@ function spawnServer() {
         if ((0, fs_1.existsSync)(filepath)) {
             (0, fs_1.unlinkSync)(filepath);
         }
+        if (cleanupTempFiles != null) {
+            cleanupTempFiles();
+        }
         try {
             if (server.pid) {
                 process_1.default.kill(-server.pid);
@@ -80,10 +128,7 @@ function spawnServer() {
             }
         }
     });
-    const info = (0, child_process_1.spawnSync)("node", [
-        path_1.default.join(__dirname, "./getInfo.js"),
-        filepath
-    ]);
+    const info = (0, child_process_1.spawnSync)("node", [getInfoJsPath, filepath]);
     if (info.status !== 0) {
         throw new Error(`
       We failed to spawn our parser server. Please report this error on GitHub
@@ -97,16 +142,9 @@ function spawnServer() {
 }
 // If we're in a yarn Plug'n'Play environment, then the relative paths being
 // used by the parser server and the various scripts used to communicate
-// therein are not going to work with its virtual file system. Presumably
-// there's a way to fix this but I haven't figured out how yet.
-function checkPnP() {
-    if (process_1.default.versions.pnp) {
-        throw new Error(`
-      @prettier/plugin-ruby does not current work within the yarn Plug'n'Play
-      virtual file system. If you would like to help support the effort to fix
-      this, please see https://github.com/prettier/plugin-ruby/issues/894.
-    `);
-    }
+// therein are not going to work with its virtual file system.
+function runningInPnPZip() {
+    return process_1.default.versions.pnp && __dirname.includes(".zip");
 }
 // Formats and sends a request to the parser server. We use netcat (or something
 // like it) here since Prettier requires the results of `parse` to be
@@ -114,7 +152,6 @@ function checkPnP() {
 // requests.
 function parseSync(parser, source) {
     if (!parserArgs) {
-        checkPnP();
         parserArgs = spawnServer();
     }
     const response = (0, child_process_1.spawnSync)(parserArgs.cmd, parserArgs.args, {

data/dist/parser/server.rb

@@ -6,6 +6,10 @@ require 'json'
 require 'fileutils'
 require 'open3'
 
+# Ensure the parent module is defined before requiring the parsers.
+module Prettier
+end
+
 require_relative '../ruby/parser'
 require_relative '../rbs/parser'
 require_relative '../haml/parser'
@@ -72,7 +76,7 @@ listener =
           when 'ping'
             'pong'
           when 'ruby'
-            Prettier::Parser.parse(source)
+            SyntaxTree.parse(source)
           when 'rbs'
             Prettier::RBSParser.parse(source)
           when 'haml'
@@ -84,7 +88,7 @@ listener =
         else
           socket.write('{ "error": true }')
         end
-      rescue Prettier::Parser::ParserError => error
+      rescue SyntaxTree::ParseError => error
         loc = { start: { line: error.lineno, column: error.column } }
         socket.write(JSON.fast_generate(error: error.message, loc: loc))
       rescue StandardError => error

data/dist/rbs/parser.rb

@@ -19,6 +19,17 @@ rescue LoadError
   return
 end
 
+# This was removed at some point, so we need to support both versions.
+RBS::KEYWORD_RAW =
+  if RBS::Parser.const_defined?(:KEYWORDS_RE)
+    RBS::Parser::KEYWORDS_RE
+  else
+    RBS::Parser::KEYWORDS.keys.join('|')
+  end
+
+# This enforces that the full matched string is a keyword.
+RBS::KEYWORD_FULL = /\A#{RBS::KEYWORD_RAW}\z/
+
 # Monkey-patch this so that we can get the character positions.
 class RBS::Location
   def to_json(*args)
@@ -40,7 +51,12 @@ end
 # Monkey-patch this so that we get whether or not it needs to be escaped.
 class RBS::Types::Function::Param
   def to_json(*a)
-    escaped = name && /\A#{RBS::Parser::KEYWORDS_RE}\z/.match?(name)
+    escaped = name && RBS::KEYWORD_FULL.match?(name)
+
+    # More modern versions of RBS just include the ` in the name so there's no
+    # need to escape it further.
+    escaped = false if name.to_s.start_with?('`')
+
     { type: type, name: name, escaped: escaped }.to_json(*a)
   end
 end
@@ -71,7 +87,7 @@ class RBS::Types::Record
     # Explicitly not using Enumerable#to_h here to support Ruby 2.5
     fields.each do |key, type|
       if key.is_a?(Symbol) && key.match?(/\A[A-Za-z_][A-Za-z_]*\z/) &&
-           !key.match?(RBS::Parser::KEYWORDS_RE)
+           !key.match?(RBS::KEYWORD_RAW)
         fields_extra[key] = { type: type, joiner: :label }
       else
         fields_extra[key.inspect] = { type: type, joiner: :rocket }
@@ -82,6 +98,47 @@ class RBS::Types::Record
   end
 end
 
+if defined?(RBS::AST::Declarations::ModuleTypeParams)
+  # This class was removed in rbs 2.0. Monkeypatch < 2.0 to give the same json
+  # output
+  class RBS::AST::Declarations::ModuleTypeParams
+    def to_json(*a)
+      params.to_json(*a)
+    end
+  end
+
+  # make this look like the new AST::TypeParam json
+  class RBS::AST::Declarations::ModuleTypeParams::TypeParam
+    def to_json(*a)
+      { name: name, variance: variance, unchecked: skip_validation }.to_json(*a)
+    end
+  end
+
+  # https://github.com/ruby/rbs/commit/3ccdcb1f3ac5dcb866280f745866a852658195e6
+  class RBS::MethodType
+    # promote the array of symbols into TypeParam looking-things
+    def to_json(*a)
+      type_param_objects =
+        type_params.map do |name|
+          {
+            name: name,
+            variance: 'invariant',
+            unchecked: 'false',
+            upper_bound: nil
+            # location - harder to get this but not needed
+          }
+        end
+
+      {
+        type_params: type_param_objects,
+        type: type,
+        block: block,
+        location: location
+      }.to_json(*a)
+    end
+  end
+end
+
 # The main parser interface.
 module Prettier
   class RBSParser

data/dist/rbs/printer.js

@@ -228,7 +228,7 @@ const printer = {
             const preferredQuote = opts.rubySingleQuote ? "'" : '"';
             // Determine if we're allowed to change the quote based on whether or not
             // there is an escape sequence in the source string.
-            const quote = node.literal.includes("\\")
+            const quote = value.match(new RegExp(`\\\\[^${originalQuote}]`))
                 ? originalQuote
                 : preferredQuote;
             return makeString(value.slice(1, -1), quote, false);
@@ -367,13 +367,13 @@ const printer = {
         // Additionally loops through each type parameter if there are any and print
         // them out joined by commas. Checks for validation and variance.
         function printNameAndTypeParams(path, node) {
-            if (node.type_params.params.length === 0) {
+            if (node.type_params.length === 0) {
                 return node.name;
             }
             const docs = path.map((paramPath) => {
                 const node = paramPath.getValue();
                 const parts = [];
-                if (node.skip_validation) {
+                if (node.unchecked) {
                     parts.push("unchecked");
                 }
                 if (node.variance === "covariant") {
@@ -382,8 +382,15 @@ const printer = {
                 else if (node.variance === "contravariant") {
                     parts.push("in");
                 }
-                return join(" ", [...parts, node.name]);
-            }, "type_params", "params");
+                if (node.upper_bound) {
+                    const path = paramPath;
+                    const upperBound = path.call(printType, "upper_bound");
+                    return join(" ", [...parts, node.name, "<", upperBound]);
+                }
+                else {
+                    return join(" ", [...parts, node.name]);
+                }
+            }, "type_params");
             return [node.name, "[", join(", ", docs), "]"];
         }
         // Returns an array of printed parameters so that the calling function can
@@ -455,7 +462,8 @@ const printer = {
             const parts = [];
             // We won't have a type_params key if we're printing a block
             if (node.type_params && node.type_params.length > 0) {
-                parts.push("[", join(", ", node.type_params), "] ");
+                const typeParamNames = node.type_params.map((tp) => tp.name);
+                parts.push("[", join(", ", typeParamNames), "] ");
             }
             const params = path.call(printMethodParams, "type");
             if (params.length > 0) {

data/dist/ruby/embed.js

@@ -57,6 +57,11 @@ function stripCommonLeadingWhitespace(content) {
     const minimum = getCommonLeadingWhitespace(content);
     return lines.map((line) => line.slice(minimum)).join("\n");
 }
+// A type assertion so that TypeScript knows we're working with an array of
+// exclusively plain string content.
+function isTStringContentArray(body) {
+    return body.every((part) => part.type === "tstring_content");
+}
 const embed = (path, print, textToDoc) => {
     const node = path.getValue();
     // Currently we only support embedded formatting on heredoc nodes
@@ -64,19 +69,19 @@ const embed = (path, print, textToDoc) => {
         return null;
     }
     // First, ensure that we don't have any interpolation
-    const { beging, body, ending } = node;
-    const isSquiggly = beging.body[2] === "~";
-    if (body.some((part) => part.type !== "@tstring_content")) {
+    const { beging, parts, ending } = node;
+    const isSquiggly = beging.value[2] === "~";
+    if (!isTStringContentArray(parts)) {
         return null;
     }
     // Next, find the parser associated with this heredoc (if there is one). For
     // example, if you use <<~CSS, we'd hook it up to the css parser.
-    const parser = parsers[beging.body.slice(3).toLowerCase()];
+    const parser = parsers[beging.value.slice(3).toLowerCase()];
     if (!parser) {
         return null;
     }
     // Get the content as if it were a source string.
-    let content = body.map((part) => part.body).join("");
+    let content = parts.map((part) => part.value).join("");
     // If we're using a squiggly heredoc, then we're going to manually strip off
     // the leading whitespace of each line up to the minimum leading whitespace so
     // that the embedded parser can handle that for us.

data/dist/ruby/location.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEndChar = exports.getEndLine = exports.getStartChar = exports.getStartLine = void 0;
+function getStartLine(location) {
+    return location[0];
+}
+exports.getStartLine = getStartLine;
+function getStartChar(location) {
+    return location[1];
+}
+exports.getStartChar = getStartChar;
+function getEndLine(location) {
+    return location[2];
+}
+exports.getEndLine = getEndLine;
+function getEndChar(location) {
+    return location[3];
+}
+exports.getEndChar = getEndChar;

data/dist/ruby/nodes/alias.js

@@ -27,6 +27,7 @@ const { addTrailingComment, align, group, hardline, line } = prettier_1.default;
 // the symbol literal `bar` and the right could be the symbol literal `foo`.
 const printAlias = (path, opts, print) => {
     const keyword = "alias ";
+    const node = path.getValue();
     // 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 convert those into bare words by just pulling out the ident node.
@@ -38,21 +39,21 @@ const printAlias = (path, opts, print) => {
             // otherwise we could accidentally skip printing them.
             if (argNode.comments) {
                 argNode.comments.forEach((comment) => {
-                    addTrailingComment(argNode.body[0], comment);
+                    addTrailingComment(argNode.value, comment);
                 });
             }
-            return argPath.call(print, "body", 0);
+            return argPath.call(print, "value");
         }
         return print(argPath);
     };
     return group([
         keyword,
-        path.call(printAliasArg, "body", 0),
+        path.call(printAliasArg, "left"),
         group(align(keyword.length, [
             // If the left child has any comments, then we need to explicitly break
             // this into two lines
-            path.getValue().body[0].comments ? hardline : line,
-            path.call(printAliasArg, "body", 1)
+            node.left.comments ? hardline : line,
+            path.call(printAliasArg, "right")
         ]))
     ]);
 };

data/dist/ruby/nodes/aref.js

@@ -19,9 +19,8 @@ const { group, indent, join, line, softline } = prettier_1.default;
 //     foo[]
 //
 const printAref = (path, opts, print) => {
-    const indexNode = path.getValue().body[1];
-    if (!indexNode) {
-        return [path.call(print, "body", 0), "[]"];
+    if (!path.getValue().index) {
+        return [path.call(print, "collection"), "[]"];
     }
     return (0, exports.printArefField)(path, opts, print);
 };
@@ -41,11 +40,10 @@ exports.printAref = printAref;
 //     foo[bar] = baz
 //
 const printArefField = (path, opts, print) => {
-    const [printedArray, printedIndex] = path.map(print, "body");
     return group([
-        printedArray,
+        path.call(print, "collection"),
         "[",
-        indent([softline, join([",", line], printedIndex)]),
+        indent([softline, join([",", line], path.call(print, "index"))]),
         softline,
         "]"
     ]);