Cli Todo命令行todo工具使用演示

 更新时间:2022年08月08日 15:03:38   作者:bald3r  
这篇文章主要为大家介绍了Cli Todo命令行todo工具使用演示示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪

前言

bald3r-node-todo是一个用node.js开发的,主要用于命令行的todo工具,主要使用了fs模块,目前已经发布至npm

本工具主要使用了面向接口的编程思想,并用jest进行单元测试

链接

baIder/node-todo (github.com)

bald3r-node-todo - npm (npmjs.com)

使用演示

  • 首先使用yarnnpm安装bald3r-node-todo
npm install bald3r-todo
yarn global add bald3r-todo

安装完成后就可以使用全局命令t来使用了

使用命令行添加一个待办t add [taskName]

查看当前待办

二级菜单

清空所有待办t clear

实现过程

实现命令行参数

这里我使用了commander库来实现参数功能

program
  .command('add')
  .description('add a task')
  .action((...args) => {
    const words = args.slice(0, -1).join(' ')
    api.add(words).then(() => {
      console.log('The task has been successfully added')
    }, () => {
      console.log('Failed to add the task')
    })
  })
program
  .command('clear')
  .description('clear all tasks')
  .action(() => {
    api.clear().then(() => {
      console.log('All tasks have been successfully removed')
    }, () => {
      console.log('Failed to remove all the tasks')
    })
  })

commander默认会有两个参数,一个是node的路径,一个是当前文件的路径,因此我们判断参数的数量是否为2就可以判断用户是否传参

如果用户没有传参,则显示所有的待办项

if (process.argv.length === 2) {
  api.showAll()
}

实现可以操作的命令行

这里我使用了inquirer库来给命令行做了美化,实现可以用方向键和回车控制的UI界面

inquirer的使用非常简单,这里我展示二级菜单作为参考

function askForAction(list, index) {
  const actions = {markAsUndone, markAsDone, changeTitle, removeTask}
  inquirer.prompt({
    type: 'list',
    name: 'action',
    message: 'What to do with the task?',
    choices: [
      {name: 'Exit', value: 'quit'},
      {name: 'Mark as Done', value: 'markAsDone'},
      {name: 'Mark as Undone', value: 'markAsUndone'},
      {name: 'Edit Title', value: 'changeTitle'},
      {name: 'Delete', value: 'removeTask'},
    ]
  }).then(answer2 => {
    const action = actions[answer2.action]
    action && action(list, index)
  })
}

这样便实现了下图的二级菜单

待办项保存在本地

使用node.js的fs模块来实现对文件的读写,这里涉及一个保存路径的问题,在本项目中,为了方便使用了~目录,所有数据保存在~/.todo

获取~目录:

const homedir = require('os').homedir()
const home = process.env.HOME || homedir

考虑到跨平台使用路径的表示方式不同,这里使用了node.js中的path模块:

const p = require('path')
const dbPath = p.join(home, '.todo')

然后使用fs模块中的fs.readFile()fs.writeFile()即可完成对数据的读写。这里需要注意这两个操作都是异步的,因此用到了Promise,这里的{flag: 'a+'}是表示读取文件,若不存在则创建一个:

read(path = dbPath) {
  return new Promise((resolve, reject) => {
    fs.readFile(path, {flag: 'a+'}, (error, data) => {
      if (error) return reject(error)
      let list
      try {
        list = JSON.parse(data.toString())
      } catch (error2) {
        list = []
      }
      resolve(list)
    })
  })
}

以上就是Cli Todo命令行todo工具使用演示的详细内容,更多关于Cli Todo命令行todo工具的资料请关注脚本之家其它相关文章!

相关文章

  • 从零揭秘npm install的黑科技

    从零揭秘npm install的黑科技

    通过npm package manager来安装和管理包是我们最为常见的方式之一,本文将从浅入深地带大家剖析一下npm install的执行过程,感兴趣的可以学习一下
    2023-05-05
  • 如何用node优雅地打印全链路日志

    如何用node优雅地打印全链路日志

    这篇文章主要给大家介绍了关于如何用node优雅地打印全链路日志的相关资料,文中通过实例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2022-03-03
  • 详解Koa中更方便简单发送响应的方式

    详解Koa中更方便简单发送响应的方式

    这篇文章主要介绍了详解Koa中更方便简单发送响应的方式,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-07-07
  • node.js文件的压缩解压问题

    node.js文件的压缩解压问题

    这篇文章主要介绍了node.js文件的压缩解压问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-03-03
  • 一个简单的node.js界面实现方法

    一个简单的node.js界面实现方法

    今天小编就为大家分享一篇一个简单的node.js界面实现方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-06-06
  • nodejs实现用户登录路由功能

    nodejs实现用户登录路由功能

    这篇文章主要介绍了nodejs中实现用户登录路由功能,本文通过实例代码给大家介绍的非常详细,具有一定的参考借鉴价值,需要的朋友可以参考下
    2019-05-05
  • 手把手教你实现 Promise的使用方法

    手把手教你实现 Promise的使用方法

    这篇文章主要介绍了手把手教你实现 Promise的方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-09-09
  • 关于nodejs和npm版本不匹配的解决方法

    关于nodejs和npm版本不匹配的解决方法

    在运行npm命令时总会出现如下报错,npm dose not support Node.js v12.18.0,发现是node版本和npm版本不匹配造成的,所以本文给大家介绍了关于nodejs和npm版本不匹配的解决方法,需要的朋友可以参考下
    2023-11-11
  • node简单实现一个更改头像功能的示例

    node简单实现一个更改头像功能的示例

    本篇文章主要介绍了node简单实现一个更改头像功能的示例,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-12-12
  • 使用koa-log4管理nodeJs日志笔记的使用方法

    使用koa-log4管理nodeJs日志笔记的使用方法

    这篇文章主要介绍了使用koa-log4管理nodeJs日志笔记的使用方法,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-11-11

最新评论