@gitlab/codeowners

中文文档
0.3.0发布于 2026/09/23MITTypeScriptES Module近 30 天下载 5.5万

解析 GitLab CODEOWNERS 文件

中文使用文档
文档目录4 节
  1. 安装
  2. 使用量
  3. 版本
  4. 开始

GitLab 代码解析器

以 TypeScript 为节点的 GitLab CodeOwners 解析器 .

它旨在落实所有 文档 格式的特性,但是 还没有呢 现在考虑这个α质量的软件!

安装

npm install @gitlab/codeowners

使用量

import { parse } from '@gitlab/codeowners';

const codeowners = await parse('./CODEOWNERS');

const owners = codeowners.getOwners('README.md'); // ['@user', '@group']

const ownersDetailed = codeowners.getOwnersDetailed('README.md'); /* =>
[{
  owner: '@user',
  type: 'directOwner',
  section: 'codeowners',
  optional: true,
  approvalsNeeded: 1,
},{
  owner: '@group',
  type: 'defaultOwner',
  section: 'Maintainers',
  optional: false,
  approvalsNeeded: 5,
}]
*/

版本

此项目将使用 语义版本特别是, 说明 项目4数字 :

主要版本0 (0.y.z)是用于初始开发. 任何可能的变化 随时都可以 公共API不应该被视为稳定.

该项目一旦支持所有特性,将达到1.0 文档 由吉特拉布所著.

开始

这还没有完全实施GitLab CODEOWNERS 剖析器。 这里 非详尽清单 没有 已执行/支持:

版本与发布记录

@gitlab/codeowners 共发布 13 个版本,首次发布于 2024/04/05;过去 12 个月发布了 3 个版本。

版本发布日期距今
0.3.0latest2026/09/231 个月前
0.2.82026/08/272 个月前
0.2.72025/11/2711 个月前
0.2.62025/10/291 年前
0.2.52025/10/211.1 年前
0.2.42025/10/211.1 年前

关于 @gitlab/codeowners 的常见问题

@gitlab/codeowners 是什么?

解析 GitLab CODEOWNERS 文件

如何安装 @gitlab/codeowners?

在项目目录运行 npm install @gitlab/codeowners,或使用 pnpm add / yarn add / bun add。

@gitlab/codeowners 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@gitlab/codeowners 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@gitlab/codeowners 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=20.11.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@gitlab/codeowners 可以商用吗?

@gitlab/codeowners 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@gitlab/codeowners 的下载量有多少?

根据 npm 官方下载统计,@gitlab/codeowners 在 2026/10/17 – 2026/11/15 这 30 天内被下载 54,621 次,日均约 1,821 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@gitlab/codeowners 还在维护吗?

最新版本 0.3.0 发布于 2026/09/23(1 个月前);至今共发布 13 个版本,其中过去 12 个月发布了 3 个;首次发布于 2024/04/05。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。