prettier-java-next-line 2.10.4 → 2.11.0

package/README.md

@@ -35,6 +35,15 @@ Set `braceStyle` only when a project needs the inherited same-line style:
 }
 ```
 
+Set `importOrder` to group imports the way Spotless's `importOrder` step does. Groups separated by `,` get blank lines between them, prefixes joined by `|` share a group, `#` marks a static prefix, and an empty prefix catches everything else. Each import belongs to its longest matching prefix. Module imports (`import module`) always come first in their own group. When `importOrder` is empty, static imports follow them, then all others.
+
+```json
+{
+	"plugins": ["prettier-java-next-line"],
+	"importOrder": "java,javax,,#java|#javax,#"
+}
+```
+
 To use the matching Prettier runtime fork too, install it under the name `prettier` with an npm alias:
 
 ```bash

package/dist/index.cjs

@@ -61,6 +61,12 @@ var options_default = {
 			description: "Put opening braces on new lines (Allman style)"
 		}],
 		description: "Placement of opening braces."
+	},
+	importOrder: {
+		type: "string",
+		category: "Java",
+		default: "",
+		description: "Import groups in Spotless's format, such as `java,javax,,#java|#javax,#`. Module imports always come first. Empty puts static imports next, then all others."
 	}
 };
 //#endregion
@@ -309,6 +315,12 @@ function printAssignment(leftDoc, operator, rightDoc, rightNode) {
 		indentIfBreak$2(rightDoc, { groupId })
 	]);
 }
