npm 包 globus 使用教程

简介

globus 是一个 node.js 项目文件及文件夹路径匹配工具,它能遍历一个指定的根目录,然后通过提供的 glob 规则来返回一个由路径组成的文件列表。

它支持以下功能:

  • 支持多目录匹配;
  • 支持通配符路径匹配;
  • 支持过滤器过滤;
  • 支持同步和异步操作;
  • 支持使用 .gitignore 文件设置需忽略的文件列表。

安装

在安装之前,请确保配置了 node.js 环境。

你可以在终端中使用以下命令来安装 globus:

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

使用

你可以在你的项目中使用 require 导入 globus 模块:

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

globus 支持以下方法:

globus.find(options)

find 方法接受一个对象作为参数,该对象可以包含以下属性:

  • path:必选项,要查找的根目录路径;
  • pattern:匹配模式,默认为 **/*
  • filters:过滤器,用于明确需要过滤的文件类型或目录;
  • gitignore:是否启用 .gitignore 文件进行过滤,默认为 true
  • sync:是否同步返回结果,默认为 true

find 方法返回一个包含所有符合规则的文件路径的列表。

示例代码:

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

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

globus.watch(options)

watch 方法接受一个对象作为参数,该对象可以包含以下属性:

  • path:必选项,要监视的根目录路径;
  • pattern:匹配模式,默认为 **/*
  • filters:过滤器,用于明确需要过滤的文件类型或目录;
  • gitignore:是否启用 .gitignore 文件进行过滤,默认为 true
  • events:需要监听的事件数组,默认监听 add, change, unlink
  • listener:事件处理函数。

watch 方法返回一个 chokidar 实例,你可以对其进行监听事件处理。

示例代码:

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

注意事项

  • 部分 globus 方法只能在 node.js 运行环境中使用,因此在前端项目中使用需要先进行打包构建;
  • 对于 watch 方法,如果你绑定在一个根路径下的更多子目录路径,它们将会共享同一个 watcher 实例,以此减少性能浪费;
  • 除了 glob 通配符,globus 还支持 ! 符号进行排除,在书写规则时怎么使用该符号请参考 globus 的 API 文档。

总结

globus 是一个强大的文件查找工具,它为开发人员提供了一种简单、灵活的方式来搜索他们项目中的文件。在使用 globus 的过程中,你需要掌握 glob 通配符、过滤器以及 .gitignore 文件的使用方法,通过这些基本技能,你可以轻松地查找或过滤出指定类型的文件。同时,由于 globus 还支持异步操作和监视文件变化,因此它非常适合在较大、复杂的项目中使用。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/6005575181e8991b448d449a


