npm 包 wikipedia-image 使用教程

阅读时长 4 分钟读完

简介

wikipedia-image 是一款基于 Node.js 的 npm 包,可以方便地在终端中搜索并下载对应的维基百科文章中的图片。

该 npm 包支持自定义图片大小、质量、保存位置等多种参数,同时也可以自定义存储图片的命名方式。

安装

使用 npm 安装即可:

使用

基本用法

使用 wikipedia-image 只需要在终端中输入以下命令:

例如:

输入上述命令后,wikipedia-image 将会自动搜索维基百科中 “JavaScript” 这个词条的相关图片,并下载到当前目录。默认下载全部图片并以原图名称保存。

自定义参数

  • --width / -w: 指定图片宽度,例如: --width 500
  • --height / -h: 指定图片高度,例如: --height 300
  • --quality / -q: 指定图片质量(0 ~ 100),例如: --quality 90
  • --dir / -d: 指定存储图片的目录,例如: --dir /users/username/desktop
  • --name / -n: 指定存储图片的文件名,原名为 %{title}_%{filename},例如: --name js_%{filename}

例如:

上述命令将会搜索 “React” 页面的所有图片,并下载到 /users/username/desktop/react_images 这个目录下,图片宽度为 900 像素,质量为 80,同时图片名称为 react_<原图片名称>

错误处理

当搜索到的结果为空时,终端会输出 “No images found.” 的错误提示信息。

当下载过程中出现网络错误等情况时,命令将会自动重试 3 次,若均失败则输出错误提示信息并结束下载。

开发

克隆仓库

使用以下命令将代码库克隆到本地:

其中 “your_username” 指的是你的 GitHub 用户名。

安装依赖

在运行代码前,需要先安装依赖:

代码结构

wikipedia-image 的项目结构如下:

-- -------------------- ---- -------
-
--- ---                     - -------
-   --- ---------------
--- ---                     - ---
-   --- ------------------  - ---
-   --- ---------           - -------
-   --- -------             - ----
--- ------------            - ---
--- ----                    - ----
--- ----------              
--- ------------            
--- ---------

单元测试

该项目使用 mochachai 进行单元测试。在项目目录下执行以下命令开始测试:

本项目的测试覆盖率达到了 100%。

总结

wikipedia-image 可以很好地满足我们在终端中获取维基百科中的图片的需求。在未来的开发中,我们可以在此基础上进一步拓展,例如:增加下载文件类型的指定(支持 png、jpg、gif、svg 等),增加搜索关键词范围指定(如仅搜索文章特定部分),增加多线程下载能力等等。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6006710c8dd3466f61ffe15c

纠错
反馈