prettier 2.0.0.pre.rc3 → 2.0.0.pre.rc4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8aa6c76fdc06048c17f4ae26b2179b181e2e10f4210c6d840d8059c661becdb5
-  data.tar.gz: 186e3d071167018e2eeb16d50818be1a1684710a0007226f2b3b3c403a190cd1
+  metadata.gz: 7001f9fc2c9aed2d630d5133b86baa047f44b1634690e0fcecc81c6186943c6d
+  data.tar.gz: 73cd58e7dec8253b2d1a9e9a4d18dd1cb968b147ddf71f069457ed2c1091a066
 SHA512:
-  metadata.gz: 31b4ebe0dc6c6a382c858f1349f4de1161e311df22d122c2f8935d833417e2ed235e42f075ded605f5e6924d3d2a2fb545123b9a5f66bfb89615c4cde3216758
-  data.tar.gz: 81a4467f636867133da2a93c5fc2f9a595e54dae597f9cde5ba45e98c0485cb3e2ab890151ce6e2da765881b753f1ce140b758bba70f25dcd1e64e950326a6ba
+  metadata.gz: 96f757bea8e85f036ba84dbd59a64e072264eedfcec6c901df5ef94bcb9f638a5fbb5c84a5b92c8f02cf26f75a8d1f8a5025a13eb3ec9a9bc3c2efc5f8790303
+  data.tar.gz: 13b2dd4e2d8e13f3bc01e5cca5d9abbaab975b668f164dd82e3c598344def9acd618082a0da7bb710e47886d85efaa7ca1d55bd33af24aee4ce2e41e0a7bbd89

data/CHANGELOG.md

@@ -6,6 +6,17 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [2.0.0-rc4]
+
+### 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]
 
 ### Changed
@@ -1169,7 +1180,8 @@ 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.0.0-rc4...HEAD
+[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/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/ruby/nodes/rescue.js

@@ -52,10 +52,13 @@ const printRescueEx = (path, opts, print) => {
     const [exception, variable] = path.getValue().body;
     const parts = [];
     if (exception) {
+        // If there's just one exception being rescued, then it's just going to be a
+        // single doc node.
         let exceptionDoc = path.call(print, "body", 0);
-        if (Array.isArray(exceptionDoc)) {
-            const joiner = [",", line];
-            exceptionDoc = group(join(joiner, exceptionDoc));
+        // If there are multiple exceptions being rescued, then we're going to have
+        // multiple doc nodes returned as an array that we need to join together.
+        if (["mrhs_add_star", "mrhs_new_from_args"].includes(exception.type)) {
+            exceptionDoc = group(join([",", line], exceptionDoc));
         }
         parts.push(" ", exceptionDoc);
     }

data/exe/rbprettier

@@ -4,5 +4,4 @@
 $:.unshift(File.expand_path(File.join('..', 'lib'), __dir__))
 require 'prettier'
 
-Prettier.run(ARGV)
-exit($?.exitstatus) if $?.exited?
+exit(Prettier.run(ARGV))

data/lib/prettier.rb

@@ -1,18 +1,49 @@
 # frozen_string_literal: true
 
 require 'json' unless defined?(JSON)
+require 'open3'
 
 module Prettier
   PLUGIN = -File.expand_path('..', __dir__)
   BINARY = -File.join(PLUGIN, 'node_modules', 'prettier', 'bin-prettier.js')
   VERSION = -JSON.parse(File.read(File.join(PLUGIN, 'package.json')))['version']
 
-  class << self
-    def run(args)
-      quoted = args.map { |arg| arg.start_with?('-') ? arg : "\"#{arg}\"" }
-      command = "node #{BINARY} --plugin \"#{PLUGIN}\" #{quoted.join(' ')}"
+  def self.run(args)
+    quoted = args.map { |arg| arg.start_with?('-') ? arg : "\"#{arg}\"" }
+    command = "node #{BINARY} --plugin \"#{PLUGIN}\" #{quoted.join(' ')}"
 
-      system({ 'RBPRETTIER' => '1' }, command)
+    stdout, stderr, status = Open3.capture3({ 'RBPRETTIER' => '1' }, command)
+    STDOUT.puts(stdout)
+
+    # If we completed successfully, then just exit out.
+    exitstatus = status.exitstatus
+    return exitstatus if exitstatus == 0
+
+    if stderr.match?(%r{Cannot find module '/.+?/bin-prettier.js'})
+      # If we're missing bin-prettier.js, then it's possible the user installed
+      # the gem through git, which wouldn't have installed the requisite
+      # JavaScript files.
+      STDERR.puts(<<~MSG)
+        Could not find the JavaScript files necessary to run prettier.
+
+        If you installed this dependency through git instead of from rubygems,
+        it does not install the necessary files by default. To fix this you can
+        either install them yourself by cd-ing into the directory where this gem
+        is located (#{File.expand_path('..', __dir__)}) and running:
+          
+          `yarn && yarn prepublishOnly`
+           or
+           `npm install && npm run prepublishOnly`
+           or
+           you can change the source in your Gemfile to point directly to rubygems.
+      MSG
+    else
+      # Otherwise, just print out the same error that prettier emitted, as it's
+      # unknown to us.
+      STDERR.puts(stderr)
     end
+
+    # Make sure we still exit with the same status code the prettier emitted.
+    exitstatus
   end
 end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prettier/plugin-ruby",
-  "version": "2.0.0-rc3",
+  "version": "2.0.0-rc4",
   "description": "prettier plugin for the Ruby programming language",
   "main": "dist/plugin.js",
   "scripts": {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prettier
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre.rc3
+  version: 2.0.0.pre.rc4
 platform: ruby
 authors:
 - Kevin Newton
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-01 00:00:00.000000000 Z
+date: 2021-10-18 00:00:00.000000000 Z
 dependencies: []
 description:
 email: