@prettier/plugin-php 0.20.0 → 0.21.0

package/src/util.js

@@ -1,40 +1,7 @@
-"use strict";
-
-const {
-  hasNewline,
-  skipEverythingButNewLine,
-  skipNewline,
-  isNextLineEmpty: _isNextLineEmpty,
-  isPreviousLineEmpty: _isPreviousLineEmpty,
-  getNextNonSpaceNonCommentCharacterIndex:
-    _getNextNonSpaceNonCommentCharacterIndex,
-} = require("prettier").util;
-
-const prettierVersion = require("prettier").version;
-
-function lookupIfPrettier2(options, prop) {
-  return parseInt(prettierVersion[0]) > 1 ? options[prop] : options;
-}
+import { util as prettierUtil } from "prettier";
+import { locStart } from "./loc.js";
 
-function isPreviousLineEmpty(text, node, options) {
-  return _isPreviousLineEmpty(
-    text,
-    node,
-    lookupIfPrettier2(options, "locStart")
-  );
-}
-
-function isNextLineEmpty(text, node, options) {
-  return _isNextLineEmpty(text, node, lookupIfPrettier2(options, "locEnd"));
-}
-
-function getNextNonSpaceNonCommentCharacterIndex(text, node, options) {
-  return _getNextNonSpaceNonCommentCharacterIndex(
-    text,
-    node,
-    lookupIfPrettier2(options, "locEnd")
-  );
-}
+const { hasNewline, skipEverythingButNewLine, skipNewline } = prettierUtil;
 
 function printNumber(rawNumber) {
   return (
@@ -54,49 +21,47 @@ function printNumber(rawNumber) {
 }
 
 // http://php.net/manual/en/language.operators.precedence.php
-const PRECEDENCE = {};
-[
-  ["or"],
-  ["xor"],
-  ["and"],
+const PRECEDENCE = new Map(
   [
-    "=",
-    "+=",
-    "-=",
-    "*=",
-    "**=",
-    "/=",
-    ".=",
-    "%=",
-    "&=",
-    "|=",
-    "^=",
-    "<<=",
-    ">>=",
-  ],
-  ["??"],
-  ["||"],
-  ["&&"],
-  ["|"],
-  ["^"],
-  ["&"],
-  ["==", "===", "!=", "!==", "<>", "<=>"],
-  ["<", ">", "<=", ">="],
-  [">>", "<<"],
-  ["+", "-", "."],
-  ["*", "/", "%"],
-  ["!"],
-  ["instanceof"],
-  ["++", "--", "~"],
-  ["**"],
-].forEach((tier, i) => {
-  tier.forEach((op) => {
-    PRECEDENCE[op] = i;
-  });
-});
-
-function getPrecedence(op) {
-  return PRECEDENCE[op];
+    ["or"],
+    ["xor"],
+    ["and"],
+    [
+      "=",
+      "+=",
+      "-=",
+      "*=",
+      "**=",
+      "/=",
+      ".=",
+      "%=",
+      "&=",
+      "|=",
+      "^=",
+      "<<=",
+      ">>=",
+    ],
+    ["??"],
+    ["||"],
+    ["&&"],
+    ["|"],
+    ["^"],
+    ["&"],
+    ["==", "===", "!=", "!==", "<>", "<=>"],
+    ["<", ">", "<=", ">="],
+    [">>", "<<"],
+    ["+", "-", "."],
+    ["*", "/", "%"],
+    ["!"],
+    ["instanceof"],
+    ["++", "--", "~"],
+    ["**"],
+  ].flatMap((operators, index) =>
+    operators.map((operator) => [operator, index])
+  )
+);
+function getPrecedence(operator) {
+  return PRECEDENCE.get(operator);
 }
 
 const equalityOperators = ["==", "!=", "===", "!==", "<>", "<=>"];
@@ -189,14 +154,6 @@ function getNodeListProperty(node) {
   return Array.isArray(body) ? body : null;
 }
 
-function getParentNodeListProperty(path) {
-  const parent = path.getParentNode();
-  if (!parent) {
-    return null;
-  }
-  return getNodeListProperty(parent);
-}
-
 function getLast(arr) {
   if (arr.length > 0) {
     return arr[arr.length - 1];
@@ -211,17 +168,8 @@ function getPenultimate(arr) {
   return null;
 }
 
-function isLastStatement(path) {
-  const body = getParentNodeListProperty(path);
-  if (!body) {
-    return true;
-  }
-  const node = path.getValue();
-  return body[body.length - 1] === node;
-}
-
 function isFirstChildrenInlineNode(path) {
-  const node = path.getValue();
+  const { node } = path;
 
   if (node.kind === "program") {
     const children = getNodeListProperty(node);
@@ -377,8 +325,7 @@ function docShouldHaveTrailingNewline(path, recurse = 0) {
 }
 
 function lineShouldEndWithSemicolon(path) {
-  const node = path.getValue();
-  const parentNode = path.getParentNode();
+  const { node, parent: parentNode } = path;
   if (!parentNode) {
     return false;
   }
@@ -407,7 +354,7 @@ function lineShouldEndWithSemicolon(path) {
     return true;
   }
   if (node.kind === "method") {
-    const parent = path.getParentNode();
+    const { parent } = path;
     if (parent && parent.kind === "interface") {
       return true;
     }
@@ -435,7 +382,7 @@ function lineShouldEndWithSemicolon(path) {
 }
 
 function fileShouldEndWithHardline(path) {
-  const node = path.getValue();
+  const { node } = path;
   const isProgramNode = node.kind === "program";
   const lastNode = node.children && getLast(node.children);
 
@@ -477,14 +424,6 @@ function hasDanglingComments(node) {
   );
 }
 
-function hasLeadingComment(node) {
-  return node.comments && node.comments.some((comment) => comment.leading);
-}
-
-function hasTrailingComment(node) {
-  return node.comments && node.comments.some((comment) => comment.trailing);
-}
-
 function isLookupNode(node) {
   return (
     node.kind === "propertylookup" ||
@@ -495,7 +434,7 @@ function isLookupNode(node) {
 }
 
 function shouldPrintHardLineAfterStartInControlStructure(path) {
-  const node = path.getValue();
+  const { node } = path;
 
   if (["try", "catch"].includes(node.kind)) {
     return false;
@@ -505,7 +444,7 @@ function shouldPrintHardLineAfterStartInControlStructure(path) {
 }
 
 function shouldPrintHardLineBeforeEndInControlStructure(path) {
-  const node = path.getValue();
+  const { node } = path;
 
   if (["try", "catch"].includes(node.kind)) {
     return true;
@@ -543,23 +482,6 @@ function getAlignment(text) {
   return lastLine.length - lastLine.trimLeft().length + 1;
 }
 
-function getNextNode(path, node) {
-  const parent = path.getParentNode();
-  const children = getNodeListProperty(parent);
-
-  if (!children) {
-    return null;
-  }
-
-  const index = children.indexOf(node);
-
-  if (index === -1) {
-    return null;
-  }
-
-  return parent.children[index + 1];
-}
-
 function isProgramLikeNode(node) {
   return ["program", "declare", "namespace"].includes(node.kind);
 }
@@ -606,7 +528,7 @@ function useDoubleQuote(node, options) {
 }
 
 function hasEmptyBody(path, name = "body") {
-  const node = path.getValue();
+  const { node } = path;
 
   return (
     node[name] &&
@@ -616,7 +538,7 @@ function hasEmptyBody(path, name = "body") {
   );
 }
 
-function isNextLineEmptyAfterNamespace(text, node, locStart) {
+function isNextLineEmptyAfterNamespace(text, node) {
   let idx = locStart(node);
   idx = skipEverythingButNewLine(text, idx);
   idx = skipNewline(text, idx);
@@ -676,40 +598,33 @@ const magicMethods = [
   "__clone",
   "__debugInfo",
 ];
-const MagicMethodsMap = magicMethods.reduce((map, obj) => {
-  map[obj.toLowerCase()] = obj;
-
-  return map;
-}, {});
+const magicMethodsMap = new Map(
+  magicMethods.map((name) => [name.toLowerCase(), name])
+);
 
 function normalizeMagicMethodName(name) {
   const loweredName = name.toLowerCase();
 
-  if (MagicMethodsMap[loweredName]) {
-    return MagicMethodsMap[loweredName];
+  if (magicMethodsMap.has(loweredName)) {
+    return magicMethodsMap.get(loweredName);
   }
 
   return name;
 }
 
-module.exports = {
+export {
   printNumber,
   getPrecedence,
   isBitwiseOperator,
   shouldFlatten,
   nodeHasStatement,
-  getNodeListProperty,
-  getParentNodeListProperty,
   getLast,
   getPenultimate,
-  isLastStatement,
   getBodyFirstChild,
   lineShouldEndWithSemicolon,
   fileShouldEndWithHardline,
   maybeStripLeadingSlashFromUse,
   hasDanglingComments,
-  hasLeadingComment,
-  hasTrailingComment,
   docShouldHaveTrailingNewline,
   isLookupNode,
   isFirstChildrenInlineNode,
@@ -725,9 +640,5 @@ module.exports = {
   shouldPrintHardlineBeforeTrailingComma,
   isDocNode,
   getAncestorNode,
-  getNextNode,
   normalizeMagicMethodName,
-  isPreviousLineEmpty,
-  isNextLineEmpty,
-  getNextNonSpaceNonCommentCharacterIndex,
 };