Merge pull request #300 from olekukonko/pie

Implement MergeCells ByColumn

Author: olekukonko

MIGRATION.md

@@ -520,7 +520,7 @@ func main() {
 		tablewriter.WithConfig(tablewriter.Config{
 			Header: tw.CellConfig{Alignment: tw.CellAlignment{Global: tw.AlignCenter}},
 			Row: tw.CellConfig{
-				Formatting: tw.CellFormatting{MergeMode: tw.MergeHierarchical},
+				Merging: tw.CellMerging{Mode: tw.MergeHierarchical},
 				Alignment:  tw.CellAlignment{Global: tw.AlignLeft},
 			},
 		}),
@@ -579,8 +579,8 @@ func main() {
 		})),
 		tablewriter.WithConfig(tablewriter.Config{
 			Row: tw.CellConfig{
-				Formatting: tw.CellFormatting{MergeMode: tw.MergeBoth},
-				Alignment:  tw.CellAlignment{PerColumn: []tw.Align{tw.Skip, tw.Skip, tw.AlignRight, tw.AlignLeft}},
+				Merging:   tw.CellMerging{Mode: tw.MergeBoth},
+				Alignment: tw.CellAlignment{PerColumn: []tw.Align{tw.Skip, tw.Skip, tw.AlignRight, tw.AlignLeft}},
 			},
 
 			Footer: tw.CellConfig{
@@ -806,12 +806,12 @@ func main() {
 		tablewriter.WithRenderer(renderer.NewHTML(htmlCfg)),
 		tablewriter.WithConfig(tablewriter.Config{
 			Header: tw.CellConfig{
-				Formatting: tw.CellFormatting{MergeMode: tw.MergeHorizontal}, // Merge identical header cells
-				Alignment:  tw.CellAlignment{Global: tw.AlignCenter},
+				Merging:   tw.CellMerging{Mode: tw.MergeHorizontal}, // Merge identical header cells
+				Alignment: tw.CellAlignment{Global: tw.AlignCenter},
 			},
 			Row: tw.CellConfig{
-				Formatting: tw.CellFormatting{MergeMode: tw.MergeHorizontal}, // Merge identical row cells
-				Alignment:  tw.CellAlignment{Global: tw.AlignLeft},
+				Merging:   tw.CellMerging{Mode: tw.MergeHorizontal}, // Merge identical row cells
+				Alignment: tw.CellAlignment{Global: tw.AlignLeft},
 			},
 			Footer: tw.CellConfig{Alignment: tw.CellAlignment{Global: tw.AlignRight}},
 		}),

README.md

@@ -21,13 +21,11 @@ func main() {
 
 	cnf := tablewriter.Config{
 		Header: tw.CellConfig{
-			Formatting: tw.CellFormatting{Alignment: tw.AlignCenter},
+			Alignment: tw.CellAlignment{Global: tw.AlignCenter},
 		},
 		Row: tw.CellConfig{
-			Formatting: tw.CellFormatting{
-				MergeMode: tw.MergeHierarchical,
-				Alignment: tw.AlignLeft,
-			},
+			Merging:   tw.CellMerging{Mode: tw.MergeHierarchical},
+			Alignment: tw.CellAlignment{Global: tw.AlignLeft},
 		},
 		Debug: false,
 	}

_example/symbols/main.go

@@ -135,12 +135,12 @@ func (b *ConfigBuilder) WithFooterMaxWidth(maxWidth int) *ConfigBuilder {
 	return b
 }
 
-// WithFooterMergeMode sets the merge behavior for footer cells (e.g., horizontal, hierarchical).
-// Invalid merge modes are ignored.
+// Deprecated: Use .Footer().CellMerging().WithMode(...) instead. This method will be removed in a future version.
 func (b *ConfigBuilder) WithFooterMergeMode(mergeMode int) *ConfigBuilder {
 	if mergeMode < tw.MergeNone || mergeMode > tw.MergeHierarchical {
 		return b
 	}
+	b.config.Footer.Merging.Mode = mergeMode
 	b.config.Footer.Formatting.MergeMode = mergeMode
 	return b
 }
@@ -187,12 +187,12 @@ func (b *ConfigBuilder) WithHeaderMaxWidth(maxWidth int) *ConfigBuilder {
 	return b
 }
 
-// WithHeaderMergeMode sets the merge behavior for header cells (e.g., horizontal, vertical).
-// Invalid merge modes are ignored.
+// Deprecated: Use .Header().CellMerging().WithMode(...) instead. This method will be removed in a future version.
 func (b *ConfigBuilder) WithHeaderMergeMode(mergeMode int) *ConfigBuilder {
 	if mergeMode < tw.MergeNone || mergeMode > tw.MergeHierarchical {
 		return b
 	}
+	b.config.Header.Merging.Mode = mergeMode
 	b.config.Header.Formatting.MergeMode = mergeMode
 	return b
 }
@@ -246,12 +246,12 @@ func (b *ConfigBuilder) WithRowMaxWidth(maxWidth int) *ConfigBuilder {
 	return b
 }
 
-// WithRowMergeMode sets the merge behavior for row cells (e.g., horizontal, hierarchical).
-// Invalid merge modes are ignored.
+// Deprecated: Use .Row().CellMerging().WithMode(...) instead. This method will be removed in a future version.
 func (b *ConfigBuilder) WithRowMergeMode(mergeMode int) *ConfigBuilder {
 	if mergeMode < tw.MergeNone || mergeMode > tw.MergeHierarchical {
 		return b
 	}
+	b.config.Row.Merging.Mode = mergeMode
 	b.config.Row.Formatting.MergeMode = mergeMode
 	return b
 }
@@ -285,6 +285,14 @@ func (h *HeaderConfigBuilder) Formatting() *HeaderFormattingBuilder {
 	}
 }
 
+// Merging returns a HeaderMergingBuilder for configuring cell merging.
+func (h *HeaderConfigBuilder) Merging() *HeaderMergingBuilder {
+	return &HeaderMergingBuilder{
+		parent: h,
+		config: &h.config.Merging,
+	}
+}
+
 // Padding returns a HeaderPaddingBuilder for header padding
 func (h *HeaderConfigBuilder) Padding() *HeaderPaddingBuilder {
 	return &HeaderPaddingBuilder{
@@ -341,6 +349,14 @@ func (r *RowConfigBuilder) Formatting() *RowFormattingBuilder {
 	}
 }
 
+// Merging returns a RowMergingBuilder for configuring cell merging.
+func (r *RowConfigBuilder) Merging() *RowMergingBuilder {
+	return &RowMergingBuilder{
+		parent: r,
+		config: &r.config.Merging,
+	}
+}
+
 // Padding returns a RowPaddingBuilder for row padding
 func (r *RowConfigBuilder) Padding() *RowPaddingBuilder {
 	return &RowPaddingBuilder{
@@ -397,6 +413,14 @@ func (f *FooterConfigBuilder) Formatting() *FooterFormattingBuilder {
 	}
 }
 
+// Merging returns a FooterMergingBuilder for configuring cell merging.
+func (f *FooterConfigBuilder) Merging() *FooterMergingBuilder {
+	return &FooterMergingBuilder{
+		parent: f,
+		config: &f.config.Merging,
+	}
+}
+
 // Padding returns a FooterPaddingBuilder for footer padding
 func (f *FooterConfigBuilder) Padding() *FooterPaddingBuilder {
 	return &FooterPaddingBuilder{
@@ -478,9 +502,10 @@ func (hf *HeaderFormattingBuilder) WithAutoWrap(autoWrap int) *HeaderFormattingB
 	return hf
 }
 
-// WithMergeMode sets merge mode
+// Deprecated: Use .CellMerging().WithMode(...) instead. This method will be removed in a future version.
 func (hf *HeaderFormattingBuilder) WithMergeMode(mergeMode int) *HeaderFormattingBuilder {
 	if mergeMode >= tw.MergeNone && mergeMode <= tw.MergeHierarchical {
+		hf.parent.config.Merging.Mode = mergeMode
 		hf.config.MergeMode = mergeMode
 	}
 	return hf
@@ -512,9 +537,10 @@ func (rf *RowFormattingBuilder) WithAutoWrap(autoWrap int) *RowFormattingBuilder
 	return rf
 }
 
-// WithMergeMode sets merge mode
+// Deprecated: Use .CellMerging().WithMode(...) instead. This method will be removed in a future version.
 func (rf *RowFormattingBuilder) WithMergeMode(mergeMode int) *RowFormattingBuilder {
 	if mergeMode >= tw.MergeNone && mergeMode <= tw.MergeHierarchical {
+		rf.parent.config.Merging.Mode = mergeMode
 		rf.config.MergeMode = mergeMode
 	}
 	return rf
@@ -546,14 +572,117 @@ func (ff *FooterFormattingBuilder) WithAutoWrap(autoWrap int) *FooterFormattingB
 	return ff
 }
 
-// WithMergeMode sets merge mode
+// Deprecated: Use .CellMerging().WithMode(...) instead. This method will be removed in a future version.
 func (ff *FooterFormattingBuilder) WithMergeMode(mergeMode int) *FooterFormattingBuilder {
 	if mergeMode >= tw.MergeNone && mergeMode <= tw.MergeHierarchical {
+		ff.parent.config.Merging.Mode = mergeMode
 		ff.config.MergeMode = mergeMode
 	}
 	return ff
 }
 
+// HeaderMergingBuilder configures header cell merging
+type HeaderMergingBuilder struct {
+	parent *HeaderConfigBuilder
+	config *tw.CellMerging
+}
+
+// Build returns the parent HeaderConfigBuilder.
+func (hm *HeaderMergingBuilder) Build() *HeaderConfigBuilder {
+	return hm.parent
+}
+
+// WithMode sets the merge mode (e.g., tw.MergeHorizontal).
+func (hm *HeaderMergingBuilder) WithMode(mode int) *HeaderMergingBuilder {
+	hm.config.Mode = mode
+	// Also set the deprecated field for backward compatibility
+	hm.parent.config.Formatting.MergeMode = mode
+	return hm
+}
+
+// ByColumnIndex sets specific columns to be merged by their index.
+// If not called, merging applies to all columns.
+func (hm *HeaderMergingBuilder) ByColumnIndex(indices []int) *HeaderMergingBuilder {
+	if len(indices) == 0 {
+		hm.config.ByColumnIndex = nil // nil means apply to all
+	} else {
+		mapper := tw.NewMapper[int, bool]()
+		for _, idx := range indices {
+			mapper.Set(idx, true)
+		}
+		hm.config.ByColumnIndex = mapper
+	}
+	return hm
+}
+
+// RowMergingBuilder configures row cell merging
+type RowMergingBuilder struct {
+	parent *RowConfigBuilder
+	config *tw.CellMerging
+}
+
+// Build returns the parent RowConfigBuilder.
+func (rm *RowMergingBuilder) Build() *RowConfigBuilder {
+	return rm.parent
+}
+
+// WithMode sets the merge mode (e.g., tw.MergeVertical, tw.MergeHierarchical).
+func (rm *RowMergingBuilder) WithMode(mode int) *RowMergingBuilder {
+	rm.config.Mode = mode
+	// Also set the deprecated field for backward compatibility
+	rm.parent.config.Formatting.MergeMode = mode
+	return rm
+}
+
+// ByColumnIndex sets specific columns to be merged by their index.
+// If not called, merging applies to all columns.
+func (rm *RowMergingBuilder) ByColumnIndex(indices []int) *RowMergingBuilder {
+	if len(indices) == 0 {
+		rm.config.ByColumnIndex = nil // nil means apply to all
+	} else {
+		mapper := tw.NewMapper[int, bool]()
+		for _, idx := range indices {
+			mapper.Set(idx, true)
+		}
+		rm.config.ByColumnIndex = mapper
+	}
+	return rm
+}
+
+// FooterMergingBuilder configures footer cell merging
+type FooterMergingBuilder struct {
+	parent *FooterConfigBuilder
+	config *tw.CellMerging
+}
+
+// Build returns the parent FooterConfigBuilder.
+func (fm *FooterMergingBuilder) Build() *FooterConfigBuilder {
+	return fm.parent
+}
+
+// WithMode sets the merge mode (e.g., tw.MergeHorizontal).
+func (fm *FooterMergingBuilder) WithMode(mode int) *FooterMergingBuilder {
+	fm.config.Mode = mode
+	// Also set the deprecated field for backward compatibility
+	fm.parent.config.Formatting.MergeMode = mode
+	return fm
+}
+
+// ByColumnIndex sets specific columns to be merged by their index.
+// If not called, merging applies to all columns.
+func (fm *FooterMergingBuilder) ByColumnIndex(indices []int) *FooterMergingBuilder {
+	if len(indices) == 0 {
+		fm.config.ByColumnIndex = nil // nil means apply to all
+	} else {
+		mapper := tw.NewMapper[int, bool]()
+		for _, idx := range indices {
+			mapper.Set(idx, true)
+		}
+		fm.config.ByColumnIndex = mapper
+	}
+	return fm
+}
+
 // HeaderPaddingBuilder configures header padding
 type HeaderPaddingBuilder struct {
 	parent  *HeaderConfigBuilder

config.go

@@ -7,7 +7,7 @@ require (
 	github.com/fatih/color v1.15.0
 	github.com/mattn/go-runewidth v0.0.19
 	github.com/olekukonko/errors v1.1.0
-	github.com/olekukonko/ll v0.1.1
+	github.com/olekukonko/ll v0.1.2
 	github.com/olekukonko/ts v0.0.0-20171002115256-78ecb04241c0
 )
 

go.mod

@@ -15,6 +15,8 @@ github.com/olekukonko/errors v1.1.0 h1:RNuGIh15QdDenh+hNvKrJkmxxjV4hcS50Db478Ou5
 github.com/olekukonko/errors v1.1.0/go.mod h1:ppzxA5jBKcO1vIpCXQ9ZqgDh8iwODz6OXIGKU8r5m4Y=
 github.com/olekukonko/ll v0.1.1 h1:9Dfeed5/Mgaxb9lHRAftLK9pVfYETvHn+If6lywVhJc=
 github.com/olekukonko/ll v0.1.1/go.mod h1:2dJo+hYZcJMLMbKwHEWvxCUbAOLc/CXWS9noET22Mdo=
+github.com/olekukonko/ll v0.1.2 h1:lkg/k/9mlsy0SxO5aC+WEpbdT5K83ddnNhAepz7TQc0=
+github.com/olekukonko/ll v0.1.2/go.mod h1:b52bVQRRPObe+yyBl0TxNfhesL0nedD4Cht0/zx55Ew=
 github.com/olekukonko/ts v0.0.0-20171002115256-78ecb04241c0 h1:LiZB1h0GIcudcDci2bxbqI6DXV8bF8POAnArqvRrIyw=
 github.com/olekukonko/ts v0.0.0-20171002115256-78ecb04241c0/go.mod h1:F/7q8/HZz+TXjlsoZQQKVYvXTZaFH4QRa3y+j1p7MS0=
 golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=