codeowners-utils

Utilities for working with CODEOWNERS files

Install

1npm install --save codeowners-utils

API

From the generated dist/codeowners-utils.d.ts file:

1/**
2 * An individual entry from a CODEOWNERS file
3 */
4export interface CodeOwnersEntry {
5	pattern: string
6	owners: Array<string>
7}
8
9/**
10 * Parse a CODEOWNERS file into an array of entries (will be in reverse order
11 * of the file).
12 */
13export declare function parse(str: string): Array<CodeOwnersEntry>
14
15/**
16 * Standard locations to search for the CODEOWNERS file in priority order
17 * (Note: This comes from GitHub).
18 */
19export declare let CODEOWNERS_PATHS: string[]
20
21/**
22 * Find the path of the CODEOWNERS file from the current working directory.
23 */
24export declare function findOwnersPath(cwd: string): Promise<string | null>
25
26/**
27 * Find, load, and parse the CODEOWNERS file (if it exists) from the current
28 * working directory.
29 */
30export declare function loadOwners(
31	cwd: string,
32): Promise<Array<CodeOwnersEntry> | null>
33
34/**
35 * Match a filename against a glob pattern (while respecting .gitignore rules)
36 */
37export declare function matchPattern(filename: string, pattern: string): boolean
38
39/**
40 * Match a filename against CODEOWNERS entries to determine which (if any) it
41 * matches.
42 */
43export declare function matchFile(
44	filename: string,
45	entries: Array<CodeOwnersEntry>,
46): CodeOwnersEntry | null
47
48/**
49 * Given a set of files and CODEOWNERS entries, return the set of files which
50 * are not matched to any CODEOWNERS entries.
51 */
52export declare function filterUnmatchedFiles(
53	files: Array<string>,
54	entries: Array<CodeOwnersEntry>,
55): string[]
56
57/**
58 * Find all of the files in a git repository which are not matched by any code
59 * owners using a set of CODEOWNERS entries.
60 */
61export declare function findUnmatchedFilesFromEntries(
62	entries: Array<CodeOwnersEntry>,
63	cwd: string,
64): Promise<Array<string>>
65
66/**
67 * Find all of the files in a git repository which are not matched by any code
68 * owners.
69 */
70export declare function findUnmatchedFiles(
71	cwd: string,
72): Promise<Array<string> | null>