prettier 1.0.0.pre.rc2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 305f0248dc0f0b4ab56d698f04858e3d25df0f91888a203f75740ae5a06a7e0d
-  data.tar.gz: 192eaf1d3cd95a9dc3693c0346f636f53ae2baede4cd3de5d827bd671571daf3
+  metadata.gz: 1738251faac58ab78438da2dcf568a86708d1ccb651d7ec593f0e3c3efc5075a
+  data.tar.gz: 91666c89e8846d9a908883339238dfec94816adb14c8949fe9232590e493c48b
 SHA512:
-  metadata.gz: 33a09aa76044b30dde5aa1555bfabc8f178607335ca0af9e4709d0f9fbfdc437c986097da85cc2d0c411326cb25d0672587a0253016bc89e71ca1245a5cfd652
-  data.tar.gz: b293f495c164808c4372dc79cfa801fd1603fe4907eafb374b61ba171cffbf1aaa09b6e0b1a427bc949099091db790a79d74d56c50f72c3ba006acc718b0065c
+  metadata.gz: d7df78d09da53ada78d9d9a0d3421e279bc0f1593aaff7a099ef397deea85f4fdde3a044ef91bb88f8f5d6a4f91d52d303e912e60f84b946c35528c0c6f139e1
+  data.tar.gz: 95e810fa06b71063a010f8e3e3dd3cf7302e2cf1b3573f8da4b7e7fed9288ecaf4d75cbd6429c4b04dbc31728dc879cf1605c8c104fc130bdbfc30583c837e5b

data/CHANGELOG.md

@@ -6,6 +6,16 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [1.0.0] - 2020-12-11
+
+### Changed
+
+- [@kddeisz] - Do not unescape double quotes in a single quote string.
+- [@kddeisz] - Only force braces on regexp for spaces and equals if it's inside a command or command_call.
+- [@kddeisz] - Leave Sorbet type annotations in place.
+- [@kddeisz] - Don't group hash contents, just allow them to break with their parent node.
+- [@kddeisz] - Honor the UTF-8 lang passed in through ENV vars.
+
 ## [1.0.0-rc2] - 2020-12-10
 
 ### Changed
@@ -252,7 +262,8 @@ will now be printed as:
 ```ruby
 Config::Download.new(
   'prettier',
-  filename: 'prettier.yml', url: 'https://raw.githubusercontent.com/...'
+  filename: 'prettier.yml',
+  url: 'https://raw.githubusercontent.com/...'
 ).perform
 ```
 
@@ -940,7 +951,8 @@ would previously result in `array[]`, but now prints properly.
 
 - Initial release 🎉
 
-[unreleased]: https://github.com/prettier/plugin-ruby/compare/v1.0.0-rc2...HEAD
+[unreleased]: https://github.com/prettier/plugin-ruby/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/prettier/plugin-ruby/compare/v1.0.0-rc2...v1.0.0
 [1.0.0-rc2]: https://github.com/prettier/plugin-ruby/compare/v1.0.0-rc1...v1.0.0-rc2
 [1.0.0-rc1]: https://github.com/prettier/plugin-ruby/compare/v0.22.0...v1.0.0-rc1
 [0.22.0]: https://github.com/prettier/plugin-ruby/compare/v0.21.0...v0.22.0

data/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@prettier/plugin-ruby",
-  "version": "1.0.0-rc2",
+  "version": "1.0.0",
   "description": "prettier plugin for the Ruby programming language",
   "main": "src/ruby.js",
   "scripts": {
+    "check-format": "prettier --check '**/*'",
     "lint": "eslint --cache .",
-    "print": "prettier --plugin=.",
     "test": "jest"
   },
   "repository": {
@@ -25,9 +25,9 @@
     "all-contributors-cli": "^6.14.1",
     "eslint": "^7.8.1",
     "eslint-config-prettier": "^7.0.0",
-    "husky": "^5.0.4",
+    "husky": "^4.3.5",
     "jest": "^26.0.0",
-    "pretty-quick": "^3.0.0"
+    "pretty-quick": "^3.1.0"
   },
   "eslintConfig": {
     "extends": [
@@ -61,6 +61,9 @@
     }
   },
   "prettier": {
-    "trailingComma": "none"
+    "trailingComma": "none",
+    "plugins": [
+      "."
+    ]
   }
 }

data/src/nodes/calls.js

@@ -100,15 +100,44 @@ function printMethodAddArg(path, opts, print) {
   return concat([methodDoc, argsDoc]);
 }
 
