# codeowners-utils

> Utilities for working with CODEOWNERS files

Latest version **1.0.2** (published 2020-04-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install codeowners-utils
pnpm add codeowners-utils
yarn add codeowners-utils
bun add codeowners-utils
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2020-04-29 |
| First published | 2019-01-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 24.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 21 |
| Author | Jamie Kyle |
| Maintainers | thejameskyle |
| Keywords | codeowners, utils, utilities, lib, globs |

## Links

- npm: https://www.npmjs.com/package/codeowners-utils
- Repository: https://github.com/jamiebuilds/codeowners-utils
- Homepage: https://github.com/jamiebuilds/codeowners-utils#readme
- Issues: https://github.com/jamiebuilds/codeowners-utils/issues
- npm.io page: https://npm.io/package/codeowners-utils

## Dependencies (4)

- [ignore](https://npm.io/package/ignore.md) ^5.1.4
- [find-up](https://npm.io/package/find-up.md) ^4.1.0
- [cross-spawn](https://npm.io/package/cross-spawn.md) ^7.0.2
- [locate-path](https://npm.io/package/locate-path.md) ^5.0.0

## Alternatives

- [@cantoo/pdf-lib](https://npm.io/package/@cantoo/pdf-lib.md) — 297.9K weekly downloads
- [datatables.net-buttons](https://npm.io/package/datatables.net-buttons.md) — 200.1K weekly downloads
- [@ckeditor/ckeditor5-export-pdf](https://npm.io/package/@ckeditor/ckeditor5-export-pdf.md) — 167.0K weekly downloads
- [scanbot-web-sdk](https://npm.io/package/scanbot-web-sdk.md) — 15.0K weekly downloads
- [@syncfusion/ej2-angular-pdfviewer](https://npm.io/package/@syncfusion/ej2-angular-pdfviewer.md) — 8.8K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2020-04-29
- 1.0.1 — 2020-04-29
- 1.0.0 — 2019-01-24

## README

# codeowners-utils

> Utilities for working with CODEOWNERS files

## Install

```sh
npm install --save codeowners-utils
```

## API

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

```ts
/**
 * An individual entry from a CODEOWNERS file
 */
export interface CodeOwnersEntry {
	pattern: string
	owners: Array<string>
}

/**
 * Parse a CODEOWNERS file into an array of entries (will be in reverse order
 * of the file).
 */
export declare function parse(str: string): Array<CodeOwnersEntry>

/**
 * Standard locations to search for the CODEOWNERS file in priority order
 * (Note: This comes from GitHub).
 */
export declare let CODEOWNERS_PATHS: string[]

/**
 * Find the path of the CODEOWNERS file from the current working directory.
 */
export declare function findOwnersPath(cwd: string): Promise<string | null>

/**
 * Find, load, and parse the CODEOWNERS file (if it exists) from the current
 * working directory.
 */
export declare function loadOwners(
	cwd: string,
): Promise<Array<CodeOwnersEntry> | null>

/**
 * Match a filename against a glob pattern (while respecting .gitignore rules)
 */
export declare function matchPattern(filename: string, pattern: string): boolean

/**
 * Match a filename against CODEOWNERS entries to determine which (if any) it
 * matches.
 */
export declare function matchFile(
	filename: string,
	entries: Array<CodeOwnersEntry>,
): CodeOwnersEntry | null

/**
 * Given a set of files and CODEOWNERS entries, return the set of files which
 * are not matched to any CODEOWNERS entries.
 */
export declare function filterUnmatchedFiles(
	files: Array<string>,
	entries: Array<CodeOwnersEntry>,
): string[]

/**
 * Find all of the files in a git repository which are not matched by any code
 * owners using a set of CODEOWNERS entries.
 */
export declare function findUnmatchedFilesFromEntries(
	entries: Array<CodeOwnersEntry>,
	cwd: string,
): Promise<Array<string>>

/**
 * Find all of the files in a git repository which are not matched by any code
 * owners.
 */
export declare function findUnmatchedFiles(
	cwd: string,
): Promise<Array<string> | null>
```

---
_Source: https://npm.io/package/codeowners-utils · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
