Package Exports

code-owners-report

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (code-owners-report) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

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

formatReport

Format the report as Markdown text

Parameters

reportSpec ReportSpec
report any

report

Generate a report over the basedir

Parameters

basedir string
reportSpec ReportSpec
codeownersPath string

measureFileTree

Report metrics on every file within dir

Parameters

dir string
spec ReportSpec

Returns Promise<FilesMetricsMap>

Contributors

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