@bbckr/codeowners

A TypeScript library for parsing and composing CODEOWNERS files.

Features

• Supports both GitHub and GitLab CODEOWNERS syntax
• Preserves comments and whitespace
• Provides a way to get owners for a given file
• Parses CODEOWNERS files into an AST (Abstract Syntax Tree), allowing you to compose a CODEOWNERS file with entries, comments, and even sections (GitLab spec only)

Installation

1npm install @bbckr/codeowners

1yarn add @bbckr/codeowners

Usage

Parse a CODEOWNERS file

1import { CodeOwnersParser } from "@bbckr/codeowners";
2
3const input = `
4# comment # same comment
5/some/path owner1 @owner2
6
7/path/2 # comment
8`;
9
10const parser = new CodeOwnersParser();
11const codeowners = parser.parse(input);

Get the owners of a file

1const owners = codeowners.getOwners("path/to/file");

Output

['@owner1', '@owner2']

Compose a CODEOWNERS file programatically

1import { CodeOwners, PathNode, CommentNode } from "@bbckr/codeowners";
2
3const codeowners = new CodeOwners([
4  new PathNode("/path/to/file", ["owner1", "@owner2"]),
5  new CommentNode("# comment"),
6]);

Output

/path/to/file owner1 @owner2
# comment

Compose a GitLab CODEOWNERS file programatically

1import {
2  CodeOwners,
3  CodeOwnersSpec,
4  PathNode,
5  SectionNode,
6} from "@bbckr/codeowners";
7
8const codeowners = new CodeOwners(
9  [
10    new PathNode("/path/to/file", ["owner1", "@owner2"]),
11    new SectionNode(
12      "README Owners", // section name
13      false, // optional section
14      [], // owners
15      undefined, // count
16      undefined, // comment
17      undefined, // parent, undefined for root of file
18      [
19        new PathNode("README.md", ["@user1", "@user2"]),
20        new PathNode("internal/README.md", ["@user4"]),
21      ],
22    ),
23  ],
24  CodeOwnersSpec.Gitlab,
25);

Output

/path/to/file owner1 @owner2
[README Owners]
README.md @user1 @user2
internal/README.md @user4