+function getLanguageByLanguageName(languages, languageName) {
+	return languages.find(({ name }) => name.toLowerCase() === languageName) ?? languages.find(({ aliases }) => aliases?.includes(languageName)) ?? languages.find(({ extensions }) => extensions?.includes(`.${languageName}`));
+}
+function inferParser(options, language) {
+	return getLanguageByLanguageName(options.plugins?.filter((plugin) => typeof plugin !== "string" && !(plugin instanceof URL)).reverse().flatMap((plugin) => plugin.languages ?? []) ?? [], language)?.parsers[0];
+}
 function printTextBlock(contents) {
 	return [
 		"\"\"\"",
@@ -317,13 +329,15 @@ function printTextBlock(contents) {
 		"\"\"\""
 	];
 }
-function embedTextBlock(path) {
+function embedTextBlock(path, options) {
 	if (path.node.namedChildren.some(({ type }) => type === "string_interpolation") || path.node.children[0].value === "\"") return null;
 	const language = findEmbeddedLanguage(path);
 	if (!language) return null;
+	const parser = inferParser(options, language);
+	if (!parser) return null;
 	const text = unescapeTextBlockContents(textBlockContents(path.node));
 	return async (textToDoc) => {
-		return printTextBlock([escapeDocForTextBlock(await textToDoc(text, { parser: language })), hardline$7]);
+		return printTextBlock([escapeDocForTextBlock(await textToDoc(text, { parser })), hardline$7]);
 	};
 }
 function textBlockContents(node) {
@@ -1176,7 +1190,11 @@ var expressions_default = {
 		}, "children")));
 	},
 	unary_expression(path, print) {
-		return path.map(print, "children");
+		const parts = [path.call(print, "operatorNode")];
+		const operandDoc = path.call(print, "operandNode");
+		if (path.node.operandNode.comments) parts.push(group$4(indentInParentheses(operandDoc)));
+		else parts.push(operandDoc);
+		return parts;
 	},
 	field_access: printMemberChain,
 	generic_type(path, print) {
@@ -1918,11 +1936,11 @@ var names_default = {
 //#region src/printers/packages-and-modules.ts
 const { group: group$1, hardline: hardline$1, indent: indent$1, join: join$1, line: line$2 } = prettier_doc.builders;
 var packages_and_modules_default = {
-	program(path, print) {
+	program(path, print, options) {
 		if (!path.node.namedChildren.length) return [printDanglingComments(path), hardline$1];
 		const parts = [];
 		if (path.node.namedChildren[0].type !== "import_declaration") parts.push(path.call(print, "namedChildren", 0));
-		const staticImports = [];
+		const moduleImports = [];
 		const imports = [];
 		const otherDeclarations = [];
 		path.each((child) => {
@@ -1930,13 +1948,15 @@ var packages_and_modules_default = {
 			if (child.node.type === "import_declaration") {
 				const names = extractNames(child.node.namedChildren[0]);
 				if (child.node.namedChildren.some(({ type }) => type === "asterisk")) names.push("*");
-				(child.node.children[1].type === "static" ? staticImports : imports).push({
+				const modifier = child.node.children[1].type;
+				(modifier === "module" ? moduleImports : imports).push({
 					doc,
-					names
+					names,
+					isStatic: modifier === "static"
 				});
 			} else if (!child.isFirst) otherDeclarations.push(doc);
 		}, "namedChildren");
-		parts.push(...[staticImports, imports].filter((imports) => imports.length).map((imports) => join$1(hardline$1, imports.sort(compareFqn).map(({ doc }) => doc))), ...otherDeclarations);
+		parts.push(...[moduleImports.sort(compareFqn), ...groupImports(imports, options.importOrder)].filter((group) => group.length).map((group) => join$1(hardline$1, group.map(({ doc }) => doc))), ...otherDeclarations);
 		return [...join$1([hardline$1, hardline$1], parts), hardline$1];
 	},
 	package_declaration(path, print) {
@@ -1960,7 +1980,8 @@ var packages_and_modules_default = {
 	},
 	import_declaration(path, print) {
 		const declaration = ["import "];
-		if (path.node.children.some(({ type }) => type === "static")) declaration.push("static ");
+		const modifier = path.node.children[1].type;
+		if (modifier === "module" || modifier === "static") declaration.push(modifier, " ");
 		const identifierIndex = path.node.namedChildren.findIndex(({ type }) => type === "identifier" || type === "scoped_identifier");
 		declaration.push(path.call(print, "namedChildren", identifierIndex));
 		if (path.node.namedChildren.some(({ type }) => type === "asterisk")) declaration.push(".*");
@@ -2014,6 +2035,46 @@ var packages_and_modules_default = {
 function extractNames(node) {
 	return node.type === "identifier" ? [node.value] : [...extractNames(node.scopeNode), node.nameNode.value];
 }
+const STATIC_PREFIX = "static ";
+const CATCH_ALL_PREFIX = "";
+function groupImports(imports, importOrder) {
+	if (!importOrder) return [imports.filter(({ isStatic }) => isStatic), imports.filter(({ isStatic }) => !isStatic)].filter((group) => group.length).map((group) => group.sort(compareFqn));
+	const groups = parseImportOrder(importOrder);
+	const prefixes = groups.flat();
+	const importsByPrefix = /* @__PURE__ */ new Map();
+	for (const entry of imports) {
+		const key = importKey(entry);
+		const prefix = prefixes.filter((candidate) => key.startsWith(candidate)).reduce((best, candidate) => candidate.length > best.length ? candidate : best);
+		importsByPrefix.set(prefix, [...importsByPrefix.get(prefix) ?? [], {
+			key,
+			entry
+		}]);
+	}
+	return groups.map((group) => group.flatMap((prefix) => (importsByPrefix.get(prefix) ?? []).sort((a, b) => a.key < b.key ? -1 : a.key > b.key ? 1 : 0).map(({ entry }) => entry))).filter((group) => group.length);
+}
+/**
+* Parses an import order in Spotless's format: groups separated by `,` are
+* printed with blank lines between them, prefixes joined by `|` share a group,
+* `#` marks a static prefix, and an empty prefix catches everything else.
+* Each import belongs to its longest matching prefix.
+*/
+function parseImportOrder(importOrder) {
+	const knownPrefixes = /* @__PURE__ */ new Set();
+	const groups = importOrder.split(",").map((group) => group.split("|").map((prefix) => prefix.startsWith("#") ? STATIC_PREFIX + prefix.slice(1) : prefix).filter((prefix) => {
+		if (knownPrefixes.has(prefix)) return false;
+		knownPrefixes.add(prefix);
+		return true;
+	}));
+	if (!knownPrefixes.has(STATIC_PREFIX)) {
+		const lastStaticGroupIndex = groups.findLastIndex((group) => group.some((prefix) => prefix.startsWith(STATIC_PREFIX)));
+		groups.splice(Math.max(lastStaticGroupIndex, 0), 0, [STATIC_PREFIX]);
+	}
+	if (!knownPrefixes.has(CATCH_ALL_PREFIX)) groups.push([CATCH_ALL_PREFIX]);
+	return groups;
+}
+function importKey({ names, isStatic }) {
+	return (isStatic ? STATIC_PREFIX : "") + names.join(".");
+}
 function compareFqn({ names: a }, { names: b }) {
 	const minParts = Math.min(a.length, b.length);
 	for (let i = 0; i < minParts; i++) {
@@ -2114,8 +2175,8 @@ var printer_default = {
 			")"
 		] : doc;
 	},
-	embed(path) {
-		return hasType(path, "string_literal") ? embedTextBlock(path) : null;
+	embed(path, options) {
+		return hasType(path, "string_literal") ? embedTextBlock(path, options) : null;
 	},
 	hasPrettierIgnore(path) {
 		return path.node.comments?.some(isPrettierIgnore) === true || canAttachComment(path.node, path.parent ? [path.parent] : []) && isFullyBetweenPrettierIgnore(path);

package/dist/index.d.cts

@@ -1575,7 +1575,7 @@ declare const _default: {
   printers: {
     java: {
       print(path: import("prettier").AstPath<SyntaxNode>, options: import("prettier").ParserOptions<SyntaxNode>, print: (selector?: string | number | import("prettier").AstPath<SyntaxNode> | (string | number)[] | undefined, args?: unknown) => import("prettier").Doc, args: unknown): import("prettier/doc.js").builders.Doc;
-      embed(path: import("prettier").AstPath<any>): ((textToDoc: (text: string, options: import("prettier").Options) => Promise<import("prettier").Doc>) => Promise<import("prettier/doc.js").builders.Doc[]>) | null;
+      embed(path: import("prettier").AstPath<any>, options: import("prettier").Options): ((textToDoc: (text: string, options: import("prettier").Options) => Promise<import("prettier").Doc>) => Promise<import("prettier/doc.js").builders.Doc[]>) | null;
       hasPrettierIgnore(path: import("prettier").AstPath<SyntaxNode>): boolean;
       canAttachComment: typeof canAttachComment;
       isBlockComment(node: SyntaxNode): boolean;
@@ -1631,6 +1631,12 @@ declare const _default: {
       }[];
       description: string;
     };
+    importOrder: {
+      type: "string";
+      category: string;
+      default: string;
+      description: string;
+    };
   };
   defaultOptions: {
     arrowParens: "avoid";

package/dist/index.d.mts

@@ -1575,7 +1575,7 @@ declare const _default: {
   printers: {
     java: {
       print(path: import("prettier").AstPath<SyntaxNode>, options: import("prettier").ParserOptions<SyntaxNode>, print: (selector?: string | number | import("prettier").AstPath<SyntaxNode> | (string | number)[] | undefined, args?: unknown) => import("prettier").Doc, args: unknown): import("prettier/doc.js").builders.Doc;
-      embed(path: import("prettier").AstPath<any>): ((textToDoc: (text: string, options: import("prettier").Options) => Promise<import("prettier").Doc>) => Promise<import("prettier/doc.js").builders.Doc[]>) | null;
+      embed(path: import("prettier").AstPath<any>, options: import("prettier").Options): ((textToDoc: (text: string, options: import("prettier").Options) => Promise<import("prettier").Doc>) => Promise<import("prettier/doc.js").builders.Doc[]>) | null;
       hasPrettierIgnore(path: import("prettier").AstPath<SyntaxNode>): boolean;
       canAttachComment: typeof canAttachComment;
       isBlockComment(node: SyntaxNode): boolean;
@@ -1631,6 +1631,12 @@ declare const _default: {
       }[];
       description: string;
     };
+    importOrder: {
+      type: "string";
+      category: string;
+      default: string;
+      description: string;
+    };
   };
   defaultOptions: {
     arrowParens: "avoid";

package/dist/index.mjs

@@ -61,6 +61,12 @@ var options_default = {
 			description: "Put opening braces on new lines (Allman style)"
 		}],
 		description: "Placement of opening braces."
+	},
+	importOrder: {
+		type: "string",
+		category: "Java",
+		default: "",
+		description: "Import groups in Spotless's format, such as `java,javax,,#java|#javax,#`. Module imports always come first. Empty puts static imports next, then all others."
 	}
 };
 //#endregion
@@ -309,6 +315,12 @@ function printAssignment(leftDoc, operator, rightDoc, rightNode) {
 		indentIfBreak$2(rightDoc, { groupId })
 	]);
 }
+function getLanguageByLanguageName(languages, languageName) {
+	return languages.find(({ name }) => name.toLowerCase() === languageName) ?? languages.find(({ aliases }) => aliases?.includes(languageName)) ?? languages.find(({ extensions }) => extensions?.includes(`.${languageName}`));
+}
+function inferParser(options, language) {
+	return getLanguageByLanguageName(options.plugins?.filter((plugin) => typeof plugin !== "string" && !(plugin instanceof URL)).reverse().flatMap((plugin) => plugin.languages ?? []) ?? [], language)?.parsers[0];
+}
 function printTextBlock(contents) {
 	return [
 		"\"\"\"",
@@ -317,13 +329,15 @@ function printTextBlock(contents) {
 		"\"\"\""
 	];
 }
-function embedTextBlock(path) {
+function embedTextBlock(path, options) {
 	if (path.node.namedChildren.some(({ type }) => type === "string_interpolation") || path.node.children[0].value === "\"") return null;
 	const language = findEmbeddedLanguage(path);
 	if (!language) return null;
+	const parser = inferParser(options, language);
+	if (!parser) return null;
 	const text = unescapeTextBlockContents(textBlockContents(path.node));
 	return async (textToDoc) => {
-		return printTextBlock([escapeDocForTextBlock(await textToDoc(text, { parser: language })), hardline$7]);
+		return printTextBlock([escapeDocForTextBlock(await textToDoc(text, { parser })), hardline$7]);
 	};
 }
 function textBlockContents(node) {
@@ -1176,7 +1190,11 @@ var expressions_default = {
 		}, "children")));
 	},
 	unary_expression(path, print) {
-		return path.map(print, "children");
+		const parts = [path.call(print, "operatorNode")];
+		const operandDoc = path.call(print, "operandNode");
+		if (path.node.operandNode.comments) parts.push(group$4(indentInParentheses(operandDoc)));
+		else parts.push(operandDoc);
+		return parts;
 	},
 	field_access: printMemberChain,
 	generic_type(path, print) {
@@ -1918,11 +1936,11 @@ var names_default = {
 //#region src/printers/packages-and-modules.ts
 const { group: group$1, hardline: hardline$1, indent: indent$1, join: join$1, line: line$2 } = builders;
 var packages_and_modules_default = {
-	program(path, print) {
+	program(path, print, options) {
 		if (!path.node.namedChildren.length) return [printDanglingComments(path), hardline$1];
 		const parts = [];
 		if (path.node.namedChildren[0].type !== "import_declaration") parts.push(path.call(print, "namedChildren", 0));
-		const staticImports = [];
+		const moduleImports = [];
 		const imports = [];
 		const otherDeclarations = [];
 		path.each((child) => {
@@ -1930,13 +1948,15 @@ var packages_and_modules_default = {
 			if (child.node.type === "import_declaration") {
 				const names = extractNames(child.node.namedChildren[0]);
 				if (child.node.namedChildren.some(({ type }) => type === "asterisk")) names.push("*");
-				(child.node.children[1].type === "static" ? staticImports : imports).push({
+				const modifier = child.node.children[1].type;
+				(modifier === "module" ? moduleImports : imports).push({
 					doc,
-					names
+					names,
+					isStatic: modifier === "static"
 				});
 			} else if (!child.isFirst) otherDeclarations.push(doc);
 		}, "namedChildren");
-		parts.push(...[staticImports, imports].filter((imports) => imports.length).map((imports) => join$1(hardline$1, imports.sort(compareFqn).map(({ doc }) => doc))), ...otherDeclarations);
+		parts.push(...[moduleImports.sort(compareFqn), ...groupImports(imports, options.importOrder)].filter((group) => group.length).map((group) => join$1(hardline$1, group.map(({ doc }) => doc))), ...otherDeclarations);
 		return [...join$1([hardline$1, hardline$1], parts), hardline$1];
 	},
 	package_declaration(path, print) {
@@ -1960,7 +1980,8 @@ var packages_and_modules_default = {
 	},
 	import_declaration(path, print) {
 		const declaration = ["import "];
-		if (path.node.children.some(({ type }) => type === "static")) declaration.push("static ");
+		const modifier = path.node.children[1].type;
+		if (modifier === "module" || modifier === "static") declaration.push(modifier, " ");
 		const identifierIndex = path.node.namedChildren.findIndex(({ type }) => type === "identifier" || type === "scoped_identifier");
 		declaration.push(path.call(print, "namedChildren", identifierIndex));
 		if (path.node.namedChildren.some(({ type }) => type === "asterisk")) declaration.push(".*");
@@ -2014,6 +2035,46 @@ var packages_and_modules_default = {
 function extractNames(node) {
 	return node.type === "identifier" ? [node.value] : [...extractNames(node.scopeNode), node.nameNode.value];
 }
+const STATIC_PREFIX = "static ";
+const CATCH_ALL_PREFIX = "";
+function groupImports(imports, importOrder) {
+	if (!importOrder) return [imports.filter(({ isStatic }) => isStatic), imports.filter(({ isStatic }) => !isStatic)].filter((group) => group.length).map((group) => group.sort(compareFqn));
+	const groups = parseImportOrder(importOrder);
+	const prefixes = groups.flat();
+	const importsByPrefix = /* @__PURE__ */ new Map();
+	for (const entry of imports) {
+		const key = importKey(entry);
+		const prefix = prefixes.filter((candidate) => key.startsWith(candidate)).reduce((best, candidate) => candidate.length > best.length ? candidate : best);
+		importsByPrefix.set(prefix, [...importsByPrefix.get(prefix) ?? [], {
+			key,
+			entry
+		}]);
+	}
+	return groups.map((group) => group.flatMap((prefix) => (importsByPrefix.get(prefix) ?? []).sort((a, b) => a.key < b.key ? -1 : a.key > b.key ? 1 : 0).map(({ entry }) => entry))).filter((group) => group.length);
+}
+/**
+* Parses an import order in Spotless's format: groups separated by `,` are
+* printed with blank lines between them, prefixes joined by `|` share a group,
+* `#` marks a static prefix, and an empty prefix catches everything else.
+* Each import belongs to its longest matching prefix.
+*/
+function parseImportOrder(importOrder) {
+	const knownPrefixes = /* @__PURE__ */ new Set();
+	const groups = importOrder.split(",").map((group) => group.split("|").map((prefix) => prefix.startsWith("#") ? STATIC_PREFIX + prefix.slice(1) : prefix).filter((prefix) => {
+		if (knownPrefixes.has(prefix)) return false;
+		knownPrefixes.add(prefix);
+		return true;
+	}));
+	if (!knownPrefixes.has(STATIC_PREFIX)) {
+		const lastStaticGroupIndex = groups.findLastIndex((group) => group.some((prefix) => prefix.startsWith(STATIC_PREFIX)));
+		groups.splice(Math.max(lastStaticGroupIndex, 0), 0, [STATIC_PREFIX]);
+	}
+	if (!knownPrefixes.has(CATCH_ALL_PREFIX)) groups.push([CATCH_ALL_PREFIX]);
+	return groups;
+}
+function importKey({ names, isStatic }) {
+	return (isStatic ? STATIC_PREFIX : "") + names.join(".");
+}
 function compareFqn({ names: a }, { names: b }) {
 	const minParts = Math.min(a.length, b.length);
 	for (let i = 0; i < minParts; i++) {
@@ -2114,8 +2175,8 @@ var printer_default = {
 			")"
 		] : doc;
 	},
-	embed(path) {
-		return hasType(path, "string_literal") ? embedTextBlock(path) : null;
+	embed(path, options) {
+		return hasType(path, "string_literal") ? embedTextBlock(path, options) : null;
 	},
 	hasPrettierIgnore(path) {
 		return path.node.comments?.some(isPrettierIgnore) === true || canAttachComment(path.node, path.parent ? [path.parent] : []) && isFullyBetweenPrettierIgnore(path);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prettier-java-next-line",
-  "version": "2.10.4",
+  "version": "2.11.0",
   "description": "Prettier Java plugin with configurable same-line and next-line braces",
   "homepage": "https://github.com/motlin/prettier-java-next-line",
   "repository": {
@@ -39,6 +39,7 @@
     "lerna:version": "lerna version --exact --no-private",
     "lint": "eslint src test",
     "prepare": "husky",
+    "prepublishOnly": "npm run build",
     "test": "yarn run test:unit && yarn run test:e2e-core",
     "test:all": "yarn run test && yarn run test:e2e-jhipster1 && yarn run test:e2e-jhipster2",
     "test:e2e-core": "node scripts/clone-samples e2e-core && mocha \"test/repository-test/core-test.ts\"",
@@ -77,7 +78,7 @@
     "postcss": "^8.5.15",
     "prettier": "^3.8.1",
     "prettier-plugin-css-order": "^2.2.0",
-    "tree-sitter-java-orchard": "0.5.18",
+    "tree-sitter-java-orchard": "0.5.22",
     "tsdown": "^0.23.0",
     "typescript": "^6.0.3",
     "typescript-eslint": "^8.57.1"