0.5.0 • Published 5 years ago
code-owners-report v0.5.0
code-owners-report
Generate a report about the files in your repository, and aggregate them by CODEOWNERS.
Usage
This is meant to be tailored to your workflow and CI, so for maximum flexibility the tool is offered as a library of utility methods. Will gladly accept PRs for a CLI.
See docs/example.js and its output docs/EXAMPLE_REPORT.md, inlined here:
This report was autogenerated by code-owners-report.
| markdown | no-console |
|---|---|
| 1 | 2 |
| owner | markdown | no-console |
|---|---|---|
| @global-owner1 | - | - |
| @global-owner2 | - | - |
| @js-owner | 1 | 2 |
| filename | markdown | no-console |
|---|---|---|
| src/README.md | - | - |
| src/aggregateCounts.js | - | - |
| src/codeowners.js | - | - |
| src/config.js | - | - |
| src/eslintMetrics.js | - | - |
| src/formatMarkdown.js | true | - |
| src/index.js | - | - |
| src/measureFileTree.js | - | 2 |
| src/regexpMetrics.js | - | - |
API
Table of Contents
formatReport
Format the report as Markdown text
Parameters
reportSpecReportSpecreportany
generateReport
Generate a report over the basedir
Parameters
Returns Promise<CodeReport>
measureFileTree
Report metrics on every file within dir
Parameters
dirstringspecReportSpec
Returns Promise<FilesMetricsMap>
Contributors
Thanks to Diego Haz for nod and Beau Gunderson for earlier work on codeowners.