prettier 3.0.0 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edc974795ef0adb86312682bdedfa30cca29905f660b97334326494b8623144f
-  data.tar.gz: 9dcdc7ecb78e7ee4fa333b45e9f2e4b5ea5df4615869ce6b172377bf21126560
+  metadata.gz: 69429c1f7b0cc5b82babb8463afcdacbb30026b0c9a77afcf8f6c4dbddd5b545
+  data.tar.gz: f81d934981c3086071371a9013184fbb19543dd7a86ca4258addd5870defbe73
 SHA512:
-  metadata.gz: ed0166367d99fc0af3135d76c47dae06bcddd92eaf9a7d3d680726d403a2eed16f08af8fe410c527113bf00d1a0fe11b4c6743820e4c907b2de2707884655ef3
-  data.tar.gz: c8fa9abb2ecf3561c913f9505f7d07c56e322c6f3031d44b9725c314bfb1576c0dc68c7c7e28f8a15f9d876c4307c0c90549e1db83a4c94b184e0a872413208d
+  metadata.gz: e6e612eb427b6c244c365b4595d1cefb0987e43255a541accd4843cadd4c73c0c5dd96268cf6ed8444afe2c2008e4792e3ad3155474d6ec20ffb880f65c23fb7
+  data.tar.gz: f825fb2f339e52c9c9dae9b287b5f21436fadaaea29ed0e93b14ee0ebb97bfaaac9aa1e16eaa2549b4a66e513c1007a3f48e1aa587efe6032568f77afd85d77f

data/CHANGELOG.md

@@ -6,6 +6,24 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [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
+
+- [#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
@@ -1225,7 +1243,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 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:
@@ -134,11 +134,12 @@ 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)). |
-| `tabWidth`      | `--tab-width`      |   `2`   | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#tab-width)).      |
+| 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:

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prettier/plugin-ruby",
-  "version": "3.0.0",
+  "version": "3.1.2",
   "description": "prettier plugin for the Ruby programming language",
   "main": "src/plugin.js",
   "scripts": {
@@ -22,9 +22,9 @@
     "prettier": ">=2.3.0"
   },
   "devDependencies": {
-    "eslint": "^8.1.0",
+    "eslint": "^8.15.0",
     "eslint-config-prettier": "^8.0.0",
-    "husky": "^7.0.0",
+    "husky": "^8.0.1",
     "jest": "^28.0.1",
     "pretty-quick": "^3.1.2"
   },

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
 
+# Syntax Tree by default uses double quotes, so changing the configuration here
+# to match that.
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/QuotedSymbols:
+  EnforcedStyle: double_quotes
+
+# 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
 
+# We don't support trailing commas in Syntax Tree by default, so just turning
+# these off for now.
 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

@@ -63,7 +63,7 @@ function getInfoFilepath() {
 // server with that filepath as an argument, then spawn another process that
 // will read that information in order to enable us to connect to it in the
 // spawnSync function.
-function spawnServer() {
+function spawnServer(opts) {
   const tempDir = mkdtempSync(path.join(os.tmpdir(), "prettier-plugin-ruby-"));
   const filepath = getInfoFilepath();
 
@@ -114,11 +114,15 @@ function spawnServer() {
     };
   }
 
-  const server = spawn("ruby", [serverRbPath, filepath], {
-    env: Object.assign({}, process.env, { LANG: getLang() }),
-    detached: true,
-    stdio: "inherit"
-  });
+  const server = spawn(
+    "ruby",
+    [serverRbPath, `--plugins=${opts.rubyPlugins}`, filepath],
+    {
+      env: Object.assign({}, process.env, { LANG: getLang() }),
+      detached: true,
+      stdio: "inherit"
+    }
+  );
 
   server.unref();
   process.on("exit", () => {
@@ -171,13 +175,13 @@ function runningInPnPZip() {
 // like it) here since Prettier requires the results of `parse` to be
 // synchronous and Node.js does not offer a mechanism for synchronous socket
 // requests.
-function parseSync(parser, source) {
+function parseSync(parser, source, opts) {
   if (!parserArgs) {
-    parserArgs = spawnServer();
+    parserArgs = spawnServer(opts);
   }
 
   const response = spawnSync(parserArgs.cmd, parserArgs.args, {
-    input: `${parser}|${source}`,
+    input: `${parser}|${opts.printWidth}|${source}`,
     maxBuffer: 15 * 1024 * 1024
   });
 

data/src/plugin.js

@@ -81,8 +81,8 @@ const plugin = {
   ],
   parsers: {
     ruby: {
-      parse(text) {
-        return parseSync("ruby", text);
+      parse(text, _parsers, opts) {
+        return parseSync("ruby", text, opts);
       },
       astFormat: "ruby",
       hasPragma(text) {
@@ -96,8 +96,8 @@ const plugin = {
       }
     },
     rbs: {
-      parse(text) {
-        return parseSync("rbs", text);
+      parse(text, _parsers, opts) {
+        return parseSync("rbs", text, opts);
       },
       astFormat: "rbs",
       hasPragma(text) {
@@ -111,8 +111,8 @@ const plugin = {
       }
     },
     haml: {
-      parse(text) {
-        return parseSync("haml", text);
+      parse(text, _parsers, opts) {
+        return parseSync("haml", text, opts);
       },
       astFormat: "haml",
       hasPragma(text) {
@@ -152,6 +152,15 @@ const plugin = {
       }
     }
   },
+  options: {
+    rubyPlugins: {
+      type: "string",
+      category: "Ruby",
+      default: "",
+      description: "The comma-separated list of plugins to require",
+      since: "3.1.0"
+    }
+  },
   defaultOptions: {
     printWidth: 80,
     tabWidth: 2

data/src/server.rb

@@ -6,10 +6,16 @@ require "json"
 require "fileutils"
 require "open3"
 
+require "prettier_print"
 require "syntax_tree"
 require "syntax_tree/haml"
 require "syntax_tree/rbs"
 
+# First, require all of the plugins that the user specified.
+ARGV.shift[/^--plugins=(.*)$/, 1]
+  .split(",")
+  .each { |plugin| require "syntax_tree/#{plugin}" }
+
 # Make sure we trap these signals to be sure we get the quit command coming from
 # the parent node process
 quit = false
@@ -68,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, width, source =
+          socket.read.force_encoding("UTF-8").split("|", 3)
 
         source.each_line do |line|
           case line
@@ -85,16 +92,25 @@ listener =
           end
         end
 
+        maxwidth = width.to_i
         response =
           case parser
           when "ping"
             "pong"
           when "ruby"
-            SyntaxTree.format(source)
+            formatter = SyntaxTree::Formatter.new(source, [], maxwidth)
+            SyntaxTree.parse(source).format(formatter)
+            formatter.flush
+            formatter.output.join
           when "rbs"
-            SyntaxTree::RBS.format(source)
+            formatter = SyntaxTree::RBS::Formatter.new(source, [], maxwidth)
+            SyntaxTree::RBS.parse(source).format(formatter)
+            formatter.flush
+            formatter.output.join
           when "haml"
-            SyntaxTree::Haml.format(source)
+            PrettierPrint.format(+"", maxwidth) do |q|
+              SyntaxTree::Haml.parse(source).format(q)
+            end
           end
 
         if response

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prettier
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.2
 platform: ruby
 authors:
 - Kevin Newton
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-05 00:00:00.000000000 Z
+date: 2022-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: syntax_tree