TodoTxt.Library 1.0.0

TodoTxt.Library provides a todo.txt format-compliant object representation of tasks, task lists, and task list files.

Install-Package TodoTxt.Library -Version 1.0.0
dotnet add package TodoTxt.Library --version 1.0.0
<PackageReference Include="TodoTxt.Library" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add TodoTxt.Library --version 1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: TodoTxt.Library, 1.0.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install TodoTxt.Library as a Cake Addin
#addin nuget:?package=TodoTxt.Library&version=1.0.0

// Install TodoTxt.Library as a Cake Tool
#tool nuget:?package=TodoTxt.Library&version=1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

TodoTxt.Library

Purpose

Provide a todo.txt format-compliant object representation of tasks and task lists.

Project Goals

  1. Provide a modern .NET implementation that improves on the ones used in Todotxt.net and TodoTxtLib.
  2. Fully implement the todo.txt format specifications.
  3. Include support for threshold date and arbitrary tags, on top of the standard todo.txt format specifications.
  4. Optimize classes for performance rather than in-memory footprint.
  5. Fully support data bindings, including sending notifications of property changes.
  6. Include exhaustive unit tests of the Task and TaskList objects.
  7. Target the .NET 5 for cross-platform support

Design Decisions

Task object

  1. Support a property indicating the Task's position in a file or list.
  2. Use regular expressions for todo.txt format parsing.
  3. Minimize re-running regular expression pattern matching unless the Task is modified. That is, class properties are saved to instance variables, rather than evaluated each time they are needed.
  4. Notify consumers of property changes, to support data binding.
  5. Provide methods for updating all properties.
  6. Do not provide methods for building tasks from component parts.

TaskList object

  1. Notify consumers of task list changes, by sending CollectionChanged notifications, to support data binding.
  2. Send CollectionChanged notifications when task properties are changed (for in-place modifications to the Task objects within the task list).
  3. Provide methods for reading/writing task list to file/stream.
  4. Support task list sorting.
  5. Support task list filtering.

FileBasedTaskList object

  1. Encapsulate methods for loading and saving todo.txt files.
  2. Encapsulate functionality for watching the todo.txt file for external modifications, and optionally reloading the file when it is externally modified.
  3. Support an optional auto-save function, triggered by changes to the task list.

TodoTxt.Library

Purpose

Provide a todo.txt format-compliant object representation of tasks and task lists.

Project Goals

  1. Provide a modern .NET implementation that improves on the ones used in Todotxt.net and TodoTxtLib.
  2. Fully implement the todo.txt format specifications.
  3. Include support for threshold date and arbitrary tags, on top of the standard todo.txt format specifications.
  4. Optimize classes for performance rather than in-memory footprint.
  5. Fully support data bindings, including sending notifications of property changes.
  6. Include exhaustive unit tests of the Task and TaskList objects.
  7. Target the .NET 5 for cross-platform support

Design Decisions

Task object

  1. Support a property indicating the Task's position in a file or list.
  2. Use regular expressions for todo.txt format parsing.
  3. Minimize re-running regular expression pattern matching unless the Task is modified. That is, class properties are saved to instance variables, rather than evaluated each time they are needed.
  4. Notify consumers of property changes, to support data binding.
  5. Provide methods for updating all properties.
  6. Do not provide methods for building tasks from component parts.

TaskList object

  1. Notify consumers of task list changes, by sending CollectionChanged notifications, to support data binding.
  2. Send CollectionChanged notifications when task properties are changed (for in-place modifications to the Task objects within the task list).
  3. Provide methods for reading/writing task list to file/stream.
  4. Support task list sorting.
  5. Support task list filtering.

FileBasedTaskList object

  1. Encapsulate methods for loading and saving todo.txt files.
  2. Encapsulate functionality for watching the todo.txt file for external modifications, and optionally reloading the file when it is externally modified.
  3. Support an optional auto-save function, triggered by changes to the task list.

Release Notes

# Version 1.0.0

Initial NuGet package release.

  • net5.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
1.0.0 65 4/15/2021