# TodoMarker

`todo_marker` is a Standalone Ruby gem designed to help developers manage TODO comments in their code. It scans a directory for TODO comments in Ruby files and generates a `TODO.md` file summarizing all the tasks.

## Features

- Scans Ruby files for TODO comments.
- Generates a `TODO.md` file with a summary of all TODO comments.
- Supports styled TODO comments for better organization.

## Installation

To install the `todo_marker` gem, install it manually via the command line:

```sh
gem install todo_marker
```

## Usage
### Command-Line Interface

The `todo_marker` gem provides a very simple command-line interface for generating the `TODO.md` file.

To generate a `TODO.md` file, run the following command:

```sh
todo_marker <directory>
```

Replace `<directory>` with the path to the directory you want to scan.

### Example:

```sh
todo_marker ./my_project
```

This command will create a `TODO.md` file in the specified directory, listing all TODO comments found in Ruby files.

## Supported TODO Comment Formats

The todo_marker gem supports various styles for TODO comments to help organize tasks effectively. The supported formats include:

1. Basic TODO Comment:

```ruby
# !!TODO!! "Your task description here"
```

2. Title1 Style:

```ruby
# !!TODO!! style: title1 "Title for a section"
```

3. Title2 Style:

```ruby
# !!TODO!! style: title2 "Title for a subsection"
```

4. Title3 Style:

```ruby
# !!TODO!! style: title3 "Title for a sub-subsection"
```

5. Sublist Style:

```ruby
# !!TODO!! style: sublist "Subtask description"
```

### Example

Here's an example of a Ruby file with various TODO comments:

```ruby
# !!TODO!! "Complete method implementation"
def example_method
  # implementation needed
end

# !!TODO!! style: title1 "Main Section"
# !!TODO!! "Main task"
# !!TODO!! style: sublist "Subtask 1"
# !!TODO!! style: sublist "Subtask 2"

# !!TODO!! "Normal TODO item"
```

Running the todo_marker command on this directory will generate the following `TODO.md` file:

```md
# TODO List

- Complete method implementation
  (./file1.rb:1)
# Main Section
- Main task
  - Subtask 1
  - Subtask 2
- Normal TODO item
  (./file1.rb:9)
```

## Contributing

We welcome contributions to improve the todo_marker gem! Feel free to fork the repository and submit pull requests. Make sure to follow the contribution guidelines.

## Issues

If you encounter any issues or have questions, please open an issue in the Git repository.

## License

This project is licensed under the GNU V3.0 License. See the [LICENSE](LICENSE) file for details.