fmt: cleanup fields comments alignment and add ignore_newline config (#22027)

Author: yuyi98

examples/gg/path_finding_algorithm_visualizer/aStar.v

@@ -76,15 +76,15 @@ fn main() {
 
 	// setting values of app
 	app.gg = gg.new_context(
-		bg_color:      gx.black // background color
-		width:         window_width // window width
+		bg_color:      gx.black      // background color
+		width:         window_width  // window width
 		height:        window_height // window height
-		create_window: true // this will create a different window
+		create_window: true          // this will create a different window
 		window_title:  'A* Path finding algorithm visusalizer' // title of the window
-		frame_fn:      frame // this is frame function update the frame
-		event_fn:      on_event // it calls on every event
+		frame_fn:      frame       // this is frame function update the frame
+		event_fn:      on_event    // it calls on every event
 		init_fn:       init_images // run at start of application
-		user_data:     app // store user data
+		user_data:     app         // store user data
 	)
 	mut grid := initialise_grid() // initialize the grid variable and populate the matrix with each cell as empty
 	app.grid = grid // set grid to app attribute so you can access it by just passing app variable or with method of app

vlib/builtin/string_interpolation.v

@@ -190,12 +190,12 @@ fn (data &StrIntpData) process_str_intp_data(mut sb strings.Builder) {
 	sign_set := sign == 1
 
 	mut bf := strconv.BF_param{
-		pad_ch:       pad_ch // padding char
-		len0:         len0_set // default len for whole the number or string
-		len1:         len1_set // number of decimal digits, if needed
-		positive:     true // mandatory: the sign of the number passed
-		sign_flag:    sign_set // flag for print sign as prefix in padding
-		align:        .left // alignment of the string
+		pad_ch:       pad_ch     // padding char
+		len0:         len0_set   // default len for whole the number or string
+		len1:         len1_set   // number of decimal digits, if needed
+		positive:     true       // mandatory: the sign of the number passed
+		sign_flag:    sign_set   // flag for print sign as prefix in padding
+		align:        .left      // alignment of the string
 		rm_tail_zero: tail_zeros // false // remove the tail zeros from floats
 	}
 

vlib/encoding/csv/README_csv_reader.md

@@ -259,8 +259,8 @@ import encoding.csv
 fn main() {
 	file_path := 'big2.csv'
 	mut csvr := csv.csv_reader(
-		file_path:    file_path // path to the file CSV
-		mem_buf_size: 1024 * 1024 * 64 // we set 64MByte of buffer for this file
+		file_path:    file_path                     // path to the file CSV
+		mem_buf_size: 1024 * 1024 * 64              // we set 64MByte of buffer for this file
 		end_line_len: csv.endline_crlf_len // we are using a windows text file
 	)!
 	// The data will be saved in this array
@@ -330,9 +330,9 @@ fn main() {
 	mut csvr := csv.csv_reader(
 		scr_buf:      txt.str // string pointer
 		scr_buf_len:  txt.len // string length
-		comment:      `#` // line starting with # will be ignored
-		quote:        `'` // char used for quotes
-		quote_remove: true // remove quotes from the cells
+		comment:      `#`     // line starting with # will be ignored
+		quote:        `'`     // char used for quotes
+		quote_remove: true    // remove quotes from the cells
 	)!
 
 	// scan all rows, csvr.csv_map.len contain the valid

vlib/v/ast/ast.v

@@ -455,10 +455,11 @@ pub mut:
 // `field1: val1`
 pub struct StructInitField {
 pub:
-	pos           token.Pos
-	name_pos      token.Pos
-	comments      []Comment
-	next_comments []Comment
+	pos              token.Pos
+	name_pos         token.Pos
+	comments         []Comment
+	next_comments    []Comment
+	has_prev_newline bool
 pub mut:
 	expr          Expr   // `val1`
 	name          string // 'field1'

vlib/v/fmt/align.v

@@ -10,18 +10,26 @@ mut:
 }
 
 @[params]
-struct AddInfoConfig {
+struct AlignConfig {
 pub:
-	use_threshold bool
-	threshold     int = 25
+	ignore_newline bool // ignore newline or comment
+	use_threshold  bool
+	threshold      int = 25
 }
 
 struct FieldAlign {
+	cfg AlignConfig
 mut:
 	infos   []AlignInfo
 	cur_idx int
 }
 
+fn new_field_align(cfg AlignConfig) FieldAlign {
+	return FieldAlign{
+		cfg: cfg
+	}
+}
+
 fn (mut fa FieldAlign) add_new_info(len int, line int) {
 	fa.infos << AlignInfo{
 		line_nr: line
@@ -30,24 +38,24 @@ fn (mut fa FieldAlign) add_new_info(len int, line int) {
 }
 
 @[direct_array_access]
-fn (mut fa FieldAlign) add_info(len int, line int, cfg AddInfoConfig) {
+fn (mut fa FieldAlign) add_info(len int, line int) {
 	if fa.infos.len == 0 {
 		fa.add_new_info(len, line)
 		return
 	}
 	i := fa.infos.len - 1
-	if line - fa.infos[i].line_nr > 1 {
+	if !fa.cfg.ignore_newline && line - fa.infos[i].line_nr > 1 {
 		fa.add_new_info(len, line)
 		return
 	}
-	if cfg.use_threshold {
+	if fa.cfg.use_threshold {
 		len_diff := if fa.infos[i].max_len >= len {
 			fa.infos[i].max_len - len
 		} else {
 			len - fa.infos[i].max_len
 		}
 
-		if len_diff >= cfg.threshold {
+		if len_diff >= fa.cfg.threshold {
 			fa.add_new_info(len, line)
 			return
 		}
@@ -64,7 +72,6 @@ fn (mut fa FieldAlign) max_len(line_nr int) int {
 	}
 	if fa.cur_idx < fa.infos.len {
 		return fa.infos[fa.cur_idx].max_len
-	} else {
-		return 0
 	}
+	return 0
 }

vlib/v/fmt/fmt.v

@@ -1039,28 +1039,28 @@ pub fn (mut f Fmt) enum_decl(node ast.EnumDecl) {
 	f.writeln('enum ${name} {')
 	f.comments(node.comments, same_line: true, level: .indent)
 
-	mut value_aligns := FieldAlign{}
-	mut attr_aligns := FieldAlign{}
-	mut comment_aligns := FieldAlign{}
+	mut value_align := new_field_align()
+	mut attr_align := new_field_align()
+	mut comment_align := new_field_align()
 	for field in node.fields {
 		if field.has_expr {
-			value_aligns.add_info(field.name.len, field.pos.line_nr)
+			value_align.add_info(field.name.len, field.pos.line_nr)
 		}
 		attrs_len := inline_attrs_len(field.attrs)
 		if field.attrs.len > 0 {
 			if field.has_expr {
-				attr_aligns.add_info(field.expr.str().len + 2, field.pos.line_nr)
+				attr_align.add_info(field.expr.str().len + 2, field.pos.line_nr)
 			} else {
-				attr_aligns.add_info(field.name.len, field.pos.line_nr)
+				attr_align.add_info(field.name.len, field.pos.line_nr)
 			}
 		}
 		if field.comments.len > 0 {
 			if field.attrs.len > 0 {
-				comment_aligns.add_info(attrs_len, field.pos.line_nr)
+				comment_align.add_info(attrs_len, field.pos.line_nr)
 			} else if field.has_expr {
-				comment_aligns.add_info(field.expr.str().len + 2, field.pos.line_nr)
+				comment_align.add_info(field.expr.str().len + 2, field.pos.line_nr)
 			} else {
-				comment_aligns.add_info(field.name.len, field.pos.line_nr)
+				comment_align.add_info(field.name.len, field.pos.line_nr)
 			}
 		}
 	}
@@ -1071,28 +1071,28 @@ pub fn (mut f Fmt) enum_decl(node ast.EnumDecl) {
 		}
 		f.write('\t${field.name}')
 		if field.has_expr {
-			f.write(strings.repeat(` `, value_aligns.max_len(field.pos.line_nr) - field.name.len))
+			f.write(strings.repeat(` `, value_align.max_len(field.pos.line_nr) - field.name.len))
 			f.write(' = ')
 			f.expr(field.expr)
 		}
 		attrs_len := inline_attrs_len(field.attrs)
 		if field.attrs.len > 0 {
 			if field.has_expr {
-				f.write(strings.repeat(` `, attr_aligns.max_len(field.pos.line_nr) - field.expr.str().len - 2))
+				f.write(strings.repeat(` `, attr_align.max_len(field.pos.line_nr) - field.expr.str().len - 2))
 			} else {
-				f.write(strings.repeat(` `, attr_aligns.max_len(field.pos.line_nr) - field.name.len))
+				f.write(strings.repeat(` `, attr_align.max_len(field.pos.line_nr) - field.name.len))
 			}
 			f.write(' ')
 			f.single_line_attrs(field.attrs, same_line: true)
 		}
 		// f.comments(field.comments, same_line: true, has_nl: false, level: .indent)
 		if field.comments.len > 0 {
 			if field.attrs.len > 0 {
-				f.write(strings.repeat(` `, comment_aligns.max_len(field.pos.line_nr) - attrs_len))
+				f.write(strings.repeat(` `, comment_align.max_len(field.pos.line_nr) - attrs_len))
 			} else if field.has_expr {
-				f.write(strings.repeat(` `, comment_aligns.max_len(field.pos.line_nr) - field.expr.str().len - 2))
+				f.write(strings.repeat(` `, comment_align.max_len(field.pos.line_nr) - field.expr.str().len - 2))
 			} else {
-				f.write(strings.repeat(` `, comment_aligns.max_len(field.pos.line_nr) - field.name.len))
+				f.write(strings.repeat(` `, comment_align.max_len(field.pos.line_nr) - field.name.len))
 			}
 			f.write(' ')
 			f.comments(field.comments, same_line: true, has_nl: false)
@@ -1396,27 +1396,27 @@ pub fn (mut f Fmt) interface_decl(node ast.InterfaceDecl) {
 		}
 	}
 
-	mut type_aligns := FieldAlign{}
-	mut comment_aligns := FieldAlign{}
-	mut default_expr_aligns := FieldAlign{}
-	mut attr_aligns := FieldAlign{}
+	mut type_align := new_field_align()
+	mut comment_align := new_field_align()
+	mut default_expr_align := new_field_align()
+	mut attr_align := new_field_align()
 	mut field_types := []string{cap: node.fields.len}
 
 	// Calculate the alignments first
-	f.calculate_alignment(node.fields, mut type_aligns, mut comment_aligns, mut default_expr_aligns, mut
-		attr_aligns, mut field_types)
+	f.calculate_alignment(node.fields, mut type_align, mut comment_align, mut default_expr_align, mut
+		attr_align, mut field_types)
 
 	// TODO: alignment, comments, etc.
 	for field in immut_fields {
-		f.interface_field(field, type_aligns.max_len(field.pos.line_nr))
+		f.interface_field(field, type_align.max_len(field.pos.line_nr))
 	}
 	for method in immut_methods {
 		f.interface_method(method)
 	}
 	if mut_fields.len + mut_methods.len > 0 {
 		f.writeln('mut:')
 		for field in mut_fields {
-			f.interface_field(field, type_aligns.max_len(field.pos.line_nr))
+			f.interface_field(field, type_align.max_len(field.pos.line_nr))
 		}
 		for method in mut_methods {
 			f.interface_method(method)
@@ -1432,8 +1432,8 @@ enum AlignState {
 	has_everything
 }
 
-pub fn (mut f Fmt) calculate_alignment(fields []ast.StructField, mut type_aligns FieldAlign, mut comment_aligns FieldAlign,
-	mut default_expr_aligns FieldAlign, mut attr_aligns FieldAlign, mut field_types []string) {
+pub fn (mut f Fmt) calculate_alignment(fields []ast.StructField, mut type_align FieldAlign, mut comment_align FieldAlign,
+	mut default_expr_align FieldAlign, mut attr_align FieldAlign, mut field_types []string) {
 	// Calculate the alignments first
 	mut prev_state := AlignState.plain
 	for field in fields {
@@ -1442,45 +1442,36 @@ pub fn (mut f Fmt) calculate_alignment(fields []ast.StructField, mut type_aligns
 		field_types << ft
 		attrs_len := inline_attrs_len(field.attrs)
 		end_pos := field.pos.pos + field.pos.len
-		type_aligns.add_info(field.name.len, field.pos.line_nr)
+		type_align.add_info(field.name.len, field.pos.line_nr)
 		if field.has_default_expr {
-			default_expr_aligns.add_info(ft.len, field.pos.line_nr,
-				use_threshold: true
-			)
+			default_expr_align.add_info(ft.len, field.pos.line_nr)
 		}
 		if field.attrs.len > 0 {
-			attr_aligns.add_info(ft.len, field.pos.line_nr, use_threshold: true)
+			attr_align.add_info(ft.len, field.pos.line_nr)
 		}
 		for comment in field.comments {
 			if comment.pos.pos >= end_pos {
 				if comment.pos.line_nr == field.pos.line_nr {
 					if field.attrs.len > 0 {
 						if prev_state != AlignState.has_attributes {
-							comment_aligns.add_new_info(attrs_len, comment.pos.line_nr)
+							comment_align.add_new_info(attrs_len, comment.pos.line_nr)
 						} else {
-							comment_aligns.add_info(attrs_len, comment.pos.line_nr,
-								use_threshold: true
-							)
+							comment_align.add_info(attrs_len, comment.pos.line_nr)
 						}
 						prev_state = AlignState.has_attributes
 					} else if field.has_default_expr {
 						if prev_state != AlignState.has_default_expression {
-							comment_aligns.add_new_info(field.default_expr.str().len + 2,
+							comment_align.add_new_info(field.default_expr.str().len + 2,
 								comment.pos.line_nr)
 						} else {
-							comment_aligns.add_info(field.default_expr.str().len + 2,
-								comment.pos.line_nr,
-								use_threshold: true
-							)
+							comment_align.add_info(field.default_expr.str().len + 2, comment.pos.line_nr)
 						}
 						prev_state = AlignState.has_default_expression
 					} else {
 						if prev_state != AlignState.has_everything {
-							comment_aligns.add_new_info(ft.len, comment.pos.line_nr)
+							comment_align.add_new_info(ft.len, comment.pos.line_nr)
 						} else {
-							comment_aligns.add_info(ft.len, comment.pos.line_nr,
-								use_threshold: true
-							)
+							comment_align.add_info(ft.len, comment.pos.line_nr)
 						}
 						prev_state = AlignState.has_everything
 					}