ComparableGenerator, which automatically implements IComparable, has been released.

Atsushi Nakamura — Tue, 16 Feb 2021 04:59:58 +0000

Implementing IComparable correctly is somewhat tedious. It is even more tedious to test each time.

ComparableGenerator provides a high quality implementation of IComparable.

Install-Package ComparableGenerator

Introduction

For example, if you want to sort the Employee class by the Id property, declare the Comparable and CompareBy attributes.

using ComparableGenerator;

namespace GenerateSource
{
    [Comparable]
    public partial struct Employee
    {
        [CompareBy]
        public int Id { get; set; }
    }
}

The ComparableGenerator generates the following code.

using System;

namespace GenerateSource
{
    public partial struct Employee : IComparable, IComparable<Employee>
    {
#nullable disable
        public int CompareTo(object other)
#nullable enable
        {
            if (other is null) return 1;

            if (other is Employee concreteObject)
            {
                return CompareTo(concreteObject);
            }

            throw new ArgumentException("Object is not a GenerateSource.Employee.");
        }

        public int CompareTo(Employee other)
        {
            return Id.CompareTo(other.Id);
        }
    }
}

Of course, it also supports classes and multiple members.

[Comparable]
public partial class ClassObject
{
    [CompareBy]
    public int Value1 { get; set; }

    [CompareBy(Priority = 2)]
    public int Value2;

    [CompareBy(Priority = 1)]
    public int Value3 { get; set; }
}

When declaring CompareBy for multiple members, specify a unique priority for each.

Here is the code generated in this case.

Environments

Supports C# 9.0 and higher

Constraints

Inner classes are not supported.
Comparable and CompareBy contained in different "partial sources" are not supported.

FluentTextTable, "full-width supported" text table library for .NET is now available!

Atsushi Nakamura — Fri, 24 Jul 2020 23:10:41 +0000

Have you ever just wanted to output .NET object out to console?

What's this?

FluentTextTable is a flexible and easy to use "full-width supported" text table library for .NET.

var users = new[]
{
    new User {Id = 1, EnglishName = "Bill Gates", JapaneseName = "ビル・ゲイツ", Birthday = DateTime.Parse("1955/10/28")},
    new User {Id = 2, EnglishName = "Steven Jobs", JapaneseName = "スティーブ・ジョブズ", Birthday = DateTime.Parse("1955/2/24")}
};
Build
    .TextTable<User>()
    .WriteLine(users);

It can be used for debugging and simple tools.

Format complex tables with ease and fluently.

Build
    .TextTable<User>(builder =>
    {
        builder
            .Borders.Horizontals.AllStylesAs("-")
            .Borders.HeaderHorizontal.AllStylesAs("=")
            .Columns.Add(x => x.Id).HorizontalAlignmentAs(HorizontalAlignment.Right)
            .Columns.Add(x => x.Name).VerticalAlignmentAs(VerticalAlignment.Center)
            .Columns.Add(x => x.Birthday).VerticalAlignmentAs(VerticalAlignment.Bottom).FormatAs("{0:yyyy/MM/dd}")
            .Columns.Add(x => x.Occupations).FormatAs("- {0}");
    })
    .WriteLine(users);

And this supports markdowns as well.

Build
    .MarkdownTable<User>()
    .WriteLine(users);

Quick Start

NET Framework 4.0 (or higher) and .NET Standard 2.0 (or higher) are supported. Install and use it from NuGet.

> Install-Package FluentTextTable

Define the class to be output.

public class User
{
    public int Id { get; set; }
    public string EnglishName { get; set; }
    public string JapaneseName { get; set; }
    public DateTime Birthday;
}

Use the Build class to create a table for the output class.

By default, all public properties and fields are included in the output.

var table = Build.TextTable<User>();

Create and output an object corresponding to a row.

var users = new[]
{
    new User {Id = 1, EnglishName = "Bill Gates", JapaneseName = "ビル・ゲイツ", Birthday = DateTime.Parse("1955/10/28")},
    new User {Id = 2, EnglishName = "Steven Jobs", JapaneseName = "スティーブ・ジョブズ", Birthday = DateTime.Parse("1955/2/24")}
};
Build
    .TextTable<User>()
    .WriteLine(users);

Detailed settings

See the Github documentation.

https://github.com/nuitsjp/FluentTextTable#table-of-contents

Thank you!

DEV Community: Atsushi Nakamura