Skip to content
Arya Jarvis:旨在为开发人员节省更多时间和精力(Document)
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
.gitignore
README.md
package.json
yarn.lock add now docsify-cli Sep 14, 2019

README.md

ARYA JARVIS DOC

旨在为开发人员节省更多时间和精力

English | 中文

荀子在《劝学》曰:君子生非异也,善假于物也。对于重复而精确性的事物,理想的目标是:有贴心工具加以协助,使得可以用更便捷的方式处理;Github 创建仓库:ARYA JARVIS,即是为此而做的尝试 ── 她旨在为开发人员节省更多时间、精力以及体力。而此篇文章的存在,介绍 ARYA JARVIS 的同时,也分享下关于对善假于物的理解。

为高效而生:Arya Jarvis

故事起源

就目前工作而言,比较多涉及的是 Web 前端这块。为更快能启动一个前端项目,抑或是做其他处理如:测试、构建、发布等,通常做法是在 package.json 中配置 scripts 脚本命令;然而,在接触一个复杂或者新项目时,如过对 scripts 脚本命令不够了然,则会限制在终端操作的速度。通常的做法是用熟悉的编辑器,打开该文件看下,或者借助 cat 命令输出至终端加以查看。所以,很早之前就希望能有一种操作,可以一键以浏览之。久未遇到,也自然就产生了自己写一个的想法,这边是编写 Arya Jarvis 的初衷。

截止目前,Arya Jarvis 可以帮着做的事儿,已逐渐多了起来, 是时候可以将其先分享出来,希望有更多人可以一起使用 & 完善她。就如在 Arya Jarvis README 中写到的,我个人是此工具的最忠实的用户;现在编写 Arya Jarvis 之时,也是用她本身来格式美化项目代码,感谢我自己在业余时间自己创造了她,我是如此的喜欢。

使用条件

