Skip to content

Commit 367690c

Browse files
committed
ci: move maturity renderer under qa scripts
1 parent 9f1112a commit 367690c

3 files changed

Lines changed: 16 additions & 14 deletions

File tree

.github/workflows/maturity-scorecard.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ on:
2525
- "docs/maturity-scorecard.md"
2626
- "docs/taxonomy.md"
2727
- "docs/taxonomy-outline.md"
28-
- "scripts/render-maturity-docs.ts"
28+
- "scripts/qa/render-maturity-docs.ts"
2929
- "package.json"
3030
- ".github/workflows/maturity-scorecard.yml"
3131
pull_request:
@@ -35,7 +35,7 @@ on:
3535
- "docs/maturity-scorecard.md"
3636
- "docs/taxonomy.md"
3737
- "docs/taxonomy-outline.md"
38-
- "scripts/render-maturity-docs.ts"
38+
- "scripts/qa/render-maturity-docs.ts"
3939
- "package.json"
4040
- ".github/workflows/maturity-scorecard.yml"
4141

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1573,8 +1573,8 @@
15731573
"docs:list": "node scripts/docs-list.js",
15741574
"docs:spellcheck": "bash scripts/docs-spellcheck.sh",
15751575
"docs:spellcheck:fix": "bash scripts/docs-spellcheck.sh --write",
1576-
"maturity:check": "node --import tsx scripts/render-maturity-docs.ts --check",
1577-
"maturity:render": "node --import tsx scripts/render-maturity-docs.ts",
1576+
"maturity:check": "node --import tsx scripts/qa/render-maturity-docs.ts --check",
1577+
"maturity:render": "node --import tsx scripts/qa/render-maturity-docs.ts",
15781578
"dup:check": "node scripts/check-duplicates.mjs",
15791579
"dup:check:coverage": "node scripts/check-duplicates.mjs --coverage",
15801580
"dup:check:json": "node scripts/check-duplicates.mjs --json",
Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ function parseArgs(argv: string[]): Args {
237237
} else if (arg === "--evidence-dir") {
238238
args.evidenceDir = next();
239239
} else if (arg === "--help" || arg === "-h") {
240-
process.stdout.write(`Usage: node --import tsx scripts/render-maturity-docs.ts [options]
240+
process.stdout.write(`Usage: node --import tsx scripts/qa/render-maturity-docs.ts [options]
241241
242242
Options:
243243
--taxonomy <path> Taxonomy YAML path (default: taxonomy.yaml)
@@ -258,8 +258,8 @@ Options:
258258
return args;
259259
}
260260

261-
function readYaml<T>(filePath: string): T {
262-
return YAML.parse(fs.readFileSync(filePath, "utf8")) as T;
261+
function readYaml(filePath: string): unknown {
262+
return YAML.parse(fs.readFileSync(filePath, "utf8"));
263263
}
264264

265265
function assertObject(value: unknown, label: string): Record<string, unknown> {
@@ -430,9 +430,9 @@ function expectedLtsSupported(
430430
scoreCategory: ScoreCategory,
431431
taxonomyCategory: TaxonomyCategory,
432432
): boolean {
433-
return Boolean(
433+
return (
434434
(scoreCategory.quality.score > 80 && scoreCategory.coverage.score > 90) ||
435-
taxonomyCategory.human_lts_override === true,
435+
taxonomyCategory.human_lts_override === true
436436
);
437437
}
438438
@@ -653,15 +653,17 @@ function familyTitle(value: string): string {
653653
);
654654
}
655655
656-
function markdownEscape(value: unknown): string {
656+
type RenderScalar = string | number | boolean | null | undefined;
657+
658+
function markdownEscape(value: RenderScalar): string {
657659
return String(value ?? "").replaceAll("|", "\\|");
658660
}
659661
660-
function yamlCode(value: unknown): string {
662+
function yamlCode(value: RenderScalar): string {
661663
return `\`${markdownEscape(value)}\``;
662664
}
663665

664-
function htmlAttributeEscape(value: unknown): string {
666+
function htmlAttributeEscape(value: RenderScalar): string {
665667
return String(value ?? "")
666668
.replaceAll("&", "&amp;")
667669
.replaceAll('"', "&quot;")
@@ -1270,8 +1272,8 @@ function main(): void {
12701272
const taxonomyPath = path.normalize(args.taxonomy);
12711273
const scoresPath = path.normalize(args.scores);
12721274
const outputDir = path.normalize(args.outputDir);
1273-
const taxonomy = readYaml<Taxonomy>(taxonomyPath);
1274-
const scores = readYaml<Scores>(scoresPath);
1275+
const taxonomy = readYaml(taxonomyPath) as Taxonomy;
1276+
const scores = readYaml(scoresPath) as Scores;
12751277
validateTaxonomy(taxonomy, taxonomyPath);
12761278
const scoreWarnings = validateScores(scores, scoresPath, taxonomy);
12771279
const evidenceSummaries = readEvidenceSummaries(args.evidenceDir);

0 commit comments

Comments
 (0)