@ireneliaoliao/todo-checker 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ireneliaoliao
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,13 @@
+# @ireneliaoliao/todo-checker
+
+📋 TODO 注释检查器，按时间优先级排序
+
+[![npm version](https://img.shields.io/npm/v/@ireneliaoliao/todo-checker.svg)](https://www.npmjs.com/package/@ireneliaoliao/todo-checker)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+---
+
+## 📦 安装
+
+```bash
+npm install -g @ireneliaoliao/todo-checker

package/index.js

@@ -0,0 +1,115 @@
+#!/usr/bin/env node
+
+import fs from 'fs-extra';
+import { glob } from 'glob';
+import chalk from 'chalk';
+
+async function getAllFiles() {
+    return glob('**/*.{js,ts,jsx,tsx,vue,html,css,scss,md}', {
+        ignore: ['node_modules/**', 'dist/**', 'build/**', '.git/**', '*.log'],
+    })
+}
+
+function extractTodos(content, filePath) {
+    const todos = [];
+    const lines = content.split('\n');
+
+    for(let i = 0; i < lines.length; i++) {
+        const line = lines[i];
+
+        const patterns = [
+            /\/\/\s*TODO\s*[:：]?\s*(.*)/,           // // TODO: xxx
+            /\/\*\s*TODO\s*[:：]?\s*(.*?)\s*\*\//,   // /* TODO: xxx */
+            /<!--\s*TODO\s*[:：]?\s*(.*?)\s*-->/,    // <!-- TODO: xxx -->
+        ];
+
+        for(const pattern of patterns) {
+            const match = line.match(pattern);
+            if(match) {
+                const text = match[1].trim();
+
+                const dateMatch = text.match(/(\d{4}-\d{2}-\d{2})/);
+                const date = dateMatch ? new Date(dateMatch[1]) : null;
+                const age = date ? (Date.now() - date.getTime()) / (1000 * 60 * 60 * 24) : null;
+
+                todos.push({
+                    file: filePath,
+                    line: i + 1,
+                    text: text,
+                    date: date,
+                    age: age,
+                })
+
+                break;
+            }
+        }
+    }
+
+    return todos;
+}
+
+async function main() {
+    console.log(chalk.blue.bold('\nTODO 扫描报告\n'));
+
+    const files = await getAllFiles();
+    let allTodos = [];
+
+    for(const file of files) {
+        const content = await fs.readFile(file, 'utf-8');
+        const todos = extractTodos(content, file);
+        allTodos.push(...todos);
+    }
+
+    if(allTodos.length === 0) {
+        console.log(chalk.green('🎉 没有发现 TODO 注释！'));
+        return;
+    }
+
+    console.log(chalk.white(`发现 ${allTodos.length}个TODO注释:\n`));
+
+    const old = allTodos.filter(t => t.age !== null && t.age > 30);
+    const medium = allTodos.filter(t => t.age !== null && t.age > 7 && t.age <= 30);
+    const recent = allTodos.filter(t => t.age === null || t.age <= 7);
+
+    if (old.length > 0) {
+        console.log(chalk.yellow(`📅 超过 1 个月的 (${old.length} 个):`))
+        for (const todo of old.slice(0, 10)) {
+            const dateStr = todo.date ? todo.date.toISOString().split('T')[0] : '无日期'
+            console.log(chalk.red(`   🔴 ${todo.file}:${todo.line}  (${dateStr})`))
+            console.log(chalk.gray(`      // TODO: ${todo.text}`))
+        }
+        if (old.length > 10) {
+            console.log(chalk.gray(`   ... 还有 ${old.length - 10} 个`))
+        }
+        console.log()
+  }
+
+  if (medium.length > 0) {
+    console.log(chalk.yellow(`📅 超过 1 周的 (${medium.length} 个):`))
+    for (const todo of medium.slice(0, 5)) {
+      const dateStr = todo.date ? todo.date.toISOString().split('T')[0] : '无日期'
+      console.log(chalk.yellow(`   🟡 ${todo.file}:${todo.line}  (${dateStr})`))
+    }
+    if (medium.length > 5) {
+      console.log(chalk.gray(`   ... 还有 ${medium.length - 5} 个`))
+    }
+    console.log()
+  }
+
+  if (recent.length > 0) {
+    console.log(chalk.green(`📅 最近 1 周的 (${recent.length} 个):`))
+    for (const todo of recent.slice(0, 5)) {
+      console.log(chalk.green(`   🟢 ${todo.file}:${todo.line}`))
+    }
+    if (recent.length > 5) {
+      console.log(chalk.gray(`   ... 还有 ${recent.length - 5} 个`))
+    }
+    console.log()
+  }
+
+  if (old.length > 0) {
+    console.log(chalk.blue('💡 建议: 优先处理 🔴 标记的 TODO'))
+  }
+}
+
+main().catch(console.error);

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@ireneliaoliao/todo-checker",
+  "version": "1.0.0",
+  "description": "📋 TODO 注释检查器，按时间优先级排序",
+  "type": "module",
+  "main": "index.js",
+  "bin": {
+    "todo-checker": "./index.js"
+  },
+  "files": [
+    "index.js"
+  ],
+  "scripts": {
+    "start": "node index.js"
+  },
+  "keywords": [
+    "todo",
+    "checker",
+    "cli",
+    "technical-debt",
+    "analyzer",
+    "code-quality"
+  ],
+  "author": {
+    "name": "ireneliaoliao"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ireneliaoliao/todo-checker.git"
+  },
+  "homepage": "https://github.com/ireneliaoliao/todo-checker#readme",
+  "bugs": {
+    "url": "https://github.com/ireneliaoliao/todo-checker/issues"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "chalk": "^5.3.0",
+    "fs-extra": "^11.2.0",
+    "glob": "^10.3.10"
+  }
+}