chore: more development

Author: DiogoRibeiro7

.github/workflows/todo.yml

@@ -1,4 +1,4 @@
-name: Smart TODO Check
+name: Smart TODO Tracker
 
 on:
   push:
@@ -7,6 +7,10 @@ on:
 jobs:
   smart-todo:
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      issues: write
+
     steps:
       - uses: actions/checkout@v3
 
@@ -22,3 +26,18 @@ jobs:
         uses: ./
         with:
           repo-token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
+          report: true
+
+      - name: Upload TODO report
+        uses: actions/upload-artifact@v3
+        with:
+          name: todo-report
+          path: TODO_REPORT.md
+
+      - name: Commit TODO report
+        run: |
+          git config --global user.name "github-actions[bot]"
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
+          git add TODO_REPORT.md
+          git commit -m "chore(report): update TODO report" || echo "No changes"
+          git push

.gitignore

@@ -1,3 +1,6 @@
 node_modules/
 dist/
-.env
+.env
+
+
+TODO_REPORT.md

ROADMAP.md

@@ -44,8 +44,9 @@ A smart GitHub Action that detects, classifies, and transforms inline TODOs in y
 
 > Provide visibility into the evolution and structure of tracked TODOs.
 
-- [ ] Markdown/HTML dashboard with summary statistics  
-  _Total TODOs, grouped by folder, priority, author (`git blame`)_
+- [X] Markdown/HTML dashboard with summary statistics  
+  _Total TODOs, grouped by folder, priority, author (`git blame`) — **now sorted by `priority` and `due` date**_
+
 - [ ] TODO history tracking (added/removed/modified)
 - [ ] Due date notifications or PR comments
 
@@ -68,101 +69,3 @@ A smart GitHub Action that detects, classifies, and transforms inline TODOs in y
 - Clean architecture and modularity are core principles from day one.
 - LLM functionality will be optional and clearly separated from core logic.
 - Built with automation, extensibility, and developer workflows in mind.
-
----
-
-# 🚀 Roadmap for TODO Issue Tracker 2.0
-
-This project aims to build an intelligent GitHub Action that scans your codebase for TODOs, classifies them, and transforms them into contextualized GitHub Issues — with semantic analysis and multi-platform integration.
-
----
-
-## 🧱 Phase 1: Foundations and Parity with the Original Project
-
-🎯 Goal: Recreate the original functionality with clean, modular, and testable code.
-
-- [ ] Create the base project structure
-  - `src/` folder for source code
-  - Subfolders: `core/`, `parser/`, `tasks/`, `templates/`, etc.
-
-- [ ] Implement TODO parser
-  - Detect `TODO`, `FIXME`, `BUG`, etc. comments
-  - Support for multiple languages (`.js`, `.ts`, `.py`, `.go`, etc.)
-
-- [ ] Initial task system: GitHub Issues
-  - Create, update, and remove issues based on detected TODOs
-
-- [ ] Templating system for issue creation
-  - Customizable titles and descriptions via templates
-
-- [ ] Functional GitHub Action workflow
-  - `action.yml` definition file
-  - Example usage in `.github/workflows/todo.yml`
-
-- [ ] Unit testing with Jest or Vitest
-
----
-
-## 🧠 Phase 2: Intelligence and Semantics
-
-🎯 Goal: Make the system smarter by leveraging LLMs and contextual awareness.
-
-- [ ] Automatic TODO classification
-  - Use LLMs or heuristics to classify as `bug`, `enhancement`, `refactor`, etc.
-
-- [ ] Auto-generate issue titles and descriptions using LLMs  
-  _Example: `Review sorting algorithm` → `Optimize Sorting Algorithm for Edge Cases`_
-
-- [ ] Extract `due date` and `priority` via inline metadata parsing  
-  _Example: `TODO(priority=high, due=2025-06-01): improve this logic`_
-
----
-
-## 🌍 Phase 3: Extended Support
-
-🎯 Goal: Make the project adaptable to diverse environments and workflows.
-
-- [ ] Support for multiple task management platforms  
-  _GitHub, Jira, Notion, Trello, Linear (via APIs)_
-
-- [ ] Internationalization (i18n)  
-  _Detect TODOs written in different languages_
-
-- [ ] Support for additional file types  
-  _`.ipynb`, `.yaml`, `.md`, `.json`, `.xml`, and more_
-
----
-
-## 📊 Phase 4: Analysis and Reporting
-
-🎯 Goal: Provide visibility into the state and evolution of TODOs.
-
-- [ ] Markdown/HTML dashboard with metrics  
-  _Total TODOs, grouped by folder, priority, author (`git blame`)_
-
-- [ ] TODO history tracking  
-  _Track when TODOs are added, removed, or changed over time_
-
-- [ ] Notifications and reminders  
-  _Comment on PRs or issues when due dates are approaching_
-
----
-
-## 🔁 Phase 5: Optimizations and Contributions
-
-🎯 Goal: Ensure quality, performance, and ease of collaboration.
-
-- [ ] Plugin-based modular architecture
-- [ ] CLI support (standalone usage outside GitHub Actions)
-- [ ] Test coverage >90%
-- [ ] Full documentation with usage examples
-- [ ] Publish to GitHub Marketplace as an official Action
-
----
-
-## 📌 Notes
-
-- Modularity, testability, and code clarity are priorities from day one.
-- LLM integration will be optional and cleanly decoupled from core logic.
-- Designed with automation, extensibility, and developer experience in mind.
-

