quizlet / code-owners-report

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

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
  • Parameters
• generateReport
  • Parameters
• measureFileTree
  • Parameters

formatReport

Format the report as Markdown text

Parameters

• reportSpec ReportSpec
• report any

generateReport

Generate a report over the basedir

Parameters

• basedirOpt (Array<string> | string)
• reportSpec ReportSpec
• ignores Array<RegExp> (optional, default [])
• codeownersPath string

Returns Promise<CodeReport>

measureFileTree

Report metrics on every file within dir

Parameters

• dir string
• spec ReportSpec
• ignoredPaths Array<RegExp>

Returns Promise<FilesMetricsMap>

Contributors

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