prettier 2.1.0 → 3.1.1

data/src/plugin.js

@@ -0,0 +1,170 @@
+const { parseSync } = require("./parseSync");
+
+/*
+ * metadata mostly pulled from linguist and rubocop:
+ * https://github.com/github/linguist/blob/master/lib/linguist/languages.yml
+ * https://github.com/rubocop/rubocop/blob/master/spec/rubocop/target_finder_spec.rb
+ */
+const plugin = {
+  languages: [
+    {
+      name: "Ruby",
+      parsers: ["ruby"],
+      extensions: [
+        ".arb",
+        ".axlsx",
+        ".builder",
+        ".eye",
+        ".fcgi",
+        ".gemfile",
+        ".gemspec",
+        ".god",
+        ".jb",
+        ".jbuilder",
+        ".mspec",
+        ".opal",
+        ".pluginspec",
+        ".podspec",
+        ".rabl",
+        ".rake",
+        ".rb",
+        ".rbi",
+        ".rbuild",
+        ".rbw",
+        ".rbx",
+        ".ru",
+        ".ruby",
+        ".thor",
+        ".watchr"
+      ],
+      filenames: [
+        ".irbrc",
+        ".pryrc",
+        ".simplecov",
+        "Appraisals",
+        "Berksfile",
+        "Brewfile",
+        "Buildfile",
+        "Capfile",
+        "Cheffile",
+        "Dangerfile",
+        "Deliverfile",
+        "Fastfile",
+        "Gemfile",
+        "Guardfile",
+        "Jarfile",
+        "Mavenfile",
+        "Podfile",
+        "Puppetfile",
+        "Rakefile",
+        "Snapfile",
+        "Thorfile",
+        "Vagabondfile",
+        "Vagrantfile",
+        "buildfile"
+      ],
+      interpreters: ["jruby", "macruby", "rake", "rbx", "ruby"],
+      linguistLanguageId: 326,
+      vscodeLanguageIds: ["ruby"]
+    },
+    {
+      name: "RBS",
+      parsers: ["rbs"],
+      extensions: [".rbs"]
+    },
+    {
+      name: "HAML",
+      parsers: ["haml"],
+      extensions: [".haml"],
+      vscodeLanguageIds: ["haml"]
+    }
+  ],
+  parsers: {
+    ruby: {
+      parse(text, _parsers, opts) {
+        return parseSync("ruby", text, opts);
+      },
+      astFormat: "ruby",
+      hasPragma(text) {
+        return /^\s*#[^\S\n]*@(?:prettier|format)\s*?(?:\n|$)/m.test(text);
+      },
+      locStart() {
+        return 0;
+      },
+      locEnd() {
+        return 0;
+      }
+    },
+    rbs: {
+      parse(text, _parsers, opts) {
+        return parseSync("rbs", text, opts);
+      },
+      astFormat: "rbs",
+      hasPragma(text) {
+        return /^\s*#[^\S\n]*@(prettier|format)\s*(\n|$)/.test(text);
+      },
+      locStart() {
+        return 0;
+      },
+      locEnd() {
+        return 0;
+      }
+    },
+    haml: {
+      parse(text, _parsers, opts) {
+        return parseSync("haml", text, opts);
+      },
+      astFormat: "haml",
+      hasPragma(text) {
+        return /^\s*-#\s*@(prettier|format)/.test(text);
+      },
+      locStart() {
+        return 0;
+      },
+      locEnd() {
+        return 0;
+      }
+    }
+  },
+  printers: {
+    ruby: {
+      print(path) {
+        return path.getValue();
+      },
+      insertPragma(text) {
+        return `# @format${text.startsWith("#") ? "\n" : "\n\n"}${text}`;
+      }
+    },
+    rbs: {
+      print(path) {
+        return path.getValue();
+      },
+      insertPragma(text) {
+        return `# @format${text.startsWith("#") ? "\n" : "\n\n"}${text}`;
+      }
+    },
+    haml: {
+      print(path) {
+        return path.getValue();
+      },
+      insertPragma(text) {
+        return `-# @format${text.startsWith("-#") ? "\n" : "\n\n"}${text}`;
+      }
+    }
+  },
+  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
+  }
+};
+
+module.exports = plugin;