action.yml

@@ -4,8 +4,12 @@ author: 'Diogo Ribeiro'
 
 inputs:
   repo-token:
-    description: 'GitHub token com permissão para criar issues'
     required: true
+    description: GitHub token to create issues
+  report:
+    required: false
+    description: Whether to generate a TODO markdown report
+    default: 'false'
 
 runs:
   using: 'node20'

package.json

@@ -20,7 +20,8 @@
   "license": "MIT",
   "dependencies": {
     "@actions/core": "^1.10.0",
-    "@actions/github": "^5.1.1"
+    "@actions/github": "^5.1.1",
+    "@octokit/rest": "^21.1.1"
   },
   "devDependencies": {
     "@types/node": "^20.11.17",

src/ActionMain.ts

@@ -3,56 +3,14 @@ import * as github from '@actions/github';
 import path from 'path';
 import { extractTodosFromDir } from './parser/extractTodosFromDir';
 import { TodoItem } from './parser/types';
-
-const LABELS_BY_TAG: Record<string, string[]> = {
-  TODO: ['enhancement'],
-  FIXME: ['bug'],
-  BUG: ['bug'],
-  HACK: ['technical-debt']
-};
-
-const DEFAULT_LABEL_COLOR = 'cccccc';
-const LABEL_COLORS: Record<string, string> = {
-  bug: 'd73a4a',
-  enhancement: 'a2eeef',
-  todo: 'ededed',
-  'technical-debt': 'f9d0c4'
-};
-
-function labelsFromMetadata(metadata?: Record<string, string>): string[] {
-  if (!metadata) return [];
-  return Object.entries(metadata).map(([key, value]) => `${key}:${value}`);
-}
-
-async function ensureLabelExists(
-  octokit: ReturnType<typeof github.getOctokit>,
-  owner: string,
-  repo: string,
-  label: string
-) {
-  try {
-    await octokit.rest.issues.getLabel({ owner, repo, name: label });
-  } catch (err: any) {
-    if (err.status === 404) {
-      const base = label.toLowerCase().split(':')[0];
-      const color = LABEL_COLORS[base] || DEFAULT_LABEL_COLOR;
-      await octokit.rest.issues.createLabel({
-        owner,
-        repo,
-        name: label,
-        color,
-        description: 'Auto-created by smart-todo-action'
-      });
-      core.info(`🏷️ Created label "${label}"`);
-    } else {
-      core.warning(`⚠️ Failed to check/create label "${label}": ${err.message}`);
-    }
-  }
-}
+import { getExistingIssueTitles, createIssueIfNeeded } from './core/issueManager';
+import { generateMarkdownReport } from './core/report';
+import { limitTodos, todoKey } from './core/todoUtils';
 
 async function run(): Promise<void> {
   try {
     const token = core.getInput('repo-token', { required: true });
+    const generateReport = core.getInput('report') === 'true';
     const workspace = process.env.GITHUB_WORKSPACE || '.';
 
     const todos: TodoItem[] = extractTodosFromDir(workspace);
@@ -61,36 +19,25 @@ async function run(): Promise<void> {
 
     core.info(`🔍 Found ${todos.length} TODOs`);
 
-    const MAX_ISSUES = 5;
-    const todosToCreate = todos
-      .filter(todo => todo.text && todo.text.length > 5)
-      .slice(0, MAX_ISSUES);
+    const existingTitles = await getExistingIssueTitles(octokit, owner, repo);
 
-    for (const todo of todosToCreate) {
-      const title = `[${todo.tag}] ${todo.text}`;
-      const body = `Found in \`${todo.file}:${todo.line}\`\n\n\`\`\`\n${todo.text}\n\`\`\``;
-      const tag = todo.tag.toUpperCase();
-      const baseLabels = LABELS_BY_TAG[tag] || ['todo'];
-      const metaLabels = labelsFromMetadata(todo.metadata);
-      const labels = [...baseLabels, ...metaLabels];
+    const seenKeys = new Set<string>();
+    const uniqueTodos = todos.filter(todo => {
+      const key = todoKey(todo);
+      if (seenKeys.has(key)) return false;
+      seenKeys.add(key);
+      return true;
+    });
 
-      for (const label of labels) {
-        await ensureLabelExists(octokit, owner, repo, label);
-      }
+    const todosToCreate = limitTodos(uniqueTodos, 5);
 
-      try {
-        await octokit.rest.issues.create({
-          owner,
-          repo,
-          title,
-          body,
-          labels
-        });
+    for (const todo of todosToCreate) {
+      await createIssueIfNeeded(octokit, owner, repo, todo, existingTitles);
+    }
 
-        core.info(`✅ Created issue with labels [${labels.join(', ')}]: ${title}`);
-      } catch (err: any) {
-        core.warning(`⚠️ Failed to create issue for: ${title} — ${err.message}`);
-      }
+    if (generateReport) {
+      generateMarkdownReport(todos);
+      core.info('📝 Generated TODO_REPORT.md');
     }
 
   } catch (error: any) {

src/core/__tests__/extractTodos.test.ts

@@ -0,0 +1,46 @@
+import { describe, it, expect } from 'vitest';
+import { extractTodosFromFile } from '../../parser/extractTodos'; // Ensure this file exists at the specified path
+import { TodoItem } from '../../parser/types';
+
+
+
+describe('extractTodos', () => {
+  it('extracts simple TODOs with //', () => {
+    const content = `// TODO: clean this up\nconst a = 1;`;
+    const todos = extractTodosFromFile(content);
+    expect(todos.length).toBe(1);
+    expect(todos[0].text).toBe('clean this up');
+    expect(todos[0].tag).toBe('TODO');
+    expect(todos[0].line).toBe(1);
+  });
+
+  it('extracts multiple tags', () => {
+    const content = `// BUG: crashes\n# FIXME: something wrong`;
+    const todos = extractTodosFromFile(content);
+    expect(todos.length).toBe(2);
+    expect(todos.map(t => t.tag)).toEqual(['BUG', 'FIXME']);
+  });
+
+  it('extracts metadata key=value pairs', () => {
+    const content = `// TODO(priority=high, due=2025-06-01): fix it`;
+    const todos = extractTodosFromFile(content);
+    expect(todos.length).toBe(1);
+    expect(todos[0].metadata).toEqual({
+      priority: 'high',
+      due: '2025-06-01'
+    });
+  });
+
+  it('supports HTML comments', () => {
+    const content = `<!-- TODO: fix layout -->`;
+    const todos = extractTodosFromFile(content);
+    expect(todos.length).toBe(1);
+    expect(todos[0].tag).toBe('TODO');
+  });
+
+  it('returns empty list if no TODOs are found', () => {
+    const content = `const x = 5; // just a comment`;
+    const todos = extractTodosFromFile(content);
+    expect(todos.length).toBe(0);
+  });
+});

src/core/__tests__/extractTodosFromDir.test.ts

@@ -0,0 +1,28 @@
+import { describe, it, expect } from 'vitest';
+import path from 'path';
+import { extractTodosFromDir } from '../../parser/extractTodosFromDir';
+
+describe('extractTodosFromDir', () => {
+  const base = path.join(__dirname, 'fixtures');
+
+  it('should extract TODOs from supported files recursively', () => {
+    const todos = extractTodosFromDir(base);
+    expect(todos.length).toBe(2);
+
+    const texts = todos.map(t => t.text);
+    expect(texts).toContain('Refactor this module');
+    expect(texts).toContain('Handle edge case');
+
+    const tags = todos.map(t => t.tag);
+    expect(tags).toContain('TODO');
+    expect(tags).toContain('FIXME');
+  });
+
+  it('should include correct file and line information', () => {
+    const todos = extractTodosFromDir(base);
+    const one = todos.find(t => t.text.includes('Refactor'));
+    expect(one?.file.endsWith('one-file.ts')).toBe(true);
+    expect(typeof one?.line).toBe('number');
+    expect(one?.line).toBeGreaterThan(0);
+  });
+});

src/core/__tests__/fixtures/nested/inner.py

@@ -0,0 +1,2 @@
+# FIXME: Handle edge case
+print("Running")

src/core/__tests__/fixtures/one-file.ts

@@ -0,0 +1,2 @@
+// TODO: Refactor this module
+export const a = 42;