猜你喜欢

  • npm 包 immux 使用教程

    什么是 immux? immux 是一个 JavaScript 库,它提供了一种简单而高效的方式来管理数据。 它基于实时数据库的思想,通过将数据作为完全可变的、有版本号的对象存储,使数据的同步和共享变...

    2 年前
  • npm 包 config-ui 使用教程

    简介 在前端开发中,我们经常需要使用配置文件来存储不同的环境变量,如 API 地址、CDN 路径等。npm 包 config-ui 就提供了一种简单易用的方式,帮助我们管理不同环境下的配置变量,从而提...

    2 年前
  • npm 包 flatten-red-black-tree 使用教程

    简介 在前端开发中,我们经常需要处理树形数据结构,而红黑树(Red-Black Tree)作为一种高效的自平衡二叉查找树,被广泛应用于数据存储和算法实现领域。npm 包 flatten-red-bla...

    2 年前
  • npm包koa-yup-error使用教程

    在前端开发中,我们不可避免要处理表单校验的问题,这是非常重要的事情。而对于后端开发者来说,校验的问题一般是比较好处理的,因为可以在自己的API层进行校验,但前端的开发者则需要通过一些第三方库来实现表单...

    2 年前
  • npm 包 eslint-config-amplify 使用教程

    在使用前端开发时,我们通常会涉及到代码质量管理,其中一个重要的工具就是 Lint 工具,一种用于检查代码中潜在问题的工具。而 eslint 就是其中一种非常流行的 Lint 工具。

    2 年前
  • npm 包 wfm2 使用教程

    简介 wfm2 是一个适用于前端的 npm 包,它提供了一种方便快捷的方式来处理前端工作流,例如打包、压缩、webpack 构建等等。它基于 webpack 和 gulp 的核心技术,为前端开发者提供...

    2 年前
  • npm 包 react-theme-loader 使用教程

    在前端开发中,主题换肤是一个常见的需求。我们可能需要让用户在不同的页面或不同的设备上选择自己喜欢的主题。而使用 react-theme-loader 这个 npm 包,开发者可以轻松地实现主题换肤功能...

    2 年前
  • npm 包 cerebro-gitio 使用教程

    概述 cerebro-gitio 是一个 npm 包,用于生成 git.io 短链接。该 npm 包可以在前端和后端使用。 安装 使用 npm 安装 cerebro-gitio: --- ------...

    2 年前
  • npm 包 cerebro-hotel 使用教程

    在前端开发中,我们经常需要使用各种各样的工具和库来提高我们的开发效率。其中,npm 是一个非常重要的工具,它可以用来管理我们的项目依赖和各种各样的包。本文主要介绍一个非常实用的 npm 包 -- ce...

    2 年前
  • npm 包 parallelism 使用教程

    在前端开发中,我们经常需要同时处理多个任务,如编译、测试、打包等。而对于这些需要同时运行的任务,我们可以使用 npm 包 parallelism 来实现并行处理,提高开发效率。

    2 年前
  • npm 包 monad-reader 使用教程

    介绍 Monad-Reader 是一个 JavaScript 的 npm 包,它提供了一种函数式编程思想中的 monad reader pattern。使用 monad reader 可以简化程序中对...

    2 年前
  • npm 包 mirror-keys 使用教程

    前言 在前端开发中,我们经常会使用各种 npm 包,这些包可以帮助我们完成很多工作。然而,有时候这些 npm 包的 API 文档中并不会提供我们所需要的功能,或者某个 API 名称不直观,这时候我们需...

    2 年前
  • npm 包 maquina-js 使用教程

    什么是 maquina-js maquina-js 是一个非常有用的 npm 包,它是一个简单的状态机引擎。它可以帮助前端开发者更简单的管理状态,并且节约了开发时间。

    2 年前
  • npm 包 wbhob-ng2-pickadate 使用教程

    前言 在前端开发中,日期选择器是一项非常常见的需求,网上有很多优秀的开源日期选择器可以使用。但是,有些开源日期选择器往往不太符合实际场景需要,或者使用方式不够方便。

    2 年前
  • npm 包 react-fetch-hoc 使用教程

    在前端开发中,我们经常需要从后端服务器获取数据并进行渲染。在使用 React 进行开发时,我们可以使用 React 官方推荐的 fetch API 来实现数据的获取。

    2 年前
  • npm 包 single-require 使用教程

    在前端开发中,我们经常需要引用和使用各种 JavaScript 库和模块,其中包括很多常用的 npm 包,比如 jQuery、React、Vue 等等。为了更好地管理这些模块,npm 提供了非常便捷的...

    2 年前
  • npm 包 @liflandgaming/tslint-config 使用教程

    介绍 在前端开发中,代码质量和风格的规范十分重要,不仅有助于团队协作和代码维护,也能提高代码的可读性和可维护性。针对 TypeScript 语言的代码规范,我们可以使用 TSLint 工具来进行静态代...

    2 年前
  • npm 包 @jdcrensh/enzyme-react-intl 使用教程

    在前端开发中,我们经常需要进行国际化处理,而 @jdcrensh/enzyme-react-intl 就是一个便捷的 npm 包,可以轻松实现 React 应用的国际化处理。

    2 年前
  • npm 包 coolshare_angular_pub_sub 使用教程

    前言 在前端开发中,经常使用到一种数据传递机制,即发布-订阅模式(Publish-Subscribe Pattern),它是一种对象间的一对多的观察关系,当一个对象(被观察者,或称为发布者)状态发生改...

    2 年前
  • npm 包 http-client-base 使用教程

    简介 随着现代 Web 应用和 API 的发展,客户端的网络请求变得越来越频繁。本文介绍一个 npm 包,它提供了一个用于执行基础 HTTP 请求的客户端。该包的名称是 http-client-bas...

    2 年前

相关推荐

    暂无文章