prettier 3.2.2 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c772ae9c41714e30e74b8d7d832a2efdd939835ada857eeb4ec80e1f036d4d5
-  data.tar.gz: f9895d25d44b055627a3518d13b3c81334bcc9bb13514a8617f3ad49ef0b8114
+  metadata.gz: f48ed0363e8410a6e7fb2c3c8bc95ed8a87f8fac28546429571b71bdd3225e19
+  data.tar.gz: b7a8dd5700deda01c743c926890eb977660445a06ca057540ab347b27126ff4b
 SHA512:
-  metadata.gz: 9a131aed0b99f4ea445a64c6c9c985931523ad6f5586df6e5d08d263d0ab4f1c40f4a17c685590b726afcae498ece6b34cf2fe9451a8e24bdc22ff8896719ea8
-  data.tar.gz: d3723afae5fdf5547e1f88f2d3443964951fe2faa8931434afa01aa8565643f93282b28bb15064079447022497234b7c28bd1eae0b78c5b6985053f4f498291e
+  metadata.gz: 81880c36ea2a6493552c0af368c61e7cc1f587af9ddfde72e9cdbe484a3cd855c30d1cad7ddfdb629e15f2c54998d822fbab75b35f31ce33fb555b14f9f1255b
+  data.tar.gz: 21213157b04d8f7e801fd9e0e90ee8351f723223caa8672bd2e00e152a1e2111bb85f6caa35400fb7fa6d3e19b75a36b1c176fb6ebf02f567796ad4ea0472930

data/CHANGELOG.md

