prettier 1.5.4 → 2.0.0.pre.rc1

data/package.json

@@ -1,36 +1,46 @@
 {
   "name": "@prettier/plugin-ruby",
-  "version": "1.5.4",
+  "version": "2.0.0-rc1",
   "description": "prettier plugin for the Ruby programming language",
-  "main": "src/plugin.js",
+  "main": "dist/plugin.js",
   "scripts": {
-    "check-format": "prettier --check '**/*'",
+    "checkFormat": "prettier --check '**/*'",
     "lint": "eslint --cache .",
+    "prepublishOnly": "tsc -p tsconfig.build.json && cp src/parser/getInfo.js dist/parser && cp src/parser/netcat.js dist/parser && cp src/parser/server.rb dist/parser && cp src/haml/parser.rb dist/haml && cp src/rbs/parser.rb dist/rbs && cp src/ruby/parser.rb dist/ruby",
     "test": "jest"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/prettier/plugin-ruby.git"
   },
-  "author": "Kevin Deisz",
+  "author": "Kevin Newton",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/prettier/plugin-ruby/issues"
   },
   "homepage": "https://github.com/prettier/plugin-ruby#readme",
   "dependencies": {
-    "prettier": ">=1.10"
+    "prettier": ">=2.3.0"
   },
   "devDependencies": {
+    "@types/jest": "^27.0.1",
+    "@types/node": "^16.9.1",
+    "@types/prettier": "^2.3.2",
+    "@typescript-eslint/eslint-plugin": "^4.31.2",
+    "@typescript-eslint/parser": "^4.31.2",
     "eslint": "^7.22.0",
     "eslint-config-prettier": "^8.0.0",
-    "husky": "^5.0.9",
-    "jest": "^26.0.0",
-    "pretty-quick": "^3.1.0"
+    "husky": "^7.0.0",
+    "jest": "^27.0.1",
+    "pretty-quick": "^3.1.0",
+    "ts-jest": "^27.0.5",
+    "ts-node": "^10.2.1",
+    "typescript": "^4.4.3"
   },
   "eslintConfig": {
     "extends": [
       "eslint:recommended",
+      "plugin:@typescript-eslint/recommended",
       "prettier"
     ],
     "env": {
@@ -38,23 +48,21 @@
       "jest": true,
       "node": true
     },
+    "parser": "@typescript-eslint/parser",
     "rules": {
-      "no-unused-vars": [
-        "error",
-        {
-          "argsIgnorePattern": "^_",
-          "varsIgnorePattern": "^_"
-        }
-      ]
+      "no-unused-vars": "off",
+      "@typescript-eslint/explicit-module-boundary-types": "off",
+      "@typescript-eslint/no-explicit-any": "off"
     }
   },
   "jest": {
-    "globalSetup": "./test/js/globalSetup.js",
-    "globalTeardown": "./test/js/globalTeardown.js",
+    "globalSetup": "./test/js/globalSetup.ts",
+    "globalTeardown": "./test/js/globalTeardown.ts",
+    "preset": "ts-jest",
     "setupFilesAfterEnv": [
-      "./test/js/setupTests.js"
+      "./test/js/setupTests.ts"
     ],
-    "testRegex": ".test.js$"
+    "testRegex": ".test.ts$"
   },
   "husky": {
     "hooks": {

data/rubocop.yml

@@ -4,6 +4,15 @@
 Layout:
   Enabled: false
 
+# Re-enable Layout/LineLength because certain cops that most projects use
+# (e.g. Style/IfUnlessModifier) require Layout/LineLength to be enabled.
+# By leaving it disabled, those rules will mis-fire.
+#
+# Users can always override these defaults in their own rubocop.yml files.
+# https://github.com/prettier/plugin-ruby/issues/825
+Layout/LineLength:
+  Enabled: true
+
 # Disabling all of the following options because they could conflict with a
 # prettier configuration setting.
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prettier
 version: !ruby/object:Gem::Version
-  version: 1.5.4
+  version: 2.0.0.pre.rc1
 platform: ruby
 authors:
-- Kevin Deisz
+- Kevin Newton
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-17 00:00:00.000000000 Z
+date: 2021-09-30 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -23,88 +23,97 @@ files:
 - 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/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/getTrailingComma.js
+- dist/utils/hasAncestor.js
+- dist/utils/inlineEnsureParens.js
+- dist/utils/isEmptyBodyStmt.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
 - node_modules/prettier/bin-prettier.js
+- node_modules/prettier/doc.js
 - node_modules/prettier/index.js
+- node_modules/prettier/package.json
+- node_modules/prettier/parser-angular.js
+- node_modules/prettier/parser-babel.js
+- node_modules/prettier/parser-espree.js
+- node_modules/prettier/parser-flow.js
+- node_modules/prettier/parser-glimmer.js
+- node_modules/prettier/parser-graphql.js
+- node_modules/prettier/parser-html.js
+- node_modules/prettier/parser-markdown.js
+- node_modules/prettier/parser-meriyah.js
+- node_modules/prettier/parser-postcss.js
+- node_modules/prettier/parser-typescript.js
+- node_modules/prettier/parser-yaml.js
 - node_modules/prettier/third-party.js
 - 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
-- src/parser/getLang.js
-- src/parser/getNetcat.js
-- src/parser/netcat.js
-- src/parser/parseSync.js
-- src/parser/requestParse.js
-- src/parser/server.rb
-- src/plugin.js
-- src/prettier.js
-- src/rbs/parser.js
-- src/rbs/parser.rb
-- src/rbs/printer.js
-- src/ruby/embed.js
-- src/ruby/nodes.js
-- src/ruby/nodes/alias.js
-- src/ruby/nodes/aref.js
-- src/ruby/nodes/args.js
-- src/ruby/nodes/arrays.js
-- src/ruby/nodes/assign.js
-- src/ruby/nodes/blocks.js
-- src/ruby/nodes/calls.js
-- src/ruby/nodes/case.js
-- src/ruby/nodes/class.js
-- src/ruby/nodes/commands.js
-- src/ruby/nodes/conditionals.js
-- src/ruby/nodes/constants.js
-- src/ruby/nodes/flow.js
-- src/ruby/nodes/hashes.js
-- src/ruby/nodes/heredocs.js
-- src/ruby/nodes/hooks.js
-- src/ruby/nodes/ints.js
-- src/ruby/nodes/lambdas.js
-- src/ruby/nodes/loops.js
-- src/ruby/nodes/massign.js
-- src/ruby/nodes/methods.js
-- src/ruby/nodes/operators.js
-- src/ruby/nodes/params.js
-- src/ruby/nodes/patterns.js
-- src/ruby/nodes/regexp.js
-- src/ruby/nodes/rescue.js
-- src/ruby/nodes/return.js
-- src/ruby/nodes/statements.js
-- src/ruby/nodes/strings.js
-- src/ruby/nodes/super.js
-- src/ruby/nodes/undef.js
-- src/ruby/parser.js
-- src/ruby/parser.rb
-- src/ruby/printer.js
-- src/ruby/toProc.js
-- src/utils.js
-- src/utils/containsAssignment.js
-- src/utils/getTrailingComma.js
-- src/utils/hasAncestor.js
-- src/utils/inlineEnsureParens.js
-- src/utils/isEmptyBodyStmt.js
-- src/utils/isEmptyStmts.js
-- src/utils/literal.js
-- src/utils/literallineWithoutBreakParent.js
-- src/utils/makeCall.js
-- src/utils/noIndent.js
-- src/utils/printEmptyCollection.js
-- src/utils/skipAssignIndent.js
 homepage: https://github.com/prettier/plugin-ruby#readme
 licenses:
 - MIT
@@ -120,9 +129,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.2.3
 signing_key:

data/src/haml/embed.js

@@ -1,87 +0,0 @@
-const {
-  concat,
-  hardline,
-  indent,
-  literalline,
-  markAsRoot,
-  mapDoc,
-  stripTrailingHardline
-} = require("../prettier");
-
-// Get the name of the parser that is represented by the given element node,
-// return null if a matching parser cannot be found
-function getParser(name, opts) {
-  let parser = 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 is a plugin that has a parser that matches the name of this
-  // element, then we're going to assume that's correct for embedding and go
-  // ahead and switch to that parser
-  if (
-    opts.plugins.some(
-      (plugin) =>
-        plugin.parsers &&
-        Object.prototype.hasOwnProperty.call(plugin.parsers, parser)
-    )
-  ) {
-    return parser;
-  }
-
-  return null;
-}
-
-// 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")
-      ? concat(
-          currentDoc
-            .split(/(\n)/g)
-            .map((v, i) => (i % 2 === 0 ? v : literalline))
-        )
-      : currentDoc
-  );
-}
-
-function embed(path, _print, textToDoc, opts) {
-  const node = path.getValue();
-  if (node.type !== "filter") {
-    return null;
-  }
-
-  const parser = getParser(node.value.name, opts);
-  if (!parser) {
-    return null;
-  }
-
-  return markAsRoot(
-    concat([
-      ":",
-      node.value.name,
-      indent(
-        concat([
-          hardline,
-          replaceNewlines(
-            stripTrailingHardline(textToDoc(node.value.text, { parser }))
-          )
-        ])
-      )
-    ])
-  );
-}
-
-module.exports = embed;

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;