data/{dist/parser → src}/server.rb

@@ -1,29 +1,33 @@
 # frozen_string_literal: true
 
-require 'bundler/setup' if ENV['PLUGIN_RUBY_CI']
-require 'socket'
-require 'json'
-require 'fileutils'
-require 'open3'
-
-# Ensure the parent module is defined before requiring the parsers.
-module Prettier
-end
+require "bundler/setup"
+require "socket"
+require "json"
+require "fileutils"
+require "open3"
+
+require "syntax_tree"
+require "syntax_tree/haml"
+require "syntax_tree/rbs"
 
-require_relative '../ruby/parser'
-require_relative '../rbs/parser'
-require_relative '../haml/parser'
+# 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
 trap(:INT) { quit = true }
 trap(:TERM) { quit = true }
-trap(:QUIT) { quit = true } if Signal.list.key?('QUIT')
+
+if Signal.list.key?("QUIT") && RUBY_ENGINE != "jruby"
+  trap(:QUIT) { quit = true }
+end
 
 # The information variable stores the actual connection information, which will
 # either be an IP address and port or a path to a unix socket file.
-information = ''
+information = ""
 
 # The candidates array is a list of potential programs that could be used to
 # connect to our server. We'll run through them after the server starts to find
@@ -33,7 +37,7 @@ candidates = []
 if Gem.win_platform?
   # If we're on windows, we're going to start up a TCP server. The 0 here means
   # to bind to some available port.
-  server = TCPServer.new('127.0.0.1', 0)
+  server = TCPServer.new("127.0.0.1", 0)
   address = server.local_address
 
   # Ensure that we close the server when this process exits.
@@ -55,7 +59,7 @@ else
   end
 
   information = server.local_address.unix_path
-  candidates = ['nc -w 3 -U', 'ncat -w 3 -U']
+  candidates = ["nc -w 3 -U", "ncat -w 3 -U"]
 end
 
 # This is the actual listening thread that will be acting as our server. We have
@@ -69,26 +73,41 @@ 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, source = socket.read.force_encoding("UTF-8").split("|", 2)
+
+        source.each_line do |line|
+          case line
+          when /^\s*#.+?coding/
+            # If we've found an encoding comment, then we're going to take that
+            # into account and reclassify the encoding for the source.
+            encoding = Ripper.new(line).tap(&:parse).encoding
+            source = source.force_encoding(encoding)
+            break
+          when /^\s*#/
+            # continue
+          else
+            break
+          end
+        end
 
         response =
           case parser
-          when 'ping'
-            'pong'
-          when 'ruby'
-            SyntaxTree.parse(source)
-          when 'rbs'
-            Prettier::RBSParser.parse(source)
-          when 'haml'
-            Prettier::HAMLParser.parse(source)
+          when "ping"
+            "pong"
+          when "ruby"
+            SyntaxTree.format(source)
+          when "rbs"
+            SyntaxTree::RBS.format(source)
+          when "haml"
+            SyntaxTree::Haml.format(source)
           end
 
         if response
-          socket.write(JSON.fast_generate(response))
+          socket.write(JSON.fast_generate(response.force_encoding("UTF-8")))
         else
-          socket.write('{ "error": true }')
+          socket.write("{ \"error\": true }")
         end
-      rescue SyntaxTree::ParseError => error
+      rescue SyntaxTree::Parser::ParseError => error
         loc = { start: { line: error.lineno, column: error.column } }
         socket.write(JSON.fast_generate(error: error.message, loc: loc))
       rescue StandardError => error
@@ -118,9 +137,9 @@ candidates.map! do |candidate|
 
     # We do not care about stderr here, so throw it away
     stdout, _stderr, status =
-      Open3.capture3("#{candidate} #{information}", stdin_data: 'ping')
+      Open3.capture3("#{candidate} #{information}", stdin_data: "ping")
 
