module labels support

Author: damirka

external-crates/move/crates/move-analyzer/prettier-move/src/cst/module/Module.ts

@@ -45,10 +45,43 @@ export enum Module {
  */
 export function printModuleDefinition(
 	path: AstPath<Node>,
-	options: ParserOptions,
+	options: ParserOptions & MoveOptions,
 	print: printFn,
 ): Doc {
-	return join(' ', ['module', ...path.map(print, 'nonFormattingChildren')]);
+	let useLabel = false;
+
+	// when option is present we must check that there's only one module per file
+	if (options.useModuleLabel) {
+		let modules = path.parent!.nonFormattingChildren.filter(
+			(node) => node.type === path.node.type,
+		);
+
+		useLabel = modules.length == 1;
+	}
+
+	if (options.useModuleLabel) console.log(useLabel);
+
+	let result = [
+		'module ',
+		path.call(print, 'nonFormattingChildren', 0),
+		// path.call(print, 'nonFormattingChildren', 1),
+	];
+
+	if (useLabel) {
+		result.push(...[';', hardline, path.call(print, 'nonFormattingChildren', 1)]);
+	} else {
+		result.push(
+			...[
+				' {',
+				indent(hardline),
+				indent(path.call(print, 'nonFormattingChildren', 1)),
+				hardline,
+				'}',
+			],
+		);
+	}
+
+	return result;
 }
 
 /**
@@ -112,5 +145,5 @@ function printModuleBody(
 		return path.call(print);
 	}, 'namedAndEmptyLineChildren');
 
-	return ['{', indent(hardline), indent(join(hardline, printed)), hardline, '}'];
+	return join(hardline, printed);
 }

external-crates/move/crates/move-analyzer/prettier-move/src/index.ts

@@ -78,18 +78,20 @@ export const options: Record<string, SupportOption> = {
 		default: true,
 		description: 'Always break function body into multiple lines.',
 	},
-	alwaysBreakConditionals: {
+	useModuleLabel: {
 		type: 'boolean',
 		category: 'Global',
-		default: true,
-		description: 'Always break conditional body into multiple lines.',
+		default: false,
+		description:
+			'Enable module labels instead of module with braces. This option will be ignored if there is more than one module in the file.',
 	},
 };
 
 export const defaultOptions = {
 	tabWidth: 4,
 	useTabs: false,
 	printWidth: 100,
+	useModuleLabel: false,
 };
 
 export default {

external-crates/move/crates/move-analyzer/prettier-move/src/printer.ts

@@ -31,6 +31,7 @@ export type MoveOptions = {
 	alwaysBreakFunctions: boolean;
 	alwaysBreakConditionals: boolean;
 	alwaysBreakStructDefinition: boolean;
+	useModuleLabel: boolean;
 };
 
 export type printFn = (path: AstPath) => Doc;

external-crates/move/crates/move-analyzer/prettier-move/tests/functions/pattern_matching.exp.move

@@ -1,9 +1,9 @@
 module prettier::pattern_matching {
     fun f(x: MyEnum): u8 {
         match (x) {
-            MyEnum::Variant(ERROR) => 1,
+            MyEnum::Variant(1, true) => 1,
             MyEnum::Variant(_, _) => 1,
-            MyEnum::OtherVariant(_, ERROR) => 2,
+            MyEnum::OtherVariant(_, 3) => 2,
             // Now exhaustive since this will match all values of MyEnum::OtherVariant
             MyEnum::OtherVariant(..) => 2,
         }

external-crates/move/crates/move-analyzer/prettier-move/tests/prettier-features/module_label.exp.move

@@ -0,0 +1,13 @@
+// options:
+// printWidth: 80
+// useModuleLabel: true
+
+module prettier::module_label;
+use std::string::String;
+
+/// Hey there, this is the first time we meet.
+public struct Hey {}
+
+public fun another_public_fun() {}
+
+fun ignored_vec() {}

external-crates/move/crates/move-analyzer/prettier-move/tests/prettier-features/module_label.move

@@ -0,0 +1,11 @@
+// options:
+// printWidth: 80
+// useModuleLabel: true
+
+module prettier::module_label {
+    use std::string::String;
+    /// Hey there, this is the first time we meet.
+    public struct Hey {}
+    public fun another_public_fun() {}
+    fun ignored_vec() {}
+}

external-crates/move/crates/move-analyzer/prettier-move/tests/prettier-features/module_label_two_modules.exp.move

@@ -0,0 +1,21 @@
+// options:
+// printWidth: 80
+// useModuleLabel: true
+
+module prettier::module_label {
+    /// Hey there, this is the first time we meet.
+    public struct Hey {}
+
+    public fun another_public_fun() {}
+
+    fun ignored_vec() {}
+}
+
+module prettier::module_label_v2 {
+    /// Hey there, this is the first time we meet.
+    public struct Hey {}
+
+    public fun another_public_fun() {}
+
+    fun ignored_vec() {}
+}

external-crates/move/crates/move-analyzer/prettier-move/tests/prettier-features/module_label_two_modules.move

@@ -0,0 +1,17 @@
+// options:
+// printWidth: 80
+// useModuleLabel: true
+
+module prettier::module_label {
+    /// Hey there, this is the first time we meet.
+    public struct Hey {}
+    public fun another_public_fun() {}
+    fun ignored_vec() {}
+}
+
+module prettier::module_label_v2 {
+    /// Hey there, this is the first time we meet.
+    public struct Hey {}
+    public fun another_public_fun() {}
+    fun ignored_vec() {}
+}

external-crates/move/crates/move-analyzer/prettier-move/tests/run.test.ts

@@ -8,6 +8,7 @@ import * as path from 'path';
 import * as plugin from '../';
 import * as prettier from 'prettier';
 import { describe, it } from 'vitest';
+import { MoveOptions } from "../src/printer";
 
 const UB = process.env['UB'];
 const OPTIONS_HEADER = '// options:';
@@ -36,23 +37,32 @@ function runSpec(dirname: string) {
 				// allows `// options:` header in the test file to set prettier options
 				// e.g.
 				// ```
-				// // options: printWidth: 80
+				// // options:
+				// // printWidth: 80
 				// // tabWidth: 2
+				// // useModuleLabel: true
 				// ```
 				let config = {
 					printWidth: 80,
 					tabWidth: 4,
+					useModuleLabel: false,
 				};
 
 				if (content.startsWith(OPTIONS_HEADER)) {
 					let lines = content.split('\n').slice(0, 10);
 					while (lines.length) {
 						let line = lines.shift();
 						if (line?.startsWith('// ')) {
-							let value = /(printWidth|tabWidth)\:\ ([0-9]+)/.exec(line);
+							let value = /(printWidth|tabWidth|useModuleLabel)\:\ (true|[0-9]+)/.exec(
+								line,
+							);
 							if (value) {
 								let [_, key, val] = value || [];
-								config[key] = parseInt(val);
+								if (key == 'useModuleLabel') {
+									config[key] = val == 'true';
+								} else {
+									config[key] = parseInt(val);
+								}
 							}
 						}
 					}
@@ -66,11 +76,14 @@ function runSpec(dirname: string) {
 							// @ts-ignore
 							printers: plugin.printers,
 							defaultOptions: plugin.defaultOptions,
+							// @ts-ignore
+							options: plugin.options,
 						},
 					],
 					parser: 'move-parse',
 					printWidth: config.printWidth,
 					tabWidth: config.tabWidth,
+					useModuleLabel: config.useModuleLabel,
 				});
 
 				// user asked to regenerate output