prettier 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edc974795ef0adb86312682bdedfa30cca29905f660b97334326494b8623144f
-  data.tar.gz: 9dcdc7ecb78e7ee4fa333b45e9f2e4b5ea5df4615869ce6b172377bf21126560
+  metadata.gz: 5f4a11b3b694651795ea82803d2b9efaafc70bc811409eeba50a76d48aff55bd
+  data.tar.gz: '0039c5cd3d89db3dbff1e0b5c4cfb2f307838f77faec7c6a9c3d23781f22bb4a'
 SHA512:
-  metadata.gz: ed0166367d99fc0af3135d76c47dae06bcddd92eaf9a7d3d680726d403a2eed16f08af8fe410c527113bf00d1a0fe11b4c6743820e4c907b2de2707884655ef3
-  data.tar.gz: c8fa9abb2ecf3561c913f9505f7d07c56e322c6f3031d44b9725c314bfb1576c0dc68c7c7e28f8a15f9d876c4307c0c90549e1db83a4c94b184e0a872413208d
+  metadata.gz: 73dfee52bf2aaa09c15c6dc23f167ecf20ef983b368a0bac4ad3fb8d193044bb4109469a0eae06c93909ee0a5aef6e926035c083efe4fec9c696a2286efe3470
+  data.tar.gz: 02bded0e2c06e9153a16391671886f695f433c0a035b00116dc9e4fdae01a309b66d8f9147431491e81979e135c1abe6e796bf5e4c0005ebd00579d85ca9df0c

data/CHANGELOG.md

@@ -6,6 +6,12 @@ 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

data/README.md

@@ -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 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.0",
   "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/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,9 +175,9 @@ 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, {

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

@@ -10,6 +10,11 @@ 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

metadata

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