-    candidate if JSON.parse(stdout) == 'pong' && status.exitstatus == 0
+    candidate if JSON.parse(stdout) == "pong" && status.exitstatus == 0
   rescue StandardError
     # We don't actually care if this fails, because we'll just skip that
     # connection option.
@@ -136,7 +155,7 @@ prefix =
 
 # Default to running the netcat.js script that we ship with the plugin. It's a
 # good fallback as it will always work, but it is slower than the other options.
-prefix ||= "node #{File.expand_path('netcat.js', __dir__)}"
+prefix ||= "node #{File.expand_path("netcat.js", __dir__)}"
 
 # Write out our connection information to the file given as the first argument
 # to this script.

metadata

@@ -1,15 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: prettier
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Kevin Newton
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-05 00:00:00.000000000 Z
-dependencies: []
+date: 2022-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: syntax_tree
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+- !ruby/object:Gem::Dependency
+  name: syntax_tree-haml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: syntax_tree-rbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email:
 executables:
@@ -22,79 +106,6 @@ files:
 - CONTRIBUTING.md
 - LICENSE
 - README.md
-- bin/console
-- dist/haml/embed.js
-- dist/haml/parser.js
-- dist/haml/parser.rb
-- dist/haml/printer.js
-- dist/parser/getInfo.js
-- dist/parser/netcat.js
-- dist/parser/parseSync.js
-- dist/parser/server.rb
-- dist/plugin.js
-- dist/prettier.js
-- dist/rbs/parser.js
-- dist/rbs/parser.rb
-- dist/rbs/printer.js
-- dist/ruby/embed.js
-- dist/ruby/location.js
-- dist/ruby/nodes.js
-- dist/ruby/nodes/alias.js
-- dist/ruby/nodes/aref.js
-- dist/ruby/nodes/args.js
-- dist/ruby/nodes/arrays.js
-- dist/ruby/nodes/assign.js
-- dist/ruby/nodes/blocks.js
-- dist/ruby/nodes/calls.js
-- dist/ruby/nodes/case.js
-- dist/ruby/nodes/class.js
-- dist/ruby/nodes/commands.js
-- dist/ruby/nodes/conditionals.js
-- dist/ruby/nodes/constants.js
-- dist/ruby/nodes/flow.js
-- dist/ruby/nodes/hashes.js
-- dist/ruby/nodes/heredocs.js
-- dist/ruby/nodes/hooks.js
-- dist/ruby/nodes/ints.js
-- dist/ruby/nodes/lambdas.js
-- dist/ruby/nodes/loops.js
-- dist/ruby/nodes/massign.js
-- dist/ruby/nodes/methods.js
-- dist/ruby/nodes/operators.js
-- dist/ruby/nodes/params.js
-- dist/ruby/nodes/patterns.js
-- dist/ruby/nodes/regexp.js
-- dist/ruby/nodes/rescue.js
-- dist/ruby/nodes/return.js
-- dist/ruby/nodes/statements.js
-- dist/ruby/nodes/strings.js
-- dist/ruby/nodes/super.js
-- dist/ruby/nodes/undef.js
-- dist/ruby/parser.js
-- dist/ruby/parser.rb
-- dist/ruby/printer.js
-- dist/ruby/toProc.js
-- dist/types.js
-- dist/types/haml.js
-- dist/types/plugin.js
-- dist/types/rbs.js
-- dist/types/ruby.js
-- dist/types/utils.js
-- dist/utils.js
-- dist/utils/containsAssignment.js
-- dist/utils/getChildNodes.js
-- dist/utils/getTrailingComma.js
-- dist/utils/hasAncestor.js
-- dist/utils/inlineEnsureParens.js
-- dist/utils/isEmptyBodyStmt.js
-- dist/utils/isEmptyParams.js
-- dist/utils/isEmptyStmts.js
-- dist/utils/literal.js
-- dist/utils/literallineWithoutBreakParent.js
-- dist/utils/makeCall.js
-- dist/utils/noIndent.js
-- dist/utils/printEmptyCollection.js
-- dist/utils/skipAssignIndent.js
 - exe/rbprettier
 - lib/prettier.rb
 - lib/prettier/rake/task.rb
