@aboviq/kollektor 中文文档教程

Question

@aboviq/kollektor

通用文件收集器，对单存储库和微服务很有用

Installation

安装 @aboviq/kollektor 使用 npm：

npm install @aboviq/kollektor

Usage

Module usage

const kollektor = require('@aboviq/kollektor');

// Read all package.json files in a mono-repo async:
const packages = await kollektor({
    handlers: {
        'package.json': packageFile => require(packageFile)
    }
});

// ...or sync:
const packages = kollektor.sync({
    handlers: {
        'package.json': packageFile => require(packageFile)
    }
});

API

kollektor(options)

Name	Type	Description
options	Object	Options for specifying the behaviour of Kollektor

返回：Promise>，所有收集的信息取决于给定的处理程序。

kollektor.sync(options)

Name	Type	Description
options	Object	Options for specifying the behaviour of Kollektor

返回：Array

Options

options.cwd

类型：字符串
默认值：process.cwd()

设置当前工作目录

options.handlers

类型：Object

示例：

{
    "handlers": {
        "package.json": () => {},
        "*.yml": () => {},
        "README.md": () => {}
    }
}

Handler definition

类型：Function
签名：handlerName :: String -> 对象 -> Object

handlerName 是处理程序的名称，通常是一个文件名，例如 "package.json" 它将为每个 package.json 文件调用处理程序发现。 handlerName 也可以是匹配多个文件的简单模式，例如："*.yml"。

当找到与 handlerName 匹配的文件时，将使用这些参数调用处理函数：

Name	Type	Description
fullPath	String	The full path to the found file
data	Object	This contains dir (the relative path of the folder), dirPath (the full path of the folder) and all data returned from previous handlers affecting the same folder

对于 Kollektor 的异步版本，处理函数可以是异步的（返回承诺），但对于同步版本必须是同步的版本。

从处理程序返回的任何 Object 都与当前文件夹的 data 合并，并将被馈送到影响同一文件夹中文件的下一个处理程序。 当针对特定文件夹调用并完成所有处理程序后，生成的 data 就是在收集信息的 Array 中返回的内容。 有关其工作原理的更多详细信息，请参阅测试。

Contributing

请参阅贡献指南和我们的行为准则。

License

麻省理工学院 © Aboviq AB