prettier 2.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8393d82622bcce83298aa8e2833b37bccf9742b0a67e81cd3b730e57e6795b8
-  data.tar.gz: a66af4efc73854f143e0faa288fdde112bf87ba45364af3efd862a179734453c
+  metadata.gz: 5f4a11b3b694651795ea82803d2b9efaafc70bc811409eeba50a76d48aff55bd
+  data.tar.gz: '0039c5cd3d89db3dbff1e0b5c4cfb2f307838f77faec7c6a9c3d23781f22bb4a'
 SHA512:
-  metadata.gz: f780174b5b038bfd9583c637caefff23e442f4aef626e9e33769811c15afd7c267bb78f20c4eb223ab4b50f3c0b6664123c6ce00d997ff0a571b0d57228f5070
-  data.tar.gz: bdfbd3f42b4db020059b511b3176ee7b5393a5a008136dd06a584c26df69afbcfe7d937e6151e22029858d71bad68e8c68eb07241e67771debd802cf733c282d
+  metadata.gz: 73dfee52bf2aaa09c15c6dc23f167ecf20ef983b368a0bac4ad3fb8d193044bb4109469a0eae06c93909ee0a5aef6e926035c083efe4fec9c696a2286efe3470
+  data.tar.gz: 02bded0e2c06e9153a16391671886f695f433c0a035b00116dc9e4fdae01a309b66d8f9147431491e81979e135c1abe6e796bf5e4c0005ebd00579d85ca9df0c

data/CHANGELOG.md

