项目技术文档——Glob

1. 安装指南

使用npm进行安装：

npm i glob

请注意，npm包的名称是glob，而不是node-glob。后者是一个已经被放弃的包。

2. 项目使用说明

该项目是一个用于匹配文件的模式工具，它使用JavaScript实现了类似shell中的glob功能。

使用示例

// 使用ES6模块导入
import { glob, globSync, globStream, globStreamSync, Glob } from 'glob'

// 或者使用CommonJS模块系统
const {
  glob,
  globSync,
  globStream,
  globStreamSync,
  Glob,
} = require('glob')

// 搜索所有.js文件，但忽略node_modules目录
const jsfiles = await glob('**/*.js', { ignore: 'node_modules/**' })

// 使用信号取消glob搜索
const stopAfter100ms = await glob('**/*.css', {
  signal: AbortSignal.timeout(100),
})

// 支持多个模式
const images = await glob(['css/*.{png,jpeg}', 'public/*.{png,jpeg}'])

// 同步函数与异步函数类似，但返回的是字符串数组而不是Promise
const imagesAlt = globSync('{css,public}/*.{png,jpeg}')

// 可以使用流方式进行操作
const filesStream = globStream(['**/*.dat', 'logs/**/*.log'])

// 构建Glob对象以实现更快的搜索
const g = new Glob('**/foo', {})
for await (const file of g) {
  console.log('找到foo文件：', file)
}

// 使用已有的Glob对象进行搜索
const g2 = new Glob('**/bar', g)
for (const file of g2) {
  console.log('找到bar文件：', file)
}

// 获取文件类型信息
const g3 = new Glob('**/baz/**', { withFileTypes: true })
g3.stream().on('data', path => {
  console.log(
    '获取路径对象',
    path.fullpath(),
    path.isDirectory(),
    path.readdirSync().map(e => e.name),
  )
})

// 使用stat和withFileTypes可以对结果进行排序和筛选
const results = await glob('**', { stat: true, withFileTypes: true })

const timeSortedFiles = results
  .sort((a, b) => a.mtimeMs - b.mtimeMs)
  .map(path => path.fullpath())

const groupReadableFiles = results
  .filter(path => path.mode & 0o040)
  .map(path => path.fullpath())

3. 项目API使用文档

该项目的API主要包括以下函数：

• glob(pattern, [options]): 异步搜索匹配的文件。
• globSync(pattern, [options]): 同步搜索匹配的文件。
• globStream(pattern, [options]): 返回一个包含匹配文件的流。
• globStreamSync(pattern, [options]): 同步返回一个包含匹配文件的流。
• Glob(pattern, [options]): 创建一个新的Glob对象，用于多次搜索。

options参数包括：

• ignore: 忽略特定的文件或目录。
• signal: 用于取消搜索操作的信号。
• withFileTypes: 返回文件类型信息。
• stat: 对所有条目调用fs.lstat。
• 其他选项，如windowsPathsNoEscape，follow，realpath等。

4. 项目安装方式

项目的安装方式已在安装指南中说明，使用npm进行安装：

npm i glob