report_components

R Documentation

Generate manifests and reports for the current generated component surface

Description

Builds deterministic manifest and markdown report artifacts describing the current generated-file integrity, upstream component coverage, initial component API conformance, and handwritten exported package APIs.

Usage

report_components(
  root = ".",
  metadata_file = .default_metadata_file(),
  version_file = .default_metadata_version_file(),
  binding_policy_file = .default_binding_policy_file(),
  attribute_policy_file = .default_attribute_policy_file(),
  coverage_policy_file = .default_cov_policy_file(),
  verbose = interactive()
)

Arguments

root	Repository root directory.
metadata_file	Path to the copied 'custom-elements.json' file, relative to the repository root.
version_file	Path to the copied Web Awesome version file, relative to the repository root.
binding_policy_file	Path to the handwritten binding-override policy file, relative to the repository root.
attribute_policy_file	Path to the handwritten attribute-override policy file, relative to the repository root.
coverage_policy_file	Path to the handwritten component-coverage policy file, relative to the repository root.
verbose	Logical scalar. If 'TRUE', emits a short summary.

Details

CLI entry point: './tools/report_components.R –help'

Value

A list describing the generated manifests, reports, and the schema surface used to compute them.

Examples

## Not run: 
report_components()

## End(Not run)