https://github.com/beaugunderson/codeowners

👁 audit your CODEOWNERS file
https://github.com/beaugunderson/codeowners

Last synced: 12 days ago
JSON representation

👁 audit your CODEOWNERS file

• Host: GitHub
• URL: https://github.com/beaugunderson/codeowners
• Owner: beaugunderson
• Created: 2017-08-23T05:21:20.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2024-07-15T23:30:22.000Z (4 months ago)
• Last Synced: 2024-10-17T19:18:02.366Z (25 days ago)
• Language: JavaScript
• Homepage: https://npmjs.org/codeowners
• Size: 163 KB
• Stars: 67
• Watchers: 3
• Forks: 27
• Open Issues: 25
• Metadata Files:
  • Readme: README.md
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# codeowners

A tool for interacting with GitHub's

[CODEOWNERS](https://help.github.com/articles/about-codeowners/) files.

Usable as a CLI, or as a library.

## installation

```sh

$ npm install -g codeowners

```

## cli usage

Print a list of each files in the current repo, followed by its owner:

```sh

$ codeowners audit

```

To find a list of files not covered by the `CODEOWNERS` in the project:

```sh

$ codeowners audit --unowned

```

Specify a non-standard CODEOWNERS filename

```sh

$ codeowners audit -c CODEKEEPERS

```

Verify users/teams own a specific path

```sh

$ codeowners verify src/ @foob_ar @contoso/engineers

```

## library usage

```js

const Codeowners = require('codeowners');

// workingDir is optional, defaults to process.cwd()

const repos = new Codeowners(workingDir);

repos.getOwner('path/to/file.js'); // => array of owner strings, e.g. ['@noahm']

```

## CHANGELOG

### 5.0.0

- Much-improved performance

- Removal of automatic column width calculation

- Addition of `-w/--width` option for manual column width

  - Or use e.g. `codeowners audit | column -ts "    "`