prettier 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f4a11b3b694651795ea82803d2b9efaafc70bc811409eeba50a76d48aff55bd
-  data.tar.gz: '0039c5cd3d89db3dbff1e0b5c4cfb2f307838f77faec7c6a9c3d23781f22bb4a'
+  metadata.gz: 1a60ee62443799f6fdd3380700b4091b75e1f50658e01cad2cdf1ade440917f4
+  data.tar.gz: 4c95bb8ae2916d965e12cc376aa2c8df0ce985420e78edc45554c6412a4e3469
 SHA512:
-  metadata.gz: 73dfee52bf2aaa09c15c6dc23f167ecf20ef983b368a0bac4ad3fb8d193044bb4109469a0eae06c93909ee0a5aef6e926035c083efe4fec9c696a2286efe3470
-  data.tar.gz: 02bded0e2c06e9153a16391671886f695f433c0a035b00116dc9e4fdae01a309b66d8f9147431491e81979e135c1abe6e796bf5e4c0005ebd00579d85ca9df0c
+  metadata.gz: f449363349b3476457419d8374dd1127ac8bcfb7faf2afa1f20eb49b21968c2cd5301ad26731bde90e8de64f5604534f375ffcf7ef60bdb21b0fb3f95c160439
+  data.tar.gz: 27fde34295c91d167f693d5ab4c8e67c639d9302854a7ef2423552b978a9611615b94fa07b3dae6d20c611fc7bc9764820570555a88faf61450235c467ee757e

data/CHANGELOG.md

