TODO Info Library

TODO Info Library is a Dart library for analyzing source code files and generating reports based on TODO comments found within them. It provides functionality to generate reports in Markdown (MD), HTML, or both formats, making it versatile and adaptable to different project requirements.

Features

• Analyzes source code files to identify and extract TODO comments.
• Generates reports listing TODO items along with their priority, file location, and description.
• Supports output in Markdown (MD) and HTML formats.
• Allows customization of report generation based on user-defined preferences.

Installation

To use TODO Info Library in your Dart project, add the following dependency to your pubspec.yaml file:

dependencies:
  todo_info: ^1.0.0

Then, run flutter pub get to install the library. OR run dart pub get to install the library.

Usage

Here's an example of how to use TODO Info Library to generate reports:

import 'package:todo_info/todo_info.dart';

void main() async{
  TodoConfig.initialization(typeInform: TypeInform.both, fileName: 'todo_info');
}



@TODO("Need to implement this class, because it is important during build time", priority: TodoPriority.high)
class ExampleClass{

  @TODO("Requires async implementation", priority: TodoPriority.medium)
  void someFunction(){

    @TODO("We need to create an external function", priority: TodoPriority.critical)
    var someCode = (){};

    /// We can use on commented code but with same format
    // @TODO("It is recommended to do revisions", priority: TodoPriority.low)

  }

  @TODO("Evaluate if 'late' is required", priority: TodoPriority.normal)
  late final _exampleVariable;


}

Or generate from console:

///dart generate/report.dart <name_file> <format>
 dart generate/report.dart generated html 

Html report

Markdown report

Contributing

Contributions to TODO Info Library are welcome! Feel free to submit bug reports, feature requests, or pull requests through the GitHub repository.

License

TODO Info Library is licensed under the MIT License. See the LICENSE file for more details.