Yoyaku's docs/metrics.md is a generated snapshot of the codebase, but the generator that produces it is not in the repository, so the page can only be refreshed by hand and drifts from the code.

This adds scripts/generate-metrics.php, ported from the Orchestra module's generator and adapted to Yoyaku, and regenerates docs/metrics.md from it. The script reads cloc per-file JSON on standard input and writes the prose, tables and inline SVG charts, so nothing on the page is hand-maintained. Run it from the module root:

cloc --exclude-dir=node_modules --by-file --json --quiet . | php scripts/generate-metrics.php

Issue fork yoyaku-3611633

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

mably created an issue. See original summary.

mably opened merge request !36

mably’s picture

mably commented
Status: Active » Needs review

Opened MR !36. It adds scripts/generate-metrics.php (ported from the Orchestra module generator, adapted to Yoyaku) and regenerates docs/metrics.md from it, so the metrics page is generated rather than hand-maintained.

  • mably committed 67c716d4 on 1.x 
    task: #3611633 Add a metrics generator script and refresh the codebase...
mably’s picture

mably commented
Status: Needs review » Fixed

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.