@prettier/plugin-php 0.20.0 → 0.21.0

package/src/index.js

@@ -1,12 +1,24 @@
-"use strict";
-
-const parse = require("./parser");
-const print = require("./printer");
-const clean = require("./clean");
-const options = require("./options");
-const comments = require("./comments");
-const { join, hardline } = require("prettier").doc.builders;
-const { hasPragma, insertPragma } = require("./pragma");
+import { doc } from "prettier";
+import {
+  LINGUIST_LANGUAGES_PHP,
+  LINGUIST_LANGUAGES_HTML_PHP,
+} from "./linguist-languages.cjs";
+import parse from "./parser.js";
+import print from "./printer.js";
+import clean from "./clean.js";
+import options from "./options.js";
+import {
+  handleOwnLineComment,
+  handleEndOfLineComment,
+  handleRemainingComment,
+  getCommentChildNodes,
+  canAttachComment,
+  isBlockComment,
+} from "./comments.js";
+import { hasPragma, insertPragma } from "./pragma.js";
+import { locStart, locEnd } from "./loc.js";
+
+const { join, hardline } = doc.builders;
 
 function createLanguage(linguistData, { extend, override }) {
   const language = {};
@@ -30,13 +42,13 @@ function createLanguage(linguistData, { extend, override }) {
 }
 
 const languages = [
-  createLanguage(require("linguist-languages/data/PHP"), {
+  createLanguage(LINGUIST_LANGUAGES_PHP, {
     override: {
       parsers: ["php"],
       vscodeLanguageIds: ["php"],
     },
   }),
-  createLanguage(require("linguist-languages/data/HTML+PHP"), {
+  createLanguage(LINGUIST_LANGUAGES_HTML_PHP, {
     override: {
       parsers: ["php"],
       vscodeLanguageIds: ["php"],
@@ -44,16 +56,12 @@ const languages = [
   }),
 ];
 
-const loc = (prop) => (node) => {
-  return node.loc && node.loc[prop] && node.loc[prop].offset;
-};
-
 const parsers = {
   php: {
     parse,
     astFormat: "php",
-    locStart: loc("start"),
-    locEnd: loc("end"),
+    locStart,
+    locEnd,
     hasPragma,
   },
 };
@@ -81,21 +89,21 @@ const printers = {
     getVisitorKeys,
     insertPragma,
     massageAstNode: clean,
-    getCommentChildNodes: comments.getCommentChildNodes,
-    canAttachComment: comments.canAttachComment,
-    isBlockComment: comments.isBlockComment,
+    getCommentChildNodes,
+    canAttachComment,
+    isBlockComment,
     handleComments: {
-      ownLine: comments.handleOwnLineComment,
-      endOfLine: comments.handleEndOfLineComment,
-      remaining: comments.handleRemainingComment,
+      ownLine: handleOwnLineComment,
+      endOfLine: handleEndOfLineComment,
+      remaining: handleRemainingComment,
     },
     willPrintOwnComments(path) {
-      const node = path.getValue();
+      const { node } = path;
 
       return node && node.kind === "noop";
     },
-    printComment(commentPath) {
-      const comment = commentPath.getValue();
+    printComment(path) {
+      const comment = path.node;
 
       switch (comment.kind) {
         case "commentblock": {
@@ -127,7 +135,7 @@ const printers = {
         case "commentline": {
           return comment.value.trimRight();
         }
-        /* istanbul ignore next */
+        /* c8 ignore next 2 */
         default:
           throw new Error(`Not a comment: ${JSON.stringify(comment)}`);
       }
@@ -138,8 +146,7 @@ const printers = {
         !comment.value.includes("prettier-ignore-start") &&
         !comment.value.includes("prettier-ignore-end");
 
-      const parentNode = path.getParentNode();
-      const node = path.getNode();
+      const { node, parent: parentNode } = path;
 
       return (
         (node &&
@@ -161,12 +168,8 @@ const printers = {
   },
 };
 
-module.exports = {
-  languages,
-  printers,
-  parsers,
-  options,
-  defaultOptions: {
-    tabWidth: 4,
-  },
+const defaultOptions = {
+  tabWidth: 4,
 };
+
+export { languages, printers, parsers, options, defaultOptions };

package/src/linguist-languages.cjs

@@ -0,0 +1,4 @@
+"use strict";
+
+module.exports.LINGUIST_LANGUAGES_PHP = require("linguist-languages/data/PHP");
+module.exports.LINGUIST_LANGUAGES_HTML_PHP = require("linguist-languages/data/HTML+PHP");

package/src/loc.js

@@ -0,0 +1,4 @@
+const loc = (prop) => (node) => node.loc?.[prop]?.offset;
+
+export const locStart = loc("start");
+export const locEnd = loc("end");

package/src/needs-parens.js

@@ -1,18 +1,13 @@
-"use strict";
-
-const assert = require("assert");
-
-const { getPrecedence, shouldFlatten, isBitwiseOperator } = require("./util");
+import { getPrecedence, shouldFlatten, isBitwiseOperator } from "./util.js";
 
 function needsParens(path) {
-  const parent = path.getParentNode();
+  const { parent } = path;
 
   if (!parent) {
     return false;
   }
 
-  const name = path.getName();
-  const node = path.getNode();
+  const { key, node } = path;
 
   if (
     [
@@ -56,9 +51,9 @@ function needsParens(path) {
         case "staticlookup":
         case "offsetlookup":
         case "call":
-          return name === "what" && parent.what === node;
+          return key === "what";
         case "bin":
-          return parent.type === "**" && name === "left";
+          return parent.type === "**" && key === "left";
         default:
           return false;
       }
@@ -80,7 +75,7 @@ function needsParens(path) {
         case "nullsafepropertylookup":
         case "staticlookup":
         case "offsetlookup":
-          return name === "what" && parent.what === node;
+          return key === "what";
         case "bin": {
           const po = parent.type;
           const pp = getPrecedence(po);
@@ -95,9 +90,7 @@ function needsParens(path) {
             return true;
           }
 
-          if (pp === np && name === "right") {
-            assert.strictEqual(parent.right, node);
-
+          if (pp === np && key === "right") {
             return true;
           }
 
@@ -127,11 +120,7 @@ function needsParens(path) {
     case "staticlookup": {
       switch (parent.kind) {
         case "call":
-          return (
-            name === "what" &&
-            parent.what === node &&
-            node.parenthesizedExpression
-          );
+          return key === "what" && node.parenthesizedExpression;
 
         default:
           return false;
@@ -145,7 +134,7 @@ function needsParens(path) {
         case "staticlookup":
         case "offsetlookup":
         case "call":
-          return name === "what" && parent.what === node;
+          return key === "what";
         default:
           return false;
       }
@@ -157,10 +146,10 @@ function needsParens(path) {
         case "staticlookup":
         case "offsetlookup":
         case "call":
-          return name === "what" && parent.what === node;
+          return key === "what";
 
         case "retif":
-          return parent.test === node;
+          return key === "test";
 
         default:
           return !!(node.key || node.value);
@@ -195,7 +184,7 @@ function needsParens(path) {
         case "unary":
         case "bin":
         case "retif":
-          if (name === "test" && !parent.trueExpr) {
+          if (key === "test" && !parent.trueExpr) {
             return false;
           }
 
@@ -205,7 +194,7 @@ function needsParens(path) {
         case "staticlookup":
         case "offsetlookup":
         case "call":
-          return name === "what" && parent.what === node;
+          return key === "what";
 
         default:
           return false;
@@ -213,7 +202,7 @@ function needsParens(path) {
     case "closure":
       switch (parent.kind) {
         case "call":
-          return name === "what" && parent.what === node;
+          return key === "what";
 
         // https://github.com/prettier/plugin-php/issues/1675
         case "propertylookup":
@@ -243,7 +232,7 @@ function needsParens(path) {
             return false;
           }
 
-          return name === "what" && parent.what === node;
+          return key === "what";
         default:
           return false;
       }
@@ -255,4 +244,4 @@ function needsParens(path) {
   return false;
 }
 
-module.exports = needsParens;
+export default needsParens;

package/src/options.js

@@ -1,8 +1,6 @@
-"use strict";
-
 const CATEGORY_PHP = "PHP";
 
-module.exports = {
+export default {
   phpVersion: {
     since: "0.13.0",
     category: CATEGORY_PHP,

package/src/parser.js

@@ -1,5 +1,4 @@
-"use strict";
-const engine = require("php-parser");
+import engine from "php-parser";
 
 function parse(text, opts) {
   const inMarkdown = opts && opts.parentParser === "markdown";
@@ -61,4 +60,4 @@ function parse(text, opts) {
   return ast;
 }
 
-module.exports = parse;
+export default parse;

package/src/pragma.js

@@ -1,7 +1,5 @@
-"use strict";
-
-const parse = require("./parser");
-const memoize = require("mem");
+import memoize from "mem";
+import parse from "./parser.js";
 
 const reHasPragma = /@prettier|@format/;
 
@@ -91,7 +89,4 @@ function insertPragma(text) {
 ${after}`;
 }
 
-module.exports = {
-  hasPragma,
-  insertPragma,
-};
+export { hasPragma, insertPragma };