search-keywords库的介绍 - 快速查询关键字存在于哪些文件

1. 创作背景

你是否遇到这种情况，在某个文件写了某一行代码，过一会就忘记了，由于项目文件过多，要找到很不容易，作者就是遇到太多次这情况了，所以选择开发了该库

2. 该库查询速度测试

经过测试，中小型项目基本是0~2秒左右，作者测试了一个大小几G，文件几十万个，文件夹几十万个左右的目录(由于计算文件数量太久了，所以没有继续等了)，最后用了81秒查询完毕
大家也可以试试去挑战更多更大的目录需要花费多少时间

3. 安装环境

1. git下载地址
2. nodejs下载地址（如果是下载的压缩包记得配下node和npm的环境变量）
3. git clone速度太慢解决方案（谷歌浏览器GitHub加速插件实测有效）
4. 若npm下载速度太慢，解决方案
5. 该库文档

4. 安装库

npm install search-keywords
或者
yarn add search-keywords

5. 创建search.js文件

文件位置任意

//这是  search.js  文件
const scriptSearch = require("search-keywords");
const path = require("path");
const config = {//配置
    rootDirPath: path.resolve(__dirname),//查询的根目录(绝对路径)
    keywords: ["const","require"]//多个关键字查询
}

//不传配置则使用默认配置
scriptSearch(config);

6. 见证奇迹，通过node运行第4步创建的文件

node search.js

7. 最终效果

8. 其他配置

validExts：允许查询的文件后缀，如：[".vue",".py",".c"…]

excludeKeywords：排除的目标文件或目录，根据path-to-regexp库规则进行配置，也可直接传绝对路径

outType：输出方式，默认console输出在控制台，可选file输出到_keywords.json文件中

具体详细配置参考链接，点我~

9. 结尾

希望这个库对大家有所帮助，能提高大家的开发效率。

喜欢的记得点个赞，关个注，留个言，谢谢哈~

有问题，github提issue ， 或联系qq1050132079