Skip to content

pippinmole/CsvMole.NET

Repository files navigation


Logo

CsvMole.NET

A source generated CSV Parser for .NET

Report Bug · Request Feature

Getting Started

There is currently no package on NuGet, but you can clone the repo and build the project yourself.

(back to top)

Usage

// Define your parser. Make sure the class and method definitions are partial.
[CsvParser]
public partial class CustomParser
{
    public partial IEnumerable<CustomModel> Parse(StringReader stringReader, CsvOptions? options);
}

// Define your model
[CsvDelimiter(",")] // If you don't define this attribute, it will default to ","
public sealed class CustomModel
{
    [CsvOrder(0)]
    public string Id { get; set; } = null!;

    [CsvOrder(1)]
    [CsvConverter(typeof(CsvDateTimeConverter))]
    public DateTime? Date { get; set; }
}

// Use your parser
var csv = "Id,Date\n1,2021-01-01";
var stringReader = new StringReader(csv);
var parser = new CustomParser();

var models = parser.Parse(stringReader, null);

foreach (var model in models)
{
    Console.WriteLine(model.Id);
    Console.WriteLine(model.Date);
}

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

About

A source generated CSV parser for .NET projects

Resources

License

Stars

Watchers

Forks

Languages