-function printMethodAddBlock(path, { rubyToProc }, print) {
+// Sorbet type annotations look like the following:
+//
+//     {method_add_block
+//       [{method_add_arg
+//          [{fcall
+//             [{@ident "sig"}]},
+//           {args []}]},
+//        {brace_block [nil, {stmts}]}}]}
+//
+function isSorbetTypeAnnotation(node) {
+  const [callNode, blockNode] = node.body;
+
+  return (
+    callNode.type === "method_add_arg" &&
+    callNode.body[0].type === "fcall" &&
+    callNode.body[0].body[0].body === "sig" &&
+    callNode.body[1].type === "args" &&
+    callNode.body[1].body.length === 0 &&
+    blockNode.type === "brace_block"
+  );
+}
+
+function printMethodAddBlock(path, opts, print) {
   const node = path.getValue();
 
   const [callNode, blockNode] = node.body;
   const [callDoc, blockDoc] = path.map(print, "body");
 
+  // Very special handling here for sorbet type annotations. They look like Ruby
+  // code, but they're not actually Ruby code, so we're not going to mess with
+  // them at all.
+  if (isSorbetTypeAnnotation(node)) {
+    return opts.originalText.slice(opts.locStart(node), opts.locEnd(node));
+  }
+
   // Don't bother trying to do any kind of fancy toProc transform if the option
   // is disabled.
-  if (rubyToProc) {
+  if (opts.rubyToProc) {
     const proc = toProc(path, blockNode);
 
     if (proc && callNode.type === "call") {

data/src/nodes/hashes.js

@@ -93,32 +93,7 @@ function printHashContents(path, opts, print) {
       ? printHashKeyLabel
       : printHashKeyRocket;
 
-  const contents = join(concat([",", line]), path.map(print, "body"));
-
-  // If we're inside a hash literal, then we want to add the braces at this
-  // level so that the grouping is correct. Otherwise you could end up with
-  // opening and closing braces being split up, but the contents not being split
-  // correctly.
-  if (path.getParentNode().type === "hash") {
-    return group(
-      concat([
-        "{",
-        indent(
-          concat([
-            line,
-            contents,
-            getTrailingComma(opts) ? ifBreak(",", "") : ""
-          ])
-        ),
-        line,
-        "}"
-      ])
-    );
-  }
-
-  // Otherwise, we're inside a bare_assoc_hash, so we don't want to print
-  // braces at all.
-  return group(contents);
+  return join(concat([",", line]), path.map(print, "body"));
 }
 
 function printEmptyHashWithComments(path, opts) {
@@ -129,14 +104,16 @@ function printEmptyHashWithComments(path, opts) {
     return opts.printer.printComment(commentPath);
   };
 
-  return concat([
-    "{",
-    indent(
-      concat([hardline, join(hardline, path.map(printComment, "comments"))])
-    ),
-    line,
-    "}"
-  ]);
+  return group(
+    concat([
+      "{",
+      indent(
+        concat([hardline, join(hardline, path.map(printComment, "comments"))])
+      ),
+      line,
+      "}"
+    ])
+  );
 }
 
 function printHash(path, opts, print) {
@@ -149,7 +126,20 @@ function printHash(path, opts, print) {
     return hashNode.comments ? printEmptyHashWithComments(path, opts) : "{}";
   }
 
-  return path.call(print, "body", 0);
+  return group(
+    concat([
+      "{",
+      indent(
+        concat([
+          line,
+          path.call(print, "body", 0),
+          getTrailingComma(opts) ? ifBreak(",", "") : ""
+        ])
+      ),
+      line,
+      "}"
+    ])
+  );
 }
 
 module.exports = {

data/src/nodes/regexp.js

@@ -1,16 +1,23 @@
 const { concat } = require("../prettier");
+const { hasAncestor } = require("../utils");
 
 function isStringContent(node) {
   return node.type === "@tstring_content";
 }
 
-function shouldUseBraces(node) {
+function shouldUseBraces(path) {
+  const node = path.getValue();
   const first = node.body[0];
 
   // If the first part of this regex is plain string content and we have a
   // space or an =, then we want to use braces because otherwise we could end up
   // with an ambiguous operator, e.g. foo / bar/ or foo /=bar/
-  if (first && isStringContent(first) && [" ", "="].includes(first.body[0])) {
+  if (
+    first &&
+    isStringContent(first) &&
+    [" ", "="].includes(first.body[0]) &&
+    hasAncestor(path, ["command", "command_call"])
+  ) {
     return true;
   }
 
@@ -28,7 +35,7 @@ function shouldUseBraces(node) {
 // itself. In that case we switch over to using %r with braces.
 function printRegexpLiteral(path, opts, print) {
   const node = path.getValue();
-  const useBraces = shouldUseBraces(node);
+  const useBraces = shouldUseBraces(path);
 
   const parts = [useBraces ? "%r{" : "/"]
     .concat(path.map(print, "body"))

data/src/nodes/strings.js

@@ -32,7 +32,7 @@ function isSingleQuotable(node) {
 const quotePattern = new RegExp("\\\\([\\s\\S])|(['\"])", "g");
 
 function normalizeQuotes(content, enclosingQuote, originalQuote) {
-  const replaceOther = ["'", '"'].includes(originalQuote);
+  const replaceOther = originalQuote === '"';
   const otherQuote = enclosingQuote === '"' ? "'" : '"';
 
   // Escape and unescape single and double quotes as needed to be able to

data/src/parser.js

@@ -3,18 +3,33 @@ const path = require("path");
 
 // In order to properly parse ruby code, we need to tell the ruby process to
 // parse using UTF-8. Unfortunately, the way that you accomplish this looks
-// differently depending on your platform. This object below represents all of
-// the possible values of process.platform per:
-//   https://nodejs.org/api/process.html#process_process_platform
-const LANG = {
-  aix: "C.UTF-8",
-  darwin: "en_US.UTF-8",
-  freebsd: "C.UTF-8",
-  linux: "C.UTF-8",
-  openbsd: "C.UTF-8",
-  sunos: "C.UTF-8",
-  win32: ".UTF-8"
-}[process.platform];
+// differently depending on your platform.
+const LANG = (() => {
+  const { env, platform } = process;
+  const envValue = env.LC_ALL || env.LC_CTYPE || env.LANG;
+
+  // If an env var is set for the locale that already includes UTF-8 in the
+  // name, then assume we can go with that.
+  if (envValue && envValue.includes("UTF-8")) {
+    return envValue;
+  }
+
+  // Otherwise, we're going to guess which encoding to use based on the system.
+  // This is probably not the best approach in the world, as you could be on
+  // linux and not have C.UTF-8, but in that case you're probably passing an env
+  // var for it. This object below represents all of the possible values of
+  // process.platform per:
+  // https://nodejs.org/api/process.html#process_process_platform
+  return {
+    aix: "C.UTF-8",
+    darwin: "en_US.UTF-8",
+    freebsd: "C.UTF-8",
+    linux: "C.UTF-8",
+    openbsd: "C.UTF-8",
+    sunos: "C.UTF-8",
+    win32: ".UTF-8"
+  }[platform];
+})();
 
 // 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

data/src/parser.rb

@@ -314,7 +314,9 @@ class Prettier::Parser < Ripper
       arg.merge(type: :args, body: [arg])
     else
       args.merge!(
-        body: args[:body] << arg, end: arg[:end], char_end: arg[:char_end]
+        body: args[:body] << arg,
+        end: arg[:end],
+        char_end: arg[:char_end]
       )
     end
   end
@@ -1186,7 +1188,8 @@ class Prettier::Parser < Ripper
       # Here we're going to expand out the location information for the assocs
       # node so that it can grab up any remaining comments inside the hash.
       assoclist_from_args.merge!(
-        char_start: beging[:char_end], char_end: ending[:char_start]
+        char_start: beging[:char_end],
+        char_end: ending[:char_start]
       )
     end
 
@@ -1448,7 +1451,9 @@ class Prettier::Parser < Ripper
       part.merge(type: :mlhs, body: [part])
     else
       mlhs.merge!(
-        body: mlhs[:body] << part, end: part[:end], char_end: part[:char_end]
+        body: mlhs[:body] << part,
+        end: part[:end],
+        char_end: part[:char_end]
       )
     end
   end
@@ -1551,7 +1556,9 @@ class Prettier::Parser < Ripper
       part.merge(type: :mrhs, body: [part])
     else
       mrhs.merge!(
-        body: mrhs[:body] << part, end: part[:end], char_end: part[:char_end]
+        body: mrhs[:body] << part,
+        end: part[:end],
+        char_end: part[:char_end]
       )
     end
   end
@@ -1960,7 +1967,9 @@ class Prettier::Parser < Ripper
   # piece of the string.
   def on_string_add(string, piece)
     string.merge!(
-      body: string[:body] << piece, end: piece[:end], char_end: piece[:char_end]
+      body: string[:body] << piece,
+      end: piece[:end],
+      char_end: piece[:char_end]
     )
   end
 
@@ -2417,7 +2426,9 @@ class Prettier::Parser < Ripper
       piece.merge(type: :word, body: [piece])
     else
       word.merge!(
-        body: word[:body] << piece, end: piece[:end], char_end: piece[:char_end]
+        body: word[:body] << piece,
+        end: piece[:end],
+        char_end: piece[:char_end]
       )
     end
   end
@@ -2498,7 +2509,9 @@ class Prettier::Parser < Ripper
     else
       ending = find_scanner_event(:@tstring_end)
       xstring.merge!(
-        type: :xstring_literal, end: ending[:end], char_end: ending[:char_end]
+        type: :xstring_literal,
+        end: ending[:end],
+        char_end: ending[:char_end]
       )
     end
   end

metadata

@@ -1,57 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: prettier
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.rc2
+  version: 1.0.0
 platform: ruby
 authors:
 - Kevin Deisz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-10 00:00:00.000000000 Z
-dependencies:
-- !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: '5.13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.13'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
+date: 2020-12-11 00:00:00.000000000 Z
+dependencies: []
 description:
 email:
 executables:
@@ -130,11 +88,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: prettier plugin for the Ruby programming language