prettier-plugin-java 2.5.0 → 2.6.0

package/LICENSE

@@ -1,5 +1,5 @@
 
-    Copyright 2018-2023 the original author or authors from the JHipster project
+    Copyright 2018-2024 the original author or authors from the JHipster project
 
                                  Apache License
                            Version 2.0, January 2004

package/dist/base-cst-printer.js

@@ -1,60 +1,41 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseCstPrettierPrinter = void 0;
-var java_parser_1 = require("java-parser");
-var format_comments_1 = require("./printers/comments/format-comments");
-var BaseCstPrettierPrinter = /** @class */ (function (_super) {
-    __extends(BaseCstPrettierPrinter, _super);
-    function BaseCstPrettierPrinter() {
-        var _this = _super.call(this) || this;
-        _this.mapVisit = function (elements, params) {
+import { BaseJavaCstVisitor } from "java-parser";
+import { printNodeWithComments } from "./printers/comments/format-comments.js";
+export class BaseCstPrettierPrinter extends BaseJavaCstVisitor {
+    constructor() {
+        super();
+        this.mapVisit = (elements, params) => {
             if (elements === undefined) {
                 // TODO: can optimize this by returning an immutable empty array singleton.
                 return [];
             }
-            return elements.map(function (element) { return _this.visit(element, params); });
+            return elements.map(element => this.visit(element, params));
         };
-        _this.getSingle = function (ctx) {
-            var ctxKeys = Object.keys(ctx);
+        this.getSingle = (ctx) => {
+            const ctxKeys = Object.keys(ctx);
             if (ctxKeys.length !== 1) {
-                throw Error("Expecting single key CST ctx but found: <".concat(ctxKeys.length, "> keys"));
+                throw Error(`Expecting single key CST ctx but found: <${ctxKeys.length}> keys`);
             }
-            var singleElementKey = ctxKeys[0];
-            var singleElementValues = ctx[singleElementKey];
+            const singleElementKey = ctxKeys[0];
+            const singleElementValues = ctx[singleElementKey];
             if ((singleElementValues === null || singleElementValues === void 0 ? void 0 : singleElementValues.length) !== 1) {
-                throw Error("Expecting single item in CST ctx key but found: <".concat(singleElementValues === null || singleElementValues === void 0 ? void 0 : singleElementValues.length, "> items"));
+                throw Error(`Expecting single item in CST ctx key but found: <${singleElementValues === null || singleElementValues === void 0 ? void 0 : singleElementValues.length}> items`);
             }
             return singleElementValues[0];
         };
         // @ts-ignore
-        _this.orgVisit = _this.visit;
-        _this.visit = function (ctx, inParam) {
+        this.orgVisit = this.visit;
+        this.visit = function (ctx, inParam) {
             if (ctx === undefined) {
                 // empty Doc
                 return "";
             }
-            var node = Array.isArray(ctx) ? ctx[0] : ctx;
+            const node = Array.isArray(ctx) ? ctx[0] : ctx;
             if (node.ignore) {
                 try {
-                    var startOffset = node.leadingComments !== undefined
+                    const startOffset = node.leadingComments !== undefined
                         ? node.leadingComments[0].startOffset
                         : node.location.startOffset;
-                    var endOffset = (node.trailingComments !== undefined
+                    const endOffset = (node.trailingComments !== undefined
                         ? node.trailingComments[node.trailingComments.length - 1].endOffset
                         : node.location.endOffset);
                     return this.prettierOptions.originalText.substring(startOffset, endOffset + 1);
@@ -64,14 +45,11 @@ var BaseCstPrettierPrinter = /** @class */ (function (_super) {
                         "\nThere might be a problem with prettier-ignore, please report an issue on https://github.com/jhipster/prettier-java/issues");
                 }
             }
-            return (0, format_comments_1.printNodeWithComments)(node, this.orgVisit.call(this, node, inParam));
+            return printNodeWithComments(node, this.orgVisit.call(this, node, inParam));
         };
-        _this.visitSingle = function (ctx, params) {
-            var singleElement = this.getSingle(ctx);
+        this.visitSingle = function (ctx, params) {
+            const singleElement = this.getSingle(ctx);
             return this.visit(singleElement, params);
         };
-        return _this;
     }
-    return BaseCstPrettierPrinter;
-}(java_parser_1.BaseJavaCstVisitor));
-exports.BaseCstPrettierPrinter = BaseCstPrettierPrinter;
+}

package/dist/cst-printer.js

@@ -1,37 +1,29 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createPrettierDoc = void 0;
-var base_cst_printer_1 = require("./base-cst-printer");
-var arrays_1 = require("./printers/arrays");
-var blocks_and_statements_1 = require("./printers/blocks-and-statements");
-var classes_1 = require("./printers/classes");
-var expressions_1 = require("./printers/expressions");
-var interfaces_1 = require("./printers/interfaces");
-var lexical_structure_1 = require("./printers/lexical-structure");
-var names_1 = require("./printers/names");
-var types_values_and_variables_1 = require("./printers/types-values-and-variables");
-var packages_and_modules_1 = require("./printers/packages-and-modules");
+import { BaseCstPrettierPrinter } from "./base-cst-printer.js";
+import { ArraysPrettierVisitor } from "./printers/arrays.js";
+import { BlocksAndStatementPrettierVisitor } from "./printers/blocks-and-statements.js";
+import { ClassesPrettierVisitor } from "./printers/classes.js";
+import { ExpressionsPrettierVisitor } from "./printers/expressions.js";
+import { InterfacesPrettierVisitor } from "./printers/interfaces.js";
+import { LexicalStructurePrettierVisitor } from "./printers/lexical-structure.js";
+import { NamesPrettierVisitor } from "./printers/names.js";
+import { TypesValuesAndVariablesPrettierVisitor } from "./printers/types-values-and-variables.js";
+import { PackagesAndModulesPrettierVisitor } from "./printers/packages-and-modules.js";
 // Mixins for the win
-mixInMethods(arrays_1.ArraysPrettierVisitor, blocks_and_statements_1.BlocksAndStatementPrettierVisitor, classes_1.ClassesPrettierVisitor, expressions_1.ExpressionsPrettierVisitor, interfaces_1.InterfacesPrettierVisitor, lexical_structure_1.LexicalStructurePrettierVisitor, names_1.NamesPrettierVisitor, types_values_and_variables_1.TypesValuesAndVariablesPrettierVisitor, packages_and_modules_1.PackagesAndModulesPrettierVisitor);
-function mixInMethods() {
-    var classesToMix = [];
-    for (var _i = 0; _i < arguments.length; _i++) {
-        classesToMix[_i] = arguments[_i];
-    }
-    classesToMix.forEach(function (from) {
-        var fromMethodsNames = Object.getOwnPropertyNames(from.prototype);
-        var fromPureMethodsName = fromMethodsNames.filter(function (methodName) { return methodName !== "constructor"; });
-        fromPureMethodsName.forEach(function (methodName) {
+mixInMethods(ArraysPrettierVisitor, BlocksAndStatementPrettierVisitor, ClassesPrettierVisitor, ExpressionsPrettierVisitor, InterfacesPrettierVisitor, LexicalStructurePrettierVisitor, NamesPrettierVisitor, TypesValuesAndVariablesPrettierVisitor, PackagesAndModulesPrettierVisitor);
+function mixInMethods(...classesToMix) {
+    classesToMix.forEach(from => {
+        const fromMethodsNames = Object.getOwnPropertyNames(from.prototype);
+        const fromPureMethodsName = fromMethodsNames.filter(methodName => methodName !== "constructor");
+        fromPureMethodsName.forEach(methodName => {
             // @ts-ignore
-            base_cst_printer_1.BaseCstPrettierPrinter.prototype[methodName] = from.prototype[methodName];
+            BaseCstPrettierPrinter.prototype[methodName] = from.prototype[methodName];
         });
     });
 }
-var prettyPrinter = new base_cst_printer_1.BaseCstPrettierPrinter();
+const prettyPrinter = new BaseCstPrettierPrinter();
 // TODO: do we need the "path" and "print" arguments passed by prettier
 // see https://github.com/prettier/prettier/issues/5747
-function createPrettierDoc(cstNode, options) {
+export function createPrettierDoc(cstNode, options) {
     prettyPrinter.prettierOptions = options;
     return prettyPrinter.visit(cstNode);
 }
-exports.createPrettierDoc = createPrettierDoc;

package/dist/index.js

@@ -1,8 +1,7 @@
-"use strict";
-var parse = require("./parser");
-var print = require("./printer");
-var options = require("./options");
-var languages = [
+import parse from "./parser.js";
+import print from "./printer.js";
+import options from "./options.js";
+const languages = [
     {
         name: "Java",
         parsers: ["java"],
@@ -25,20 +24,20 @@ function locEnd( /* node */) {
 function hasPragma(text) {
     return /^\/\*\*[\n][\t\s]+\*\s@(prettier|format)[\n][\t\s]+\*\//.test(text);
 }
-var parsers = {
+const parsers = {
     java: {
-        parse: parse,
+        parse,
         astFormat: "java",
-        locStart: locStart,
-        locEnd: locEnd,
-        hasPragma: hasPragma
+        locStart,
+        locEnd,
+        hasPragma
     }
 };
 function canAttachComment(node) {
     return node.ast_type && node.ast_type !== "comment";
 }
 function printComment(commentPath) {
-    var comment = commentPath.getValue();
+    const comment = commentPath.getValue();
     switch (comment.ast_type) {
         case "comment":
             return comment.value;
@@ -50,18 +49,18 @@ function clean(ast, newObj) {
     delete newObj.lineno;
     delete newObj.col_offset;
 }
-var printers = {
+const printers = {
     java: {
-        print: print,
+        print,
         // hasPrettierIgnore,
-        printComment: printComment,
-        canAttachComment: canAttachComment,
+        printComment,
+        canAttachComment,
         massageAstNode: clean
     }
 };
-module.exports = {
-    languages: languages,
-    printers: printers,
-    parsers: parsers,
-    options: options
+export default {
+    languages,
+    printers,
+    parsers,
+    options
 };

package/dist/options.js

@@ -1,5 +1,4 @@
-"use strict";
-module.exports = {
+export default {
     entrypoint: {
         type: "choice",
         category: "Global",
@@ -53,9 +52,6 @@ module.exports = {
             { value: "resource" },
             { value: "yieldStatement" },
             { value: "variableAccess" },
-            { value: "isBasicForStatement" },
-            { value: "isLocalVariableDeclaration" },
-            { value: "isClassicSwitchLabel" },
             { value: "classDeclaration" },
             { value: "normalClassDeclaration" },
             { value: "classModifier" },
@@ -122,10 +118,7 @@ module.exports = {
             { value: "recordBody" },
             { value: "recordBodyDeclaration" },
             { value: "compactConstructorDeclaration" },
-            { value: "isClassDeclaration" },
-            { value: "identifyClassBodyDeclarationType" },
             { value: "isDims" },
-            { value: "isCompactConstructorDeclaration" },
             { value: "expression" },
             { value: "lambdaExpression" },
             { value: "lambdaParameters" },
@@ -167,6 +160,11 @@ module.exports = {
             { value: "classLiteralSuffix" },
             { value: "arrayAccessSuffix" },
             { value: "methodReferenceSuffix" },
+            { value: "templateArgument" },
+            { value: "template" },
+            { value: "stringTemplate" },
+            { value: "textBlockTemplate" },
+            { value: "embeddedExpression" },
             { value: "pattern" },
             { value: "typePattern" },
             { value: "recordPattern" },
@@ -174,11 +172,6 @@ module.exports = {
             { value: "componentPattern" },
             { value: "unnamedPattern" },
             { value: "guard" },
-            { value: "identifyNewExpressionType" },
-            { value: "isLambdaExpression" },
-            { value: "isCastExpression" },
-            { value: "isPrimitiveCastExpression" },
-            { value: "isReferenceTypeCastExpression" },
             { value: "isRefTypeInMethodRef" },
             { value: "interfaceDeclaration" },
             { value: "normalInterfaceDeclaration" },
@@ -203,9 +196,6 @@ module.exports = {
             { value: "elementValue" },
             { value: "elementValueArrayInitializer" },
             { value: "elementValueList" },
-            { value: "identifyInterfaceBodyDeclarationType" },
-            { value: "identifyAnnotationBodyDeclarationType" },
-            { value: "isSimpleElementValueAnnotation" },
             { value: "literal" },
             { value: "integerLiteral" },
             { value: "floatingPointLiteral" },
@@ -232,7 +222,6 @@ module.exports = {
             { value: "usesModuleDirective" },
             { value: "providesModuleDirective" },
             { value: "requiresModifier" },
-            { value: "isModuleCompilationUnit" },
             { value: "primitiveType" },
             { value: "numericType" },
             { value: "integralType" },
@@ -254,5 +243,12 @@ module.exports = {
             { value: "wildcardBounds" }
         ],
         description: "Prettify from the entrypoint, allowing to use prettier on snippet."
+    },
+    trailingComma: {
+        type: "choice",
+        category: "Java",
+        default: "all",
+        choices: ["all", "none"],
+        description: "Print trailing commas wherever possible when multi-line."
     }
 };

package/dist/parser.js

@@ -1,6 +1,4 @@
-"use strict";
-var javaParser = require("java-parser");
-function parse(text, parsers, opts) {
+import javaParser from "java-parser";
+export default function parse(text, parsers, opts) {
     return javaParser.parse(text, opts.entrypoint);
 }
-module.exports = parse;

package/dist/printer.js

@@ -1,8 +1,6 @@
-"use strict";
-var createPrettierDoc = require("./cst-printer").createPrettierDoc;
+import { createPrettierDoc } from "./cst-printer.js";
 // eslint-disable-next-line no-unused-vars
-function genericPrint(path, options, print) {
-    var node = path.getValue();
+export default function genericPrint(path, options, print) {
+    const node = path.getValue();
     return createPrettierDoc(node, options);
 }
-module.exports = genericPrint;

package/dist/printers/arrays.js

@@ -1,49 +1,25 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ArraysPrettierVisitor = void 0;
-var printer_utils_1 = require("./printer-utils");
-var doc_1 = require("prettier/doc");
-var base_cst_printer_1 = require("../base-cst-printer");
-var line = doc_1.builders.line;
-var ArraysPrettierVisitor = /** @class */ (function (_super) {
-    __extends(ArraysPrettierVisitor, _super);
-    function ArraysPrettierVisitor() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    ArraysPrettierVisitor.prototype.arrayInitializer = function (ctx) {
-        var optionalVariableInitializerList = this.visit(ctx.variableInitializerList);
-        return (0, printer_utils_1.printArrayList)({
+import { printArrayList, rejectAndConcat, rejectAndJoinSeps } from "./printer-utils.js";
+import { builders } from "prettier/doc";
+import { BaseCstPrettierPrinter } from "../base-cst-printer.js";
+const { line } = builders;
+export class ArraysPrettierVisitor extends BaseCstPrettierPrinter {
+    arrayInitializer(ctx) {
+        const optionalVariableInitializerList = this.visit(ctx.variableInitializerList);
+        return printArrayList({
             list: optionalVariableInitializerList,
             extraComma: ctx.Comma,
             LCurly: ctx.LCurly[0],
             RCurly: ctx.RCurly[0],
             trailingComma: this.prettierOptions.trailingComma
         });
-    };
-    ArraysPrettierVisitor.prototype.variableInitializerList = function (ctx) {
-        var variableInitializers = this.mapVisit(ctx.variableInitializer);
-        var commas = ctx.Comma
-            ? ctx.Comma.map(function (comma) {
-                return (0, printer_utils_1.rejectAndConcat)([comma, line]);
+    }
+    variableInitializerList(ctx) {
+        const variableInitializers = this.mapVisit(ctx.variableInitializer);
+        const commas = ctx.Comma
+            ? ctx.Comma.map(comma => {
+                return rejectAndConcat([comma, line]);
             })
             : [];
-        return (0, printer_utils_1.rejectAndJoinSeps)(commas, variableInitializers);
-    };
-    return ArraysPrettierVisitor;
-}(base_cst_printer_1.BaseCstPrettierPrinter));
-exports.ArraysPrettierVisitor = ArraysPrettierVisitor;
+        return rejectAndJoinSeps(commas, variableInitializers);
+    }
+}