codeowners-generator

<p align="center" <a href="https://www.npmjs.com/package/codeowners-generator" <img src="https://img.shields.io/npm/v/codeowners-generator/latest.svg?style=flat-square" alt="NPM Version" / </a <a href="https://github.com/gagoar/codeowners-generator/actions" <img src="https://github.com/gagoar/codeowners-generator/workflows/codeowners-generator/badge.svg" alt="Workflow" / </a <a href="https://codecov.io/gh/gagoar/codeowners-generator" <img src="https://codecov.io/gh/gagoar/codeowners-generator/branch/master/graph/badge.svg?token=48gHuQl8zV" alt="codecov" / </a <a href="https://github.com/gagoar/codeowners-generator/blob/master/LICENSE" <img src="https://img.shields.io/npm/l/codeowners-generator.svg?style=flat-square" alt="MIT license" / </a </p

<p align="center"

<h3 align="center"codeowners-generator</h3 <p align="center" <a href="https://gagoar.github.io/codeowners-generator/" <img src="images/logo.png" alt="Logo" width="128" height="128" </a </p

<p align="center" this project is sponsored by: <br <a href="https://sourcegraph.com/" <img src="https://sourcegraph.com/.assets/img/sourcegraph-logo-light.svg" alt="SourceGraph" width="20%" </a </p

<p align="center" ✨ use codeowners anywhere in your monorepo 🛠️ <br / <a href="https://gagoar.github.io/codeowners-generator/"<strongExplore the docs »</strong</a <br / <a href="https://github.com/gagoar/codeowners-generator/issues"Report Bug</a · <a href="https://github.com/gagoar/codeowners-generator/issues"Request Feature</a </p </p

Table of Contents

• About the Project
• Built With
• Installation
• Configuration
• Usage
• Action

• Contributing
• License

About The Project

CODEOWNERS are automatically requested for review when someone opens a pull request that modifies code that they own. This is a great feature, but when working on monorepos ownership is shared between teams and it becomes difficult to maintain.

codeowners-generator allows you to position CODEOWNERS files anywhere in your project tree and it will take care of compiling all the files into a single generated file, that Github can understand. It also can read the maintainers fields (contributors, author and alternatively maintainers) in package.json (--use-maintainers option in the cli ) making easy to keep CODEOWNERS and package.json in sync. Make sure the author/contributors syntax matches with package.json expected syntax from the documentation.

Built With

• ora
• commander
• cosmiconfig

Installation

If you wish to use codeowners-generator as a standalone utility:

npm -g install codeowners-generator

This will make the codeowners-generator command available in your terminal.

codeowners-generator --help