@@ -6,6 +6,50 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [3.1.0] - 2022-05-12
+
+### Added
+
+- [#1224](https://github.com/prettier/plugin-ruby/pull/1224) - kddnewton - Support passing the `rubyPlugins` option to configure Syntax Tree.
+
+## [3.0.0] - 2022-05-04
+
+### Added
+
+- [#1190](https://github.com/prettier/plugin-ruby/pull/1190) - kddnewton - Encoding for source files is now guessed in a much better way.
+
+### Changed
+
+- [#1198](https://github.com/prettier/plugin-ruby/issues/1198) - pas-f, kddnewton - Fix crashes on JRuby with do blocks.
+- [#1131](https://github.com/prettier/plugin-ruby/issues/1131) - hyrious, kddnewton - Ensure zombie processes are not left around when the server exits.
+- [#1206](https://github.com/prettier/plugin-ruby/pull/1206) - kddnewton - Switch back to plain JavaScript for development.
+- [#1190](https://github.com/prettier/plugin-ruby/pull/1190) - kddnewton - Switch over to using Syntax Tree for the backend.
+
+### Removed
+
+- [#1190](https://github.com/prettier/plugin-ruby/pull/1190) - kddnewton - The configuration options have been removed. Instead, configuration is to be done through modifying Syntax Tree.
+
+## [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
@@ -295,7 +339,6 @@ The comment in the above example should stay in place.
 
 ```ruby
 begin
-
 rescue Foo, Bar
   # comment
 end
@@ -451,7 +494,8 @@ return (a or b) if c?
 - kddnewton - Support for the `nokw_param` node for specifying when methods should no accept keywords, as in:
 
 ```ruby
-def foo(**nil); end
+def foo(**nil)
+end
 ```
 
 - kddnewton - Support for the `args_forward` node for forwarding all types of arguments, as in:
@@ -497,9 +541,9 @@ will now be printed as:
 
 ```ruby
 Config::Download.new(
-  'prettier',
-  filename: 'prettier.yml',
-  url: 'https://raw.githubusercontent.com/...'
+  "prettier",
+  filename: "prettier.yml",
+  url: "https://raw.githubusercontent.com/..."
 ).perform
 ```
 
@@ -1187,7 +1231,9 @@ would previously result in `array[]`, but now prints properly.
 
 - Initial release 🎉
 
-[unreleased]: https://github.com/prettier/plugin-ruby/compare/v2.0.0...HEAD
+[unreleased]: https://github.com/prettier/plugin-ruby/compare/v3.0.0...HEAD
+[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
 [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

data/README.md

@@ -59,9 +59,9 @@ d = [
   30_643_069_058
 ]
 a, s = [], $*[0]
-s.each_byte { |b| a << ('%036b' % d[b.chr.to_i]).scan(/\d{6}/) }
+s.each_byte { |b| a << ("%036b" % d[b.chr.to_i]).scan(/\d{6}/) }
 a.transpose.each do |a|
-  a.join.each_byte { |i| print i == 49 ? ($*[1] || '#') : 32.chr }
+  a.join.each_byte { |i| print i == 49 ? ($*[1] || "#") : 32.chr }
   puts
 end
 ```
@@ -83,7 +83,7 @@ This plugin currently supports formatting the following kinds of files:
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'prettier'
+gem "prettier"
 ```
 
 And then execute:
@@ -118,6 +118,12 @@ Or if you're using `yarn`, then add the plugin by:
 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
+```
+
 The `prettier` executable is now installed and ready for use:
 
 ```bash
@@ -128,31 +134,26 @@ 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`     | `"none"` | 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)).                         |
+| `rubyPlugins`   | `--ruby-plugins`   |  `""`   | The comma-separated list of plugins to require. See [Syntax Tree](https://github.com/ruby-syntax-tree/syntax_tree#plugins). |
+| `tabWidth`      | `--tab-width`      |   `2`   | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#tab-width)).                              |
 
 Any of these can be added to your existing [prettier configuration
 file](https://prettier.io/docs/en/configuration.html). For example:
 
 ```json
 {
-  "rubySingleQuote": false
+  "tabWidth": 4
 }
 ```
 
 Or, they can be passed to `prettier` as arguments:
 
 ```bash
-bundle exec rbprettier --ruby-single-quote false --write '**/*'
+bundle exec rbprettier --tab-width 4 --write '**/*'
 ```
 
 ### Usage with RuboCop

data/exe/rbprettier

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-$:.unshift(File.expand_path(File.join('..', 'lib'), __dir__))
-require 'prettier'
+$:.unshift(File.expand_path(File.join("..", "lib"), __dir__))
+require "prettier"
 
 exit(Prettier.run(ARGV))

data/lib/prettier/rake/task.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'rake'
-require 'rake/tasklib'
+require "rake"
+require "rake/tasklib"
 
 module Prettier
   module Rake
@@ -35,7 +35,7 @@ module Prettier
       def initialize(name = :prettier)
         @name = name
         @write = true
-        @source_files = 'lib/**/*.rb'
+        @source_files = "lib/**/*.rb"
 
         yield self if block_given?
         define_task
@@ -44,12 +44,12 @@ module Prettier
       private
 
       def define_task
-        desc 'Runs prettier over source files'
+        desc "Runs prettier over source files"
         task(name) { run_task }
       end
 
       def run_task
-        Prettier.run([('--write' if write), source_files].compact)
+        Prettier.run([("--write" if write), source_files].compact)
         exit($?.exitstatus) if $?&.exited?
       end
     end

data/lib/prettier.rb

@@ -1,18 +1,19 @@
 # frozen_string_literal: true
 
-require 'json' unless defined?(JSON)
-require 'open3'
+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']
+  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"]
 
   def self.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(" ")}"
 
-    stdout, stderr, status = Open3.capture3({ 'RBPRETTIER' => '1' }, command)
+    stdout, stderr, status =
+      Open3.capture3({ "RBPRETTIER" => "1" }, command, stdin_data: STDIN)
     STDOUT.puts(stdout)
 
     # If we completed successfully, then just exit out.
@@ -29,11 +30,11 @@ module 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:
+        is located (#{File.expand_path("..", __dir__)}) and running:
           
-          `yarn && yarn prepublishOnly`
+          `yarn install`
            or
-           `npm install && npm run prepublishOnly`
+           `npm install`
            or
            you can change the source in your Gemfile to point directly to rubygems.
       MSG