prettier-plugin-wolfram 0.7.9 → 0.7.10

package/README.md

@@ -129,6 +129,7 @@ Typical `.prettierrc` example:
 		"alignRuleValues": false,
 		"documentationCommentColumn": 0,
 		"documentationCommentPadding": 2,
+		"documentationCommentMarkers": false,
 		"topLevelSpacingMode": "declarations",
 		"preserveTildeInfixFunctions": "",
 		"moduleVarsBreakThreshold": 40,
@@ -158,6 +159,7 @@ this plugin.
 | `wolfram.alignRuleValues`                             | boolean     | `false`                             | Vertically aligns `Rule` and `RuleDelayed` values in multiline argument, list, and association layouts. |
 | `wolfram.documentationCommentColumn`                  | integer     | `0`                                 | Column for trailing documentation comments. `0` computes a column per contiguous block. |
 | `wolfram.documentationCommentPadding`                 | integer     | `2`                                 | Minimum spaces between code and an aligned trailing documentation comment when the column is computed automatically. |
+| `wolfram.documentationCommentMarkers`                 | boolean     | `false`                             | Treats trailing comments beginning with `<` as documentation comments aligned at `printWidth`. |
 | `wolfram.topLevelSpacingMode`                         | string      | `"declarations"`                    | Top-level blank-line policy. Allowed values are `declarations`, `all`, and `none`. |
 | `wolfram.preserveTildeInfixFunctions`                 | string      | `""`                                | Comma-separated function names that stay in `x ~ f ~ y` form instead of normalizing to `f[x, y]`. |
 | `wolfram.moduleVarsBreakThreshold`                    | integer     | `40`                                | Character count at which block-structure variable lists break across lines. |

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "prettier-plugin-wolfram",
-	"version": "0.7.9",
+	"version": "0.7.10",
 	"description": "Prettier plugin for Wolfram Language using tree-sitter",
 	"license": "MIT",
 	"repository": {

package/src/options.js

@@ -109,6 +109,13 @@ export const wolframOptions = {
 		description:
 			"Minimum spaces between code and an aligned trailing documentation comment in auto mode.",
 	},
+	documentationCommentMarkers: {
+		type: "boolean",
+		default: false,
+		legacyName: "wolframDocumentationCommentMarkers",
+		description:
+			"Treat trailing comments beginning with < as documentation comments aligned at printWidth.",
+	},
 	topLevelSpacingMode: {
 		type: "string",
 		default: "declarations",

package/src/translator/docComments.js

@@ -19,7 +19,15 @@ export function isDocumentationCommentMarkerText(text) {
 	return /^\(\*\s*</u.test(String(text ?? ""));
 }
 
-export function hasDocumentationCommentMarker(comment) {
+function documentationCommentMarkersEnabled(options) {
+	return (
+		normalizeWolframOptions(options).wolframDocumentationCommentMarkers ===
+		true
+	);
+}
+
+export function hasDocumentationCommentMarker(comment, options) {
+	if (!documentationCommentMarkersEnabled(options)) return false;
 	const node = comment?.node ?? comment;
 	return (
 		node?.kind === "Token`Comment" &&
@@ -27,6 +35,12 @@ export function hasDocumentationCommentMarker(comment) {
 	);
 }
 
+function hasMarkedDocumentationCommentEntry(entry, options) {
+	return (entry?.trailingComments ?? []).some((comment) =>
+		hasDocumentationCommentMarker(comment, options),
+	);
+}
+
 function normalizeDocumentationCommentMarker(text) {
 	return String(text).replace(/^\(\*\s*<\s*/u, "(* < ");
 }
@@ -34,6 +48,7 @@ function normalizeDocumentationCommentMarker(text) {
 function normalizedCommentDoc(comment, options) {
 	const rendered = renderFlatDoc(comment.doc, options);
 	if (
+		!documentationCommentMarkersEnabled(options) ||
 		!isDocumentationCommentMarkerText(rendered) ||
 		rendered.includes("\n")
 	) {
@@ -80,6 +95,13 @@ export function documentationCommentColumn(
 	options = normalizeWolframOptions(options);
 	const manual = options.wolframDocumentationCommentColumn ?? 0;
 	if (manual > 0) return manual;
+	if (
+		entries.some((entry) =>
+			hasMarkedDocumentationCommentEntry(entry, options),
+		)
+	) {
+		return options.printWidth ?? 80;
+	}
 	const padding = Math.max(
 		1,
 		options.wolframDocumentationCommentPadding ?? 2,

package/src/translator/nodes/infix.js

@@ -192,7 +192,9 @@ export function printInfix(node, options, print) {
 			(entry) => entry.trailingCommentDoc,
 		);
 		const hasMarkedDocumentationComment = trailingEntries.some((entry) =>
-			entry.trailingComments.some(hasDocumentationCommentMarker),
+			entry.trailingComments.some((comment) =>
+				hasDocumentationCommentMarker(comment, options),
+			),
 		);
 		const alignTrailingComments =
 			(options.wolframDocumentationCommentColumn ?? 0) > 0 ||