@@ -6,6 +6,30 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [3.2.0] - 2022-07-22
+
+### Added
+
+- [#1250](https://github.com/prettier/plugin-ruby/issues/1250) - alexf101, kddnewton - Respect the `tabWidth` option.
+
+### Changed
+
+- [#1255](https://github.com/prettier/plugin-ruby/pull/1255) - soberstadt - The rake task now runs check if write is false.
+- [#1237](https://github.com/prettier/plugin-ruby/issues/1237) - boris-petrov - Disable the style rules associated with quotes.
+- [#1248](https://github.com/prettier/plugin-ruby/pull/1248) - mhssmnn - Fix process waiting on STDIN.
+
+## [3.1.2] - 2022-05-13
+
+### Changed
+
+- [#1127](https://github.com/prettier/plugin-ruby/issues/1227) - mscrivo, kddnewton - Support passing the `printWidth` option.
+
+## [3.1.1] - 2022-05-12
+
+### Changed
+
+- [#1125](https://github.com/prettier/plugin-ruby/pull/1225) - kddnewton - Update the bundled rubocop config to be in sync with Syntax Tree.
+
 ## [3.1.0] - 2022-05-12
 
 ### Added
@@ -1231,7 +1255,10 @@ would previously result in `array[]`, but now prints properly.
 
 - Initial release 🎉
 
-[unreleased]: https://github.com/prettier/plugin-ruby/compare/v3.0.0...HEAD
+[unreleased]: https://github.com/prettier/plugin-ruby/compare/v3.1.2...HEAD
+[3.1.2]: https://github.com/prettier/plugin-ruby/compare/v3.1.1...v3.1.2
+[3.1.1]: https://github.com/prettier/plugin-ruby/compare/v3.1.0...v3.1.1
+[3.1.0]: https://github.com/prettier/plugin-ruby/compare/v3.0.0...v3.1.0
 [3.0.0]: https://github.com/prettier/plugin-ruby/compare/v2.1.0...v3.0.0
 [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

data/README.md

@@ -68,7 +68,7 @@ end
 
 ## Getting started
 
-To run `prettier` with the Ruby plugin, you're going to need [`ruby`](https://www.ruby-lang.org/en/documentation/installation/) (version `2.5` or newer) and [`node`](https://nodejs.org/en/download/) (version `8.3` or newer). If you're integrating with a project that is not already using `prettier`, you should use the Ruby gem. Otherwise you can use the `npm` package directly.
+To run `prettier` with the Ruby plugin, you're going to need [`ruby`](https://www.ruby-lang.org/en/documentation/installation/) (version `2.7.3` or newer) and [`node`](https://nodejs.org/en/download/) (version `8.3` or newer). If you're integrating with a project that is not already using `prettier`, you should use the Ruby gem. Otherwise you can use the `npm` package directly.
 
 Note that currently the editor integrations work best with the `npm` package, as most of the major editor plugins expect a `node_modules` directory. You can get them to work with the Ruby gem, but it requires manually configuring the paths.
 
@@ -121,7 +121,7 @@ yarn add --dev prettier @prettier/plugin-ruby
 You'll also need to add the necessary Ruby dependencies. You can do this by running:
 
 ```bash
-gem install bundler syntax_tree syntax_tree-haml syntax_tree-rbs
+gem install bundler prettier_print syntax_tree syntax_tree-haml syntax_tree-rbs
 ```
 
 The `prettier` executable is now installed and ready for use:

data/lib/prettier/rake/task.rb

@@ -49,7 +49,7 @@ module Prettier
       end
 
       def run_task
-        Prettier.run([("--write" if write), source_files].compact)
+        Prettier.run([write ? "--write" : "--check", source_files].compact)
         exit($?.exitstatus) if $?&.exited?
       end
     end

data/lib/prettier.rb

@@ -11,9 +11,10 @@ module Prettier
   def self.run(args)
     quoted = args.map { |arg| arg.start_with?("-") ? arg : "\"#{arg}\"" }
     command = "node #{BINARY} --plugin \"#{PLUGIN}\" #{quoted.join(" ")}"
+    opts = STDIN.tty? ? {} : { stdin_data: STDIN }
 
     stdout, stderr, status =
-      Open3.capture3({ "RBPRETTIER" => "1" }, command, stdin_data: STDIN)
+      Open3.capture3({ "RBPRETTIER" => "1" }, command, opts)
     STDOUT.puts(stdout)
 
     # If we completed successfully, then just exit out.

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prettier/plugin-ruby",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "description": "prettier plugin for the Ruby programming language",
   "main": "src/plugin.js",
   "scripts": {

data/rubocop.yml

@@ -1,6 +1,5 @@
 # Disabling all Layout/* rules, as they're unnecessary when the user is using
-# prettier to handle all of the formatting.
-
+# Syntax Tree to handle all of the formatting.
 Layout:
   Enabled: false
 
@@ -16,6 +15,16 @@ Layout/LineLength:
 Style/MultilineIfModifier:
   Enabled: false
 
+# Syntax Tree will expand empty methods to put the end keyword on the subsequent
+# line to reduce git diff noise.
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+# lambdas that are constructed with the lambda method call cannot be safely
+# turned into lambda literals without removing a method call.
+Style/Lambda:
+  Enabled: false
+
 # When method chains with multiple blocks are chained together, rubocop will let
 # them pass if they're using braces but not if they're using do and end
 # keywords. Because we will break individual blocks down to using keywords if
@@ -23,12 +32,28 @@ Style/MultilineIfModifier:
 Style/MultilineBlockChain:
   Enabled: false
 
+# Disable the single- vs double-quotes rules as these depend on whether the user
+# has added or not `plugin/single_quotes` for `syntax_tree`
+Style/StringLiterals:
+  Enabled: false
+
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+
+Style/QuotedSymbols:
+  Enabled: false
+
+# We let users have a little more freedom with symbol and words arrays. If the
+# user only has an individual item like ["value"] then we don't bother
+# converting it because it ends up being just noise.
 Style/SymbolArray:
   Enabled: false
 
 Style/WordArray:
   Enabled: false
 
+# Disable the trailing-comma rules as these depend on whether the user has added
+# or not `plugin/trailing_comma` for `syntax_tree`
 Style/TrailingCommaInArguments:
   Enabled: false
 
@@ -37,8 +62,3 @@ Style/TrailingCommaInArrayLiteral:
 
 Style/TrailingCommaInHashLiteral:
   Enabled: false
-
-# lambdas that are constructed with the lambda method call cannot be safely
-# turned into lambda literals without removing a method call.
-Style/Lambda:
-  Enabled: false

data/src/parseSync.js

@@ -181,7 +181,7 @@ function parseSync(parser, source, opts) {
   }
 
   const response = spawnSync(parserArgs.cmd, parserArgs.args, {
-    input: `${parser}|${source}`,
+    input: `${parser}|${opts.printWidth}|${opts.tabWidth}|${source}`,
     maxBuffer: 15 * 1024 * 1024
   });
 

data/src/server.rb

@@ -6,6 +6,7 @@ require "json"
 require "fileutils"
 require "open3"
 
+require "prettier_print"
 require "syntax_tree"
 require "syntax_tree/haml"
 require "syntax_tree/rbs"
@@ -73,7 +74,8 @@ listener =
 
       # Start up a new thread that will handle each successive connection.
       Thread.new(server.accept_nonblock) do |socket|
-        parser, source = socket.read.force_encoding("UTF-8").split("|", 2)
+        parser, maxwidth_string, tabwidth_string, source =
+          socket.read.force_encoding("UTF-8").split("|", 4)
 
         source.each_line do |line|
           case line
@@ -90,16 +92,40 @@ listener =
           end
         end
 
+        # At the moment, we're not going to support odd tabwidths. It's going to
+        # have to be a multiple of 2, because of the way that the prettyprint
+        # gem functions. So we're going to just use integer division here.
+        scalar = tabwidth_string.to_i / 2
+        genspace = ->(n) { " " * n * scalar }
+
+        maxwidth = maxwidth_string.to_i
         response =
           case parser
           when "ping"
             "pong"
           when "ruby"
-            SyntaxTree.format(source)
+            formatter =
+              SyntaxTree::Formatter.new(source, [], maxwidth, "\n", &genspace)
+            SyntaxTree.parse(source).format(formatter)
+            formatter.flush
+            formatter.output.join
           when "rbs"
-            SyntaxTree::RBS.format(source)
+            formatter =
+              SyntaxTree::RBS::Formatter.new(
+                source,
+                [],
+                maxwidth,
+                "\n",
+                &genspace
+              )
+            SyntaxTree::RBS.parse(source).format(formatter)
+            formatter.flush
+            formatter.output.join
           when "haml"
-            SyntaxTree::Haml.format(source)
+            formatter = PrettierPrint.new(+"", maxwidth, "\n", &genspace)
+            SyntaxTree::Haml.parse(source).format(formatter)
+            formatter.flush
+            formatter.output
           end
 
         if response

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prettier
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Kevin Newton
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-12 00:00:00.000000000 Z
+date: 2022-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: syntax_tree
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.1
+        version: 2.7.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.1
+        version: 2.7.1
 - !ruby/object:Gem::Dependency
   name: syntax_tree-haml
   requirement: !ruby/object:Gem::Requirement