@@ -118,6 +129,11 @@ files:
 - node_modules/prettier/third-party.js
 - package.json
 - rubocop.yml
+- src/getInfo.js
+- src/netcat.js
+- src/parseSync.js
+- src/plugin.js
+- src/server.rb
 homepage: https://github.com/prettier/plugin-ruby#readme
 licenses:
 - MIT
@@ -130,14 +146,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.0.dev
 signing_key:
 specification_version: 4
 summary: prettier plugin for the Ruby programming language

data/bin/console

@@ -1,7 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'bundler/setup'
-require 'prettier'
-
-require 'irb'
-IRB.start(__FILE__)

data/dist/haml/embed.js

@@ -1,53 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const prettier_1 = __importDefault(require("../prettier"));
-const { hardline, indent, literalline, markAsRoot, mapDoc, stripTrailingHardline } = prettier_1.default;
-// This function is in here because it handles embedded parser values. I don't
-// have a test that exercises it because I'm not sure for which parser it is
-// necessary, but since it's in prettier core I'm keeping it here.
-/* istanbul ignore next */
-function replaceNewlines(doc) {
-    return mapDoc(doc, (currentDoc) => typeof currentDoc === "string" && currentDoc.includes("\n")
-        ? currentDoc.split(/(\n)/g).map((v, i) => (i % 2 === 0 ? v : literalline))
-        : currentDoc);
-}
-const embed = (path, _print, textToDoc, opts) => {
-    const node = path.getValue();
-    // We're only going to embed other languages on filter nodes.
-    if (node.type !== "filter") {
-        return null;
-    }
-    let parser = node.value.name;
-    // We don't want to deal with some weird recursive parser situation, so we
-    // need to explicitly call out the HAML parser here and just return null.
-    if (parser === "haml") {
-        return null;
-    }
-    // In HAML the name of the JS filter is :javascript, whereas in prettier the
-    // name of the JS parser is babel. Here we explicitly handle that conversion.
-    if (parser === "javascript") {
-        parser = "babel";
-    }
-    // If there aren't any plugins that look like the name of the filter, then we
-    // will just exit early.
-    if (!opts.plugins.some((plugin) => typeof plugin !== "string" &&
-        plugin.parsers &&
-        Object.prototype.hasOwnProperty.call(plugin.parsers, parser))) {
-        return null;
-    }
-    // If there is a plugin that has a parser that matches the name of this
-    // filter, then we're going to assume that's correct for embedding and go
-    // ahead and switch to that parser.
-    return markAsRoot([
-        ":",
-        node.value.name,
-        indent([
-            hardline,
-            replaceNewlines(stripTrailingHardline(textToDoc(node.value.text, { parser })))
-        ])
-    ]);
-};
-exports.default = embed;

data/dist/haml/parser.js

@@ -1,31 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const parseSync_1 = __importDefault(require("../parser/parseSync"));
-const parser = {
-    // This function is responsible for taking an input string of text and
-    // returning to prettier a JavaScript object that is the equivalent AST that
-    // represents the code stored in that string. We accomplish this by spawning a
-    // new process and reading JSON off STDOUT.
-    parse(text) {
-        return (0, parseSync_1.default)("haml", text);
-    },
-    astFormat: "haml",
-    // This function handles checking whether or not the source string has the
-    // pragma for prettier. This is an optional workflow for incremental adoption.
-    hasPragma(text) {
-        return /^\s*-#\s*@(prettier|format)/.test(text);
-    },
-    // These functions are just placeholders until we can actually perform this
-    // properly. The functions are necessary otherwise the format with cursor
-    // functions break.
-    locStart() {
-        return 0;
-    },
-    locEnd() {
-        return 0;
-    }
-};
-exports.default = parser;