prettier 1.5.5 → 1.6.0

data/src/ruby/parser.js

@@ -8,12 +8,10 @@ function parse(text, _parsers, opts) {
   return parseSync("ruby", text, opts);
 }
 
-const pragmaPattern = /#\s*@(prettier|format)/;
-
 // This function handles checking whether or not the source string has the
 // pragma for prettier. This is an optional workflow for incremental adoption.
 function hasPragma(text) {
-  return pragmaPattern.test(text);
+  return /^\s*#[^\S\n]*@(format|prettier)\s*(\n|$)/.test(text);
 }
 
 // This function is critical for comments and cursor support, and is responsible

data/src/ruby/parser.rb

@@ -13,8 +13,7 @@ if (RUBY_MAJOR < 2) || ((RUBY_MAJOR == 2) && (RUBY_MINOR < 5))
   exit 1
 end
 
-require 'delegate'
-require 'json'
+require 'json' unless defined?(JSON)
 require 'ripper'
 
 module Prettier
@@ -54,6 +53,35 @@ class Prettier::Parser < Ripper
     end
   end
 
+  # This is a small wrapper around the value of a node for those specific events
+  # that need extra handling. (For example: statement, body statement, and
+  # rescue nodes which all need extra information to determine their character
+  # boundaries.)
+  class Node
+    attr_reader :parser, :value
+
+    def initialize(parser, value)
+      @parser = parser
+      @value = value
+    end
+
+    def [](key)
+      value[key]
+    end
+
+    def dig(*keys)
+      value.dig(*keys)
+    end
+
+    def to_json(*opts)
+      value.to_json(*opts)
+    end
+
+    def pretty_print(q)
+      q.pp_hash(self)
+    end
+  end
+
   attr_reader :source, :lines, :scanner_events
 
   # This is an attr_accessor so Stmts objects can grab comments out of this
@@ -617,19 +645,19 @@ class Prettier::Parser < Ripper
   # bodystmt can't actually determine its bounds appropriately because it
   # doesn't necessarily know where it started. So the parent node needs to
   # report back down into this one where it goes.
-  class BodyStmt < SimpleDelegator
+  class BodyStmt < Node
     def bind(sc, ec)
-      merge!(sc: sc, ec: ec)
-      parts = self[:body]
+      value.merge!(sc: sc, ec: ec)
+      parts = value[:body]
 
       # Here we're going to determine the bounds for the stmts
       consequent = parts[1..-1].compact.first
-      self[:body][0].bind(sc, consequent ? consequent[:sc] : ec)
+      value[:body][0].bind(sc, consequent ? consequent[:sc] : ec)
 
       # Next we're going to determine the rescue clause if there is one
       if parts[1]
         consequent = parts[2..-1].compact.first
-        self[:body][1].bind_end(consequent ? consequent[:sc] : ec)
+        value[:body][1].bind_end(consequent ? consequent[:sc] : ec)
       end
     end
   end