Node.js(> = 8. *),Npm 版本 5+(更推荐使用 Yarn

下载安装

npm i arya-jarvis -g
# Or
yarn global add arya-jarvis

如何使用

如下两个代码美化相关功能,可以支持多种文件,譬如: .js, .vue, .ux, .less, .scss, .css, .json, .md, .html, .qxml, .wxml

💄 一键美化指定路径下的代码

arya prettier index.js
# 👏 Or Use Alias
arya p ./src/**/**/*.js
# 👍🙌 Or Use Alias & Wildcard
arya p .

🔬 监听并美化指定路径下的代码

arya watcher index.js
# 👏 Or Use Alias
arya w ./src/**/**/*.js
# 👍🙌 Or Use Alias & Wildcard
arya w .

值得一提的是,本项目代码在开发时,格式美化就使用 arya w . 命令。感谢我自己业余时间自己开发此了 arya jarvis ,我超级喜欢。

温馨说明Prettier 是一个有见识的代码格式化工具;使用它来美化,实在是再好不过,具体可以参见 使用 ESLint & Prettier 美化 Vue 代码;曾多次为很多前端开发者安利 Prettier,却因各种原因,不被接纳 😇; 考虑到其配置可能略对某些人显复杂,也就诞生了一个想法:做一个工具,是开发者开箱即用,领略其中舒爽,可还有拒绝的理由?而如上两个命令即可对此想法的实践。针对微型或临时项目,此工具还是非常实用(对于中大型项目,建议自行在项目中配置)。

🌍 用于快速构建本地 Web 服务器

arya server
# 👏 Or Use Alias
arya s

温馨说明arya s,用于快速构建本地 Web 服务器,这是非常有用的功能;比如说,你想快速下载您电脑上资源至手机,那么即可在该资源目录下,运行 arya s 命令,就会以当前目录作为静态网站托管,建立一个 Server,并依据本地 IP(/电脑名)生成地址,只要手机端跟电脑在同一个网段下,即可访问下载;这里更贴心的是,会将对应地址生成二维码,并在控制台打印,用手机扫码即可访问。

需要额外补充说明的是,此功能比 anywhere 更加强大且贴心,您无需手动指定端口;程序默认端口为 8080,如果该被占用,依然可用;它会自动向上递增扫描,直到可用(最大端口号:65535)端口,堪称是真正的:随启随用的静态文件服务器

实际上,这个功能有借助 lws 来实现;它的功能当然是不止于上面表达的那一点,这对于开发人员来讲,尤为实用,这将会在后面不断迭代中,继续完善;也有打算出一个文档,以给出充分说明,敬请期待。

🌊 一键预览指定 Markdown 文件

arya markdown README.md
arya markdown ./nice-project/README.md
# 👏 Or Use Alias
arya m README.md

温馨说明Markdown 是一种轻量级的「标记语言」,旨在简洁、高效;可以通过简单、易读易写的文本格式,生成结构化的 HTML 文档;预览 Markdown 呈现效果,虽然在各类编辑器,都有其解释器插件,但也得额外安装、激活方可;因此有借助 marked 实现一键快速预览 Markdown,并呈现出跟 Github 一样的现实效果。

预览 Markdown 选项

Watcher (-w , --watch)

默认情况下,不会监听您指定的 Markdown 文件,您可以通过增加 -w 选项来开启监听功能,以实时刷新您的预览页面,参见如下示例:

arya markdown README.md -w
arya markdown README.md --watch

⚡️ 找到您本地 IP 地址并打印出来

arya ip

温馨说明:对于获取本地 IP(以及公网 IP)这一诉求,无论是使用 Mac、Linux 还是 Windows 用户,如果没有特殊配置,也是颇为麻烦的;即便在控制台使用 ipconfig or ifconfig,得到的结果也是需要一番筛选;而使用 arya ip 则可以轻松获取。

👀 查看占用指定端口的程序

arya port 8080
# Or
arya port 8081

温馨说明:同样,在几个不同的平台上,想知晓某个端口(如:8080)被哪个程序所占用,也是需要一番周章的;在 Windows 系统,可以使用 netstat 命令,而在其他两个平台,大多数可能会选择 lsof;但记忆与操作起来毕竟麻烦,而使用 arya 相对就方面很多,可以通过以下命令做下对比:

# 适用于 Windows 系统
netstat -ano | findstr 8080

# 适用于 Mac Linux 系统
lsof -i tcp:8080

# 适用于 Mac Linux Windows 系统
arya port 8080

📷 为指定文本生成二维码

arya qrcode "https://www.jeffjade.com/"
arya qrcode "晚晴幽草轩轩主"

温馨说明:此项目集成了二维码生成器,可以很便捷在控制台,就根据命令,为指定文本生成二维码,并提供保存于本地的功能(需要额外参数 -s);这相比于要在网上搜索在线服务,要方便许多,从节省更多时间角度考量,用 arya qrcode 是更好的抉择。

额外参数选项

Save (-s , --save)

arya qrcode "https://nicelinks.site/" -s
arya qrcode "https://www.lovejade.cn/" --save

✂️ 尽可能清除终端屏幕内容

arya clear
# Or
arya c

在 Mac OS,如果想实现此功能,可以在终端运行 clear 命令即可;但这离特别方便,还略有些距离;可以借助 oh-my-zsh,在 .zshrc 文件中配置命令别名:alias cls='clear';如此一来,运行 cls 就足以清除终端屏幕内容;而这在 Windows 系统,就又须另当别论了;这么看来,使用 arya c 是蛮不错的选择。

🌫 灰阶: 去除图像的颜色

arya img:greyscale <path>

# 👏 Or Use Alias
arya igs <path>
arya igs ./assets/images
arya igs ./assets/images/logo.png

指定图片或其所在的文件夹路径(相对 or 绝对),会将所有支持的图像灰度处理;所有处理过的图片都放在一个新文件夹中:arya-greyscale-imgs;支持的图像类型: .bmp, .gif, .jpeg, .jpg, .png, .tiff

温馨说明:注入此功能,也是出于自身需要:在编写小程序版本「倾城之链」时,在使用官方 Tabbar 组件,需要提供 icon 和选中时的 icon;为区分两者不同状态,将默认 icon 置灰,是通用选择。如采取 PS 或者 CSS 一张张操作,实在有些麻烦,而在网上也未找见有类似批量灰阶图片的工具,索性就自己写一个,以方便使用。感谢 jimp 开源库提供的支持。

🚝 列出 package.json 中的脚本命令

arya ls
# 👏 Or Use Alias
arya l

温馨说明:正如前文在故事起源中所提及的那般,arya ls 这个命令是这个项目的初衷:只为方便知晓前端项目 package.json 中都存在哪些脚本,以方便更快运行。只是在迭代中,越发多的集成了更多普遍可以用到的功能,此功能的存在显得就不是那么闪耀;但,作为引发燎原之势的那一缕星光 🌟,将持久铭记,且常用之。


即便已入中年,仍然坚信,只要主动折腾勤于折腾善于折腾,相信总能将生活与人生,折腾成自己越发欢喜的模样,对于这近乎无休止的工作,亦是如此。arya jarvis 仍在考虑植入更多有用的功能,如果您有任何需求,您可以告诉我,或在此基础上进行扩展。如果您在使用过程中遇到任何问题,您可以随时向我的反馈。祝:生活幸福,工作快乐。

相关链接

License

MIT

Copyright (c) 2019-present, nicejade.

You can’t perform that action at this time.