@@ -6,6 +6,18 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [4.0.0] - 2023-07-06
+
+### Added
+
+- [#1283](https://github.com/prettier/plugin-ruby/pull/1283) - oriolgual - Use `process.execPath` instead of `"node"`.
+- [#1358](https://github.com/prettier/plugin-ruby/pull/1358) - davidalejandroaguilar - Add the `rubyExecutablePath` option.
+- [#1359](https://github.com/prettier/plugin-ruby/pull/1359) - kddnewton - Inherit stderr from the parser process in order to provide better error messages when failing to spawn parser server. This will put out missing gem errors, for example.
+
+### Changed
+
+- [#1360](https://github.com/prettier/plugin-ruby/pull/1360) - kddnewton - Require prettier v3.0.0+.
+
 ## [3.2.2] - 2022-09-20
 
 ### Changed
@@ -59,7 +71,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 - [#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.
+- [#1190](https://github.com/prettier/plugin-ruby/pull/1190) - kddnewton - Switch over to using Syntax Tree for the backend. This now requires that users install the necessary gems.
 
 ### Removed
 
@@ -1267,7 +1279,8 @@ would previously result in `array[]`, but now prints properly.
 
 - Initial release 🎉
 
-[unreleased]: https://github.com/prettier/plugin-ruby/compare/v3.2.2...HEAD
+[unreleased]: https://github.com/prettier/plugin-ruby/compare/v4.0.0...HEAD
+[4.0.0]: https://github.com/prettier/plugin-ruby/compare/v3.2.2...v4.0.0
 [3.2.2]: https://github.com/prettier/plugin-ruby/compare/v3.2.1...v3.2.2
 [3.2.1]: https://github.com/prettier/plugin-ruby/compare/v3.2.0...v3.2.1
 [3.2.0]: https://github.com/prettier/plugin-ruby/compare/v3.1.2...v3.2.0

data/README.md

@@ -9,7 +9,7 @@
     <img alt="Gitter" src="https://img.shields.io/gitter/room/jlongster/prettier.svg?style=flat-square">
   </a>
   <a href="https://github.com/prettier/plugin-ruby/actions">
-    <img alt="GitHub Actions" src="https://img.shields.io/github/workflow/status/prettier/plugin-ruby/Main?style=flat-square">
+    <img alt="GitHub Actions" src="https://img.shields.io/github/actions/workflow/status/prettier/plugin-ruby/main.yml?branch=main&style=flat-square">
   </a>
   <a href="https://www.npmjs.com/package/@prettier/plugin-ruby">
     <img alt="NPM Version" src="https://img.shields.io/npm/v/@prettier/plugin-ruby.svg?style=flat-square">
@@ -68,43 +68,13 @@ 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.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.
+The `@prettier/plugin-ruby` plugin for `prettier` is a small wrapper around the [Syntax Tree](https://github.com/ruby-syntax-tree/syntax_tree) gem that provides a Ruby formatter for `prettier`. It does this by keeping a Ruby server running in that background that `prettier` can communicate with when it needs to format a Ruby file. This means that in order to function, you will need to have both the requisite `node` and `ruby` dependencies installed. Because of this configuration, there are a couple of ways that you can get setup to use this plugin.
 
-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.
+- If you're already using `prettier` in your project to format other files in your project and want to install this as a plugin, you can install it using `npm`.
+- If you're not using `prettier` yet in your project, then we recommend using the [Syntax Tree](https://github.com/ruby-syntax-tree/syntax_tree) gem directly instead of using this plugin.
+- Note that this plugin also ships a gem named `prettier` which is a wrapper around the `prettier` CLI and includes this plugin by default, but _we no longer recommend its use_. If you're using that gem, you should migrate to using [Syntax Tree](https://github.com/ruby-syntax-tree/syntax_tree) instead.
 
-This plugin currently supports formatting the following kinds of files:
-
-- All varieties of Ruby source files (e.g., `*.rb`, `*.gemspec`, `Gemfile`, etc.)
-- [RBS type language](https://github.com/ruby/rbs) files - requires having the `rbs` gem in your gem path
-- [HAML template language](https://haml.info/) files - requires having the `haml` gem in your gem path
-
-### Ruby gem
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem "prettier"
-```
-
-And then execute:
-
-```bash
-bundle
-```
-
-Or install it yourself as:
-
-```bash
-gem install prettier
-```
-
-The `rbprettier` executable is now installed and ready for use:
-
-```bash
-bundle exec rbprettier --write '**/*'
-```
-
-### `npm` package
+To run `prettier` with the Ruby plugin as an `npm` package, you're going to need [`ruby`](https://www.ruby-lang.org/en/documentation/installation/) (version `2.7` or newer) and [`node`](https://nodejs.org/en/download/) (version `16` or newer).
 
 If you're using the `npm` CLI, then add the plugin by:
 
@@ -134,14 +104,15 @@ 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)).                                                 |
-| `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)).                                                      |
-| `singleQuote`   | `--single-quote`   | `false` | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#quotes)).                                                         |
-| `trailingComma` | `--trailing-comma` |  `es5`  | Almost same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#trailing-commas)). Will be on for any value except `none`. |
+| 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)).                                                 |
+| `rubyExecutablePath` | `"ruby"`              | Allows you to configure your Ruby executable path. |
+| `rubyPlugins`        | `--ruby-plugins`      |                        `""`                        | The comma-separated list of plugins to require. See [Syntax Tree](https://github.com/ruby-syntax-tree/syntax_tree#plugins).                         |
+| `rubySingleQuote`    | `--ruby-single-quote` |                      `false`                       | Whether or not to default to single quotes for Ruby code. 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)).                                                      |
+| `trailingComma`      | `--trailing-comma`    |                       `es5`                        | Almost same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#trailing-commas)). Will be on for any value except `none`. |
 
 Any of these can be added to your existing [prettier configuration
 file](https://prettier.io/docs/en/configuration.html). For example:
@@ -158,22 +129,13 @@ Or, they can be passed to `prettier` as arguments:
 bundle exec rbprettier --tab-width 4 --write '**/*'
 ```
 
-### Usage with RuboCop
-
-RuboCop and Prettier for Ruby serve different purposes, but there is overlap
-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`:
+### Ignoring code
 
-#### Ruby gem
+Sometimes you want to leave your formatting in place and have `prettier` not format it, but continue to format the rest of the file. `prettier` has the ability to do this with `prettier-ignore` comments, but because the underlying formatter for this plugin is [Syntax Tree](https://github.com/ruby-syntax-tree/syntax_tree), you instead would use a `stree-ignore` comment.
 
-```yaml
-inherit_gem:
-  prettier: rubocop.yml
-```
+### Usage with RuboCop
 
-#### `npm` package
+RuboCop and Prettier for Ruby serve different purposes, but there is overlap with some of RuboCop's functionality. Prettier provides a RuboCop configuration file to disable the rules which would clash. To enable this file, add the following configuration at the top of your project's `.rubocop.yml`:
 
 ```yaml
 inherit_from:
@@ -201,9 +163,11 @@ Refer to [this issue](https://github.com/prettier/plugin-ruby/issues/113#issueco
 
 ## Contributing
 
-Check out our [contributing guide](CONTRIBUTING.md). Bug reports and pull requests are welcome on GitHub at https://github.com/prettier/plugin-ruby.
+Thanks so much for your interest in contributing! You can contribute in many ways, including:
 
-You can support `prettier/plugin-ruby` [on OpenCollective](https://opencollective.com/prettier-ruby/contribute). Your organization's logo will show up here with a link to your website.
+- Contributing code to fix any bugs on [GitHub](https://github.com/prettier/plugin-ruby).
+- Reporting issues on [GitHub](https://github.com/prettier/plugin-ruby/issues/new).
+- Supporting `prettier/plugin-ruby` on [OpenCollective](https://opencollective.com/prettier-ruby/contribute). Your organization's logo will show up here with a link to your website.
 
 <!-- prettier-ignore-start -->
 <!-- markdownlint-disable -->

data/lib/prettier.rb

@@ -4,17 +4,19 @@ 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"]
+  directory = -File.expand_path("..", __dir__)
+  package = File.read(File.join(directory, "package.json"))
+
+  PLUGIN = -File.join(directory, "src/plugin.js")
+  BINARY = -File.join(directory, "node_modules/prettier/bin/prettier.cjs")
+  VERSION = -JSON.parse(package)["version"]
 
   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, opts)
+    stdout, stderr, status = Open3.capture3({}, command, opts)
     STDOUT.puts(stdout)
 
     # If we completed successfully, then just exit out.