@@ -638,6 +666,7 @@ class Prettier::Parser < Ripper
   # of clauses within the body of a method or block.
   def on_bodystmt(stmts, rescued, ensured, elsed)
     BodyStmt.new(
+      self,
       type: :bodystmt,
       body: [stmts, rescued, ensured, elsed],
       sl: lineno,
@@ -1063,7 +1092,7 @@ class Prettier::Parser < Ripper
 
       beging.merge(
         type: :dyna_symbol,
-        quote: beging[:body][1],
+        quote: beging[:body],
         body: string[:body],
         el: ending[:el],
         ec: ending[:ec]
@@ -1845,12 +1874,12 @@ class Prettier::Parser < Ripper
   # doesn't really have all of the information that it needs in order to
   # determine its ending. Therefore it relies on its parent bodystmt node to
   # report its ending to it.
-  class Rescue < SimpleDelegator
+  class Rescue < Node
     def bind_end(ec)
-      merge!(ec: ec)
+      value.merge!(ec: ec)
 
-      stmts = self[:body][1]
-      consequent = self[:body][2]
+      stmts = value[:body][1]
+      consequent = value[:body][2]
 
       if consequent
         consequent.bind_end(ec)
@@ -1886,6 +1915,7 @@ class Prettier::Parser < Ripper
       end
 
     Rescue.new(
+      self,
       beging.merge!(
         type: :rescue,
         body: [rescue_ex, stmts, consequent],
@@ -1986,36 +2016,29 @@ class Prettier::Parser < Ripper
   # stmts nodes will report back down the location information. We then
   # propagate that onto void_stmt nodes inside the stmts in order to make sure
   # all comments get printed appropriately.
-  class Stmts < SimpleDelegator
-    attr_reader :parser
-
-    def initialize(parser, values)
-      @parser = parser
-      __setobj__(values)
-    end
-
+  class Stmts < Node
     def bind(sc, ec)
-      merge!(sc: sc, ec: ec)
+      value.merge!(sc: sc, ec: ec)
 
-      if self[:body][0][:type] == :void_stmt
-        self[:body][0].merge!(sc: sc, ec: sc)
+      if value[:body][0][:type] == :void_stmt
+        value[:body][0].merge!(sc: sc, ec: sc)
       end
 
       attach_comments(sc, ec)
     end
 
     def bind_end(ec)
-      merge!(ec: ec)
+      value.merge!(ec: ec)
     end
 
     def <<(statement)
-      if self[:body].any?
-        merge!(statement.slice(:el, :ec))
+      if value[:body].any?
+        value.merge!(statement.slice(:el, :ec))
       else
-        merge!(statement.slice(:sl, :el, :sc, :ec))
+        value.merge!(statement.slice(:sl, :el, :sc, :ec))
       end
 
-      self[:body] << statement
+      value[:body] << statement
       self
     end
 
@@ -2032,7 +2055,7 @@ class Prettier::Parser < Ripper
       return if attachable.empty?
 
       parser.comments -= attachable
-      self[:body] = (self[:body] + attachable).sort_by! { |node| node[:sc] }
+      value[:body] = (value[:body] + attachable).sort_by! { |node| node[:sc] }
     end
   end
 

data/src/ruby/printer.js

@@ -127,6 +127,14 @@ function isBlockComment(comment) {
   return comment.type === "@embdoc";
 }
 
+// This function handles adding the format pragma to a source string. This is an
+// optional workflow for incremental adoption.
+function insertPragma(text) {
+  const boundary = text.startsWith("#") ? "\n" : "\n\n";
+
+  return `# @format${boundary}${text}`;
+}
+
 module.exports = {
   embed,
   print: printNode,
@@ -134,5 +142,6 @@ module.exports = {
   canAttachComment,
   getCommentChildNodes,
   printComment,
-  isBlockComment
+  isBlockComment,
+  insertPragma
 };

data/src/utils/inlineEnsureParens.js

@@ -2,6 +2,7 @@ const needsParens = [
   "args",
   "assign",
   "assoc_new",
+  "binary",
   "call",
   "massign",
   "opassign"

data/src/utils/skipAssignIndent.js

@@ -1,4 +1,11 @@
-const skippable = ["array", "hash", "heredoc", "lambda", "regexp_literal"];
+const skippable = [
+  "array",
+  "dyna_symbol",
+  "hash",
+  "heredoc",
+  "lambda",
+  "regexp_literal"
+];
 
 function skipAssignIndent(node) {
   return (

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prettier
 version: !ruby/object:Gem::Version
-  version: 1.5.5
+  version: 1.6.0
 platform: ruby
 authors:
 - Kevin Deisz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-25 00:00:00.000000000 Z
+date: 2021-06-23 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -44,15 +44,6 @@ files:
 - package.json
 - rubocop.yml
 - src/haml/embed.js
-- src/haml/nodes/comment.js
-- src/haml/nodes/doctype.js
-- src/haml/nodes/filter.js
-- src/haml/nodes/hamlComment.js
-- src/haml/nodes/plain.js
-- src/haml/nodes/root.js
-- src/haml/nodes/script.js
-- src/haml/nodes/silentScript.js
-- src/haml/nodes/tag.js
 - src/haml/parser.js
 - src/haml/parser.rb
 - src/haml/printer.js
@@ -133,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: prettier plugin for the Ruby programming language

data/src/haml/nodes/comment.js

@@ -1,27 +0,0 @@
-const { concat, group, hardline, indent, join } = require("../../prettier");
-
-// https://haml.info/docs/yardoc/file.REFERENCE.html#html-comments-
-function comment(path, _opts, print) {
-  const { children, value } = path.getValue();
-  const parts = ["/"];
-
-  if (value.revealed) {
-    parts.push("!");
-  }
-
-  if (value.conditional) {
-    parts.push(value.conditional);
-  } else if (value.text) {
-    parts.push(" ", value.text);
-  }
-
-  if (children.length > 0) {
-    parts.push(
-      indent(concat([hardline, join(hardline, path.map(print, "children"))]))
-    );
-  }
-
-  return group(concat(parts));
-}
-
-module.exports = comment;

data/src/haml/nodes/doctype.js

@@ -1,34 +0,0 @@
-const { join } = require("../../prettier");
-
-const types = {
-  basic: "Basic",
-  frameset: "Frameset",
-  mobile: "Mobile",
-  rdfa: "RDFa",
-  strict: "Strict",
-  xml: "XML"
-};
-
-const versions = ["1.1", "5"];
-
-// https://haml.info/docs/yardoc/file.REFERENCE.html#doctype-
-function doctype(path, _opts, _print) {
-  const { value } = path.getValue();
-  const parts = ["!!!"];
-
-  if (value.type in types) {
-    parts.push(types[value.type]);
-  } else if (versions.includes(value.version)) {
-    parts.push(value.version);
-  } else {
-    parts.push(value.type);
-  }
-
-  if (value.encoding) {
-    parts.push(value.encoding);
-  }
-
-  return join(" ", parts);
-}
-
-module.exports = doctype;

data/src/haml/nodes/filter.js

@@ -1,16 +0,0 @@
-const { concat, group, hardline, indent, join } = require("../../prettier");
-
-// https://haml.info/docs/yardoc/file.REFERENCE.html#filters
-function filter(path, _opts, _print) {
-  const { value } = path.getValue();
-
-  return group(
-    concat([
-      ":",
-      value.name,
-      indent(concat([hardline, join(hardline, value.text.trim().split("\n"))]))
-    ])
-  );
-}
-
-module.exports = filter;

data/src/haml/nodes/hamlComment.js

@@ -1,21 +0,0 @@
-const { concat, hardline, indent, join } = require("../../prettier");
-
-// https://haml.info/docs/yardoc/file.REFERENCE.html#haml-comments--
-function hamlComment(path, opts, _print) {
-  const node = path.getValue();
-  const parts = ["-#"];
-
-  if (node.value.text) {
-    if (opts.originalText.split("\n")[node.line - 1].trim() === "-#") {
-      const lines = node.value.text.trim().split("\n");
-
-      parts.push(indent(concat([hardline, join(hardline, lines)])));
-    } else {
-      parts.push(" ", node.value.text.trim());
-    }
-  }
-
-  return concat(parts);
-}
-
-module.exports = hamlComment;

data/src/haml/nodes/plain.js

@@ -1,6 +0,0 @@
-// https://haml.info/docs/yardoc/file.REFERENCE.html#plain-text
-function plain(path, _opts, _print) {
-  return path.getValue().value.text;
-}
-
-module.exports = plain;

data/src/haml/nodes/root.js

@@ -1,8 +0,0 @@
-const { concat, hardline, join } = require("../../prettier");
-
-// The root node in the AST
-function root(path, _opts, print) {
-  return concat([join(hardline, path.map(print, "children")), hardline]);
-}
-
-module.exports = root;

data/src/haml/nodes/script.js

@@ -1,33 +0,0 @@
-const { concat, group, hardline, indent, join } = require("../../prettier");
-
-// https://haml.info/docs/yardoc/file.REFERENCE.html#inserting_ruby
-function script(path, opts, print) {
-  const { children, value } = path.getValue();
-  const parts = [];
-
-  if (value.escape_html) {
-    parts.unshift("&");
-  }
-
-  if (value.preserve) {
-    parts.push("~");
-  } else if (!value.interpolate) {
-    parts.push("=");
-  }
-
-  if (value.escape_html && !value.preserve && value.interpolate) {
-    parts.push(" ", value.text.trim().slice(1, -1));
-  } else {
-    parts.push(" ", value.text.trim());
-  }
-
-  if (children.length > 0) {
-    parts.push(
-      indent(concat([hardline, join(hardline, path.map(print, "children"))]))
-    );
-  }
-
-  return group(concat(parts));
-}
-
-module.exports = script;

data/src/haml/nodes/silentScript.js

@@ -1,59 +0,0 @@
-const { concat, group, hardline, indent, join } = require("../../prettier");
-
-function findKeywordIndices(children, keywords) {
-  const indices = [];
-
-  children.forEach((child, index) => {
-    if (child.type !== "silent_script") {
-      return;
-    }
-
-    if (keywords.includes(child.value.keyword)) {
-      indices.push(index);
-    }
-  });
-
-  return indices;
-}
-
-// https://haml.info/docs/yardoc/file.REFERENCE.html#running-ruby--
-function silentScript(path, _opts, print) {
-  const { children, value } = path.getValue();
-  const parts = [`- ${value.text.trim()}`];
-
-  if (children.length > 0) {
-    const scripts = path.map(print, "children");
-
-    if (value.keyword === "case") {
-      const keywordIndices = findKeywordIndices(children, ["when", "else"]);
-
-      parts.push(
-        concat(
-          scripts.map((script, index) => {
-            const concated = concat([hardline, script]);
-
-            return keywordIndices.includes(index) ? concated : indent(concated);
-          })
-        )
-      );
-    } else if (["if", "unless"].includes(value.keyword)) {
-      const keywordIndices = findKeywordIndices(children, ["elsif", "else"]);
-
-      parts.push(
-        concat(
-          scripts.map((script, index) => {
-            const concated = concat([hardline, script]);
-
-            return keywordIndices.includes(index) ? concated : indent(concated);
-          })
-        )
-      );
-    } else {
-      parts.push(indent(concat([hardline, join(hardline, scripts)])));
-    }
-  }
-
-  return group(concat(parts));
-}
-
-module.exports = silentScript;