version: 0.0.1
name: comment
about: Replace TODO with a meaningful comment
notify: true
api:
output: replace
input: query
actions:
- tag: tag_content
run: cmd
expect: string
check: .+
action:
- when: '{query|file_path|empty:not}'
then: cat "{query|file_path|load}"
- when: '{query|empty:not}'
then: echo "{query}"
- when: 'true'
then: echo "ERROR - No input provided"
- tag: tag_comment
run: small
expect: string
action: |
[Task]
Replace EVERY "TODO" or "@todo" placeholder in the code with an intelligent technical comment in English.
[Supported Languages]
Most likely languages: Rust, Python, TypeScript, JavaScript, Java, Go, C#, Kotlin, Swift, Dart, Bash, Batch, ArkTS, Markdown.
If you are certain the code is in another language, specify it.
[Rules]
1. Do NOT modify, reformat, or optimize any actual programming code. Your only task is to update the TODO comments.
2. For file/module placeholders, write a high-level summary strictly in TWO short sentences (one per line).
3. Start each sentence directly with an action verb or noun (do NOT use "This module...", "It...").
4. For structures, fields, or methods, write a brief description (max 7 words). Do NOT start with "Represents...", "The...".
5. Keep the exact same comment syntax and structure used around the TODO placeholder.
6. Output the ENTIRE code block strictly wrapped in a markdown code fence, starting with ```language (e.g., ```java) and ending with ```.
Use the language name from the [Supported Languages] list. If unknown, use generic ```.
[Example]
```language
// Short description of the module.
// Second sentence with details.
/// Brief description of the function.
function doSomething() { ... }
```
[Code]
{tag_content}
- tag: tag_clipboard
run: value
expect: string
action: '{tag_comment|clipboard}'