2个版本

0.1.1 2023年1月12日
0.1.0 2023年1月12日

#392 in 压缩

MIT/Apache

13KB
124

Emily

简介 📖

一个简单的TODOs追踪器,可以找到未报告的TODOs并在仓库中提交它们作为issue

挑战 🐢

  • 通过多个归档和目录找到TODOs
  • 向GitHub报告它们,无需重复

目标 🏆

[ x ] 用户可以查看TODOs而无需在GitHub上报告它们
[ x ] 脚本创建包含文件名和TODOs描述的issue
[ x ] issue不会重复
[ x ] 工作

它是如何工作的?💼

应用程序接收目录路径,并通过文件开始搜索TODOs索引,如果激活了--push,它将获取仓库上的所有issue并在GitHub上报告未重复的issue

如何安装 🚀

确保您的终端上有cargo并运行

$ cargo install Emily

如何使用 👷

TODOs

TODOs有两个主要的工作内容

  • 强调符号 #
  • TODO下的一行新内容
1 console.log("Hello Reality");
2 // #TODO Use World instead of Reality
3  

命令行

以下标志的数量

  • --dir (目录路径) [必需]
  • --name (您的GitHub名称) [如果要将TODOs报告,则必需]
  • --repo (将报告TODOs的仓库 [如果要将TODOs报告,则必需]
  • --key (GitHub API密钥 / 了解如何获取: https://securitysenses.com/videos/obtaining-api-key-github-api [如果要将TODOs报告,则必需]
  • --push (这决定了应用程序是否将报告或仅在终端中显示它们) [如果要将TODOs报告,则必需]

演示

  • 无push
  • 推送到GitHub
    注意: $GITHUB_KEY = 用您的API密钥替换

依赖项

~7–22MB
~303K SLoC