chore: development work

DiogoRibeiro7 · DiogoRibeiro7 · commit efae8c0e3970 · 2025-04-16T19:06:15.000+01:00
diff --git a/.github/workflows/todo.yml b/.github/workflows/todo.yml
@@ -26,6 +26,8 @@ jobs:
         uses: ./
         with:
           repo-token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
+          issue-title-template: src/templates/issueTitle.txt
+          issue-body-template: src/templates/issueBody.md
           report: true
 
       - name: Upload TODO report
@@ -40,4 +42,4 @@ jobs:
           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
+          git push
diff --git a/.github/workflows/todo/issueBody.md b/.github/workflows/todo/issueBody.md
@@ -0,0 +1,3 @@
+🗂 **File:** `{{file}}:{{line}}`
+
+📝 **Content:**
diff --git a/.github/workflows/todo/issueTitle.txt b/.github/workflows/todo/issueTitle.txt
@@ -0,0 +1 @@
+[{{tag}}] {{text}}
diff --git a/README.md b/README.md
@@ -98,4 +98,41 @@ If a label like `priority:high` or `due:2025-06-01` doesn't exist, it will be au
 - ✅ Support for issue comments and discussions
 - ✅ Customizable notification settings (e.g., email, Slack)
 - ✅ Support for issue closing and resolution tracking
-- ✅ Customizable issue lifecycle management (e.g., open, in progress, closed)
+- ✅ Customizable issue lifecycle management (e.g., open, in progress, closed)
+
+
+```plaintext
+smart-todo-action/
+├── .github/
+│   └── workflows/
+│       └── todo.yml
+│
+├── dist/
+│   └── index.js
+│
+├── src/
+│   ├── core/
+│   │   ├── issueManager.ts
+│   │   ├── labelManager.ts          # 🆕 Label logic (static + metadata + creation)
+│   │   ├── report.ts
+│   │   ├── todoUtils.ts
+│   │   └── __tests__/               # (opcional) unit tests
+│
+│   ├── parser/
+│   │   ├── extractTodosFromDir.ts
+│   │   ├── extractTodosFromFile.ts
+│   │   └── types.ts
+│
+│   ├── templates/
+│   │   ├── issueTitle.txt
+│   │   ├── issueBody.md
+│   │   └── utils.ts
+│
+│   └── ActionMain.ts
+│
+├── .gitignore
+├── action.yml
+├── package.json
+├── tsconfig.json
+└── README.md
+```
diff --git a/action.yml b/action.yml
@@ -6,15 +6,25 @@ inputs:
   repo-token:
     required: true
     description: GitHub token to create issues
+
   report:
     required: false
     description: Whether to generate a TODO markdown report
     default: 'false'
 
+  issue-title-template:
+    required: false
+    description: Optional path to custom issue title template
+
+  issue-body-template:
+    required: false
+    description: Optional path to custom issue body template
+
 runs:
   using: 'node20'
   main: 'dist/index.js'
 
 branding:
   icon: 'check-circle'
   color: 'blue'
+
diff --git a/src/ActionMain.ts b/src/ActionMain.ts
@@ -11,6 +11,8 @@ async function run(): Promise<void> {
   try {
     const token = core.getInput('repo-token', { required: true });
     const generateReport = core.getInput('report') === 'true';
+    const titleTemplatePath = core.getInput('issue-title-template');
+    const bodyTemplatePath = core.getInput('issue-body-template');
     const workspace = process.env.GITHUB_WORKSPACE || '.';
 
     const todos: TodoItem[] = extractTodosFromDir(workspace);
@@ -32,7 +34,15 @@ async function run(): Promise<void> {
     const todosToCreate = limitTodos(uniqueTodos, 5);
 
     for (const todo of todosToCreate) {
-      await createIssueIfNeeded(octokit, owner, repo, todo, existingTitles);
+      await createIssueIfNeeded(
+        octokit,
+        owner,
+        repo,
+        todo,
+        existingTitles,
+        titleTemplatePath,
+        bodyTemplatePath
+      );
     }
 
     if (generateReport) {
diff --git a/src/core/__tests__/applyTemplate.test.ts b/src/core/__tests__/applyTemplate.test.ts
@@ -0,0 +1,40 @@
+import { applyTemplate } from '../../templates/utils';
+import { describe, it, expect } from 'vitest'
+
+describe('applyTemplate', () => {
+  it('replaces simple variables', () => {
+    const template = '[{{tag}}] {{text}}';
+    const data = {
+      tag: 'TODO',
+      text: 'Implement login flow'
+    };
+
+    const result = applyTemplate(template, data);
+    expect(result).toBe('[TODO] Implement login flow');
+  });
+
+  it('ignores missing variables', () => {
+    const template = 'Priority: {{priority}}';
+    const data = {
+      tag: 'TODO'
+    };
+
+    const result = applyTemplate(template, data);
+    expect(result).toBe('Priority: ');
+  });
+
+  it('handles numeric values', () => {
+    const template = 'Line {{line}}: {{text}}';
+    const data = {
+      line: 42,
+      text: 'Optimize loop'
+    };
+
+    const result = applyTemplate(template, data);
+    expect(result).toBe('Line 42: Optimize loop');
+  });
+});
+
+
+
+
diff --git a/src/core/__tests__/commentPatterns.test.ts b/src/core/__tests__/commentPatterns.test.ts
@@ -0,0 +1,46 @@
+import { describe, it, expect } from 'vitest';
+import { extractTodosFromString } from '../../parser/extractTodosFromContent';
+
+describe('extractTodosFromString - comment support by extension', () => {
+  it('extracts from JS-style (//) for .js/.ts/.go/.java', () => {
+    const code = `// TODO: js comment\n// BUG: broken`;
+    const extensions = ['.js', '.ts', '.go', '.java'];
+
+    for (const ext of extensions) {
+      const todos = extractTodosFromString(code, ext);
+      expect(todos.length).toBe(2);
+      expect(todos[0].tag).toBe('TODO');
+      expect(todos[1].tag).toBe('BUG');
+    }
+  });
+
+  it('extracts from Python-style (#) for .py/.sh/.rb', () => {
+    const code = `# TODO: python comment\n# FIXME: fix me`;
+    const extensions = ['.py', '.sh', '.rb'];
+
+    for (const ext of extensions) {
+      const todos = extractTodosFromString(code, ext);
+      expect(todos.length).toBe(2);
+      expect(todos[0].tag).toBe('TODO');
+      expect(todos[1].tag).toBe('FIXME');
+    }
+  });
+
+  it('extracts from HTML-style (<!-- -->) for .html/.xml', () => {
+    const code = `<!-- TODO: html fix -->\n<!-- HACK: temp hack -->`;
+    const extensions = ['.html', '.xml'];
+
+    for (const ext of extensions) {
+      const todos = extractTodosFromString(code, ext);
+      expect(todos.length).toBe(2);
+      expect(todos[0].tag).toBe('TODO');
+      expect(todos[1].tag).toBe('HACK');
+    }
+  });
+
+  it('returns [] for unsupported extensions', () => {
+    const code = `// TODO: will not be parsed`;
+    const todos = extractTodosFromString(code, '.txt');
+    expect(todos).toEqual([]);
+  });
+});
diff --git a/src/core/__tests__/extractTodos.test.ts b/src/core/__tests__/extractTodos.test.ts
@@ -1,29 +1,29 @@
 import { describe, it, expect } from 'vitest';
-import { extractTodosFromFile } from '../../parser/extractTodos'; // Ensure this file exists at the specified path
+import { extractTodosFromString } from '../../parser/extractTodosFromContent';
 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);
+    const todos = extractTodosFromString(content, '.js');
     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);
+    const content = `# BUG: crashes\n# FIXME: something wrong`;
+    const todos = extractTodosFromString(content, '.py');
     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);
+    const todos = extractTodosFromString(content, '.js');
     expect(todos.length).toBe(1);
     expect(todos[0].metadata).toEqual({
       priority: 'high',
@@ -33,14 +33,14 @@ describe('extractTodos', () => {
 
   it('supports HTML comments', () => {
     const content = `<!-- TODO: fix layout -->`;
-    const todos = extractTodosFromFile(content);
+    const todos = extractTodosFromString(content, '.html');
     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);
+    const todos = extractTodosFromString(content, '.js');
     expect(todos.length).toBe(0);
   });
 });
diff --git a/src/core/__tests__/extractTodosFromContent.test.ts b/src/core/__tests__/extractTodosFromContent.test.ts
@@ -0,0 +1,31 @@
+import { extractTodosFromString } from '../../parser/extractTodosFromContent';
+import { describe, it, expect } from 'vitest'
+
+describe('extractTodosFromString', () => {
+  it('extracts multiple TODO-style tags', () => {
+    const content = `// BUG: crash here\n# FIXME: wrong\n<!-- TODO: layout -->`;
+    const jsTodos = extractTodosFromString(content, '.js');
+    const pyTodos = extractTodosFromString(content, '.py');
+    const htmlTodos = extractTodosFromString(content, '.html');
+
+    expect(jsTodos.length).toBe(1);
+    expect(jsTodos[0].tag).toBe('BUG');
+
+    expect(pyTodos.length).toBe(1);
+    expect(pyTodos[0].tag).toBe('FIXME');
+
+    expect(htmlTodos.length).toBe(1);
+    expect(htmlTodos[0].tag).toBe('TODO');
+  });
+
+  it('extracts metadata key=value pairs', () => {
+    const content = `// TODO(priority=high, due=2025-06-01): fix it`;
+    const todos = extractTodosFromString(content, '.js');
+
+    expect(todos.length).toBe(1);
+    expect(todos[0].metadata).toEqual({
+      priority: 'high',
+      due: '2025-06-01'
+    });
+  });
+});
diff --git a/src/core/issueManager.ts b/src/core/issueManager.ts
@@ -44,7 +44,9 @@ export async function createIssueIfNeeded(
     owner: string,
     repo: string,
     todo: TodoItem,
-    existingTitles: Set<string>
+    existingTitles: Set<string>,
+    titlePath?: string,
+    bodyPath?: string
   ): Promise<void> {
     const titleTemplate = loadTemplate('issueTitle.txt');
     const bodyTemplate = loadTemplate('issueBody.md');
diff --git a/src/parser/extractTodosFromContent.ts b/src/parser/extractTodosFromContent.ts
@@ -0,0 +1,51 @@
+import { TodoItem } from './types';
+
+const COMMENT_PATTERNS = [
+  { ext: ['.ts', '.js', '.java', '.go'], pattern: /^\s*\/\/\s*(.*)$/ },
+  { ext: ['.py', '.sh', '.rb'], pattern: /^\s*#\s*(.*)$/ },
+  { ext: ['.html', '.xml'], pattern: /<!--\s*(.*?)\s*-->/ }
+];
+
+const TAG_REGEX = /(TODO|FIXME|BUG|HACK)(\([^)]*\))?:?\s*(.*)/i;
+
+function extractMetadata(str: string): Record<string, string> {
+  const meta: Record<string, string> = {};
+  const match = str.match(/\((.*?)\)/);
+  if (match) {
+    const content = match[1];
+    content.split(',').forEach(pair => {
+      const [key, val] = pair.split('=').map(s => s.trim());
+      if (key && val) meta[key] = val;
+    });
+  }
+  return meta;
+}
+
+export function extractTodosFromString(content: string, ext: string): TodoItem[] {
+  const pattern = COMMENT_PATTERNS.find(p => p.ext.includes(ext));
+  if (!pattern) return [];
+
+  const lines = content.split('\n');
+  const todos: TodoItem[] = [];
+
+  lines.forEach((line, idx) => {
+    const commentMatch = line.match(pattern.pattern);
+    if (commentMatch) {
+      const comment = commentMatch[1];
+      const tagMatch = comment.match(TAG_REGEX);
+      if (tagMatch) {
+        const [_, tag, metaRaw, text] = tagMatch;
+        const metadata = metaRaw ? extractMetadata(metaRaw) : undefined;
+        todos.push({
+          file: `inline${ext}`,
+          line: idx + 1,
+          tag,
+          text: text.trim(),
+          metadata
+        });
+      }
+    }
+  });
+
+  return todos;
+}
diff --git a/src/templates/utils.ts b/src/templates/utils.ts
@@ -6,20 +6,22 @@ const DEFAULT_TEMPLATES: Record<string, string> = {
   'issueBody.md': 'Found in `{{file}}:{{line}}`\n\n```\n{{text}}\n```'
 };
 
-export function applyTemplate(template: string, data: Record<string, string | number>) {
+export function applyTemplate(template: string, data: Record<string, string | number>): string {
   return template.replace(/{{(.*?)}}/g, (_, key) => String(data[key.trim()] ?? ''));
 }
 
-export function loadTemplate(name: string): string {
+export function loadTemplate(templatePath: string): string {
+  const isRelative = !path.isAbsolute(templatePath);
+  const resolvedPath = isRelative
+    ? path.resolve(process.cwd(), templatePath)
+    : templatePath;
+
   try {
-    const filePath = path.join(__dirname, name);
-    return fs.readFileSync(filePath, 'utf-8');
+    return fs.readFileSync(resolvedPath, 'utf-8');
   } catch (err) {
-    const fallback = DEFAULT_TEMPLATES[name];
-    if (fallback) {
-      return fallback;
-    } else {
-      throw new Error(`Missing template: ${name}`);
-    }
+    const fallback = DEFAULT_TEMPLATES[path.basename(templatePath)];
+    if (fallback) return fallback;
+    throw new Error(`Template not found: ${templatePath}`);
   }
 }
+

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	+🗂 File: `{{file}}:{{line}}`
	`2`	`+`
	`3`	`+📝 Content:`