never-todo-terminal

NeverToDo待办列表——命令行端

Document in English

总览

这个应用被分为五部分

• 后端数据库（开发中） - 使用Golang进行开发
• 前端Web页面（开发中） - 使用Vue进行开发，可能会用dart写Vue
• PC端（Win/Linux/Mac）（发布v0.0.1）- 使用Electron-Vue框架搭建
• 命令行端（Win/Linux/Mac）（开发中） - 使用Golang进行开发
• 移动端（Android/IOS）（尚未开发） - 使用Dart/Flutter搭建

本项目为跨平台的never-todo系列产品提供了一个在线同步的后端服务功能，您可以在自己的服务器中部署该服务并在客户端中配置相应信息来实现同步功能，本项目由SpicyChickenFLY与bluepongo合作开发

实现功能

• 实现通过输入指令实现待办、标签的增删改查

需要注意的特性

• 任务的删除是完全删除，数据中不会再记录这一条，但是日志中保存着这个操作，因此在下个版本中可以通过undo撤销来恢复
• 标签作为归档任务分类的重要依据，删除的方式为软删除，即删除之后你仍可以在分配了这个标签的待办任务中看见这个标签，但是查询不到这一个标签，当你再次创建同名的标签时，标签能够被查询到
• 被服务器通过

下个版本实现的功能

• 设计格式化输出模块，使得输出结果在窄屏上也能正常输出
• 实现通过文字终端UI的界面交互完成相应操作
• 把对于待办和标签的增删改操作记录在操作日志中便于多端同步
• 当操作日志超过指定数目时（默认为200条），系统会在新指令执行完毕后对超出限制(默认为100条)的旧日志进行合并压缩，已同步的日志不会和尚未同步的日志合并
• 实现日程相关功能
• 实现命令行端和桌面端或者后端服务器的同步机制

项目搭建

cp lex.go ./parser/
cp parser.go ./parser/

go build

命名格式

# 查看总览
never

# 查看帮助
never -h

# 通过UI交互界面进行操作(当前版本未实现）
#never ui

# 解释指令的解析结果和执行计划
never explain [<log_id>]

# 查看所有任务、筛选任务
never list {[todo]|done|all} 
    [ <content> [and|or <content>] ]   # 通过内容模糊搜索筛选
    [ +<tag>|-<tag> [+<tag>|-<tag>] ]  # 通过标签筛选
    [ age:<age>|[<age>]-[<age>] ]      # 通过创建时间筛选(当前版本未实现)
    [ due:<due>|[<due>]-[<due>] ]      # 通过截止时间筛选(当前版本未实现)

# 列出指定任务
never list {[todo]|done|all} <id>[-<id>] [<id>]             # 通过ID直接定位

# 新增待办任务
never add <content>
    [ +<tag> [+<tag>] ]         # 分配标签
    [ due:<due> ]               # 设置截止时间(当前版本未实现)
    [ loop: y|m|w[-SMTWTFS]|d ] # 设置重复提醒(每周日，一，四：w-SM...T..)(当前版本未实现)

# 修改任务
never [set] <id> [<content>] 
    [ +<tag>|-<tag> [+<tag>|-<tag>] ]   # 分配标签
    [ due:<due> ]                       # 设置截止时间  (当前版本未实现)
    [ loop: y|m|w[-SMTWTFS]|d ]         # 设置重复提醒(每周日，一，四：w-SM...T..)(当前版本未实现)

# 完成、删除任务
never todo|done|del <id>[-<id>] [<id>]


# 查看所有标签、筛选标签
never tag
    [ <content> [and|or <content>] ]  # 通过内容模糊搜索

# 列出指定标签
never tag <id>[~<id>] [<id>]               # 通过ID直接定位

never tag add 

never tag [set] <id> <filters> 
Filters must be one of follow
    <content> 
    [color:<color>]

# 查看历史操作
#never log [<num>]

# 撤销(当前版本未实现）
#never undo [<log_id>]

# 查看某一时段内的统计(当前版本未实现）
# never stat year|month|week|day # 默认为day

nt -+ [task] -+ list
    |         | add
    |         | del
    |         | [set]
    |
    + tag ----+ list
              | add
              | del
              | [set]