code-owners-report

Reports metrics on all your files, and rolls them up to owners.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
code-owners-report
110.5.05 years ago6 years agoMinified + gzip package size for code-owners-report in KB

Readme

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/EXAMPLEREPORT.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

-   [Parameters](#parameters)
-   [Parameters](#parameters-1)
-   [Parameters](#parameters-2)

formatReport

Format the report as Markdown text

Parameters

  • reportSpec ReportSpec
  • report any

generateReport

Generate a report over the basedir

Parameters


Returns Promise<CodeReport>

measureFileTree

Report metrics on every file within dir

Parameters

ReportSpec
Returns Promise<FilesMetricsMap>

Contributors

Thanks to Diego Haz
for nod and Beau Gunderson for earlier work on codeowners.