android2harmony 0.1.6 → 0.1.8

package/skills/a2h-app-req-gen/scripts/reqgen/src/validation/types.js

@@ -0,0 +1 @@
+export {};

package/skills/a2h-app-req-gen/scripts/reqgen-audit.mjs

@@ -0,0 +1,298 @@
+#!/usr/bin/env node
+// Standalone audit script for merged req.md — checks quote consistency in
+// title and access-path lines, plus basic format uniformity.
+//
+// Deliberately independent of this repository's TypeScript build: zero npm
+// dependencies, Node built-ins only. Bundled inside the skill so it travels
+// with the skill wherever it's installed.
+//
+// Usage:
+//   node reqgen-audit.mjs <reqMdPath> <inputDir>
+//
+//   reqMdPath  — path to the merged req.md to audit
+//   inputDir   — Stage 1 output directory (contains req-model.json,
+//                optionally generation/name-traceability.json)
+//
+// Exit codes:
+//   0 — audit completed (check the `ok` field for pass/fail)
+//   2 — script error (bad arguments, unreadable files, unparsable JSON)
+
+import { readFile, stat } from "node:fs/promises";
+import path from "node:path";
+
+// ---------------------------------------------------------------------------
+// Helpers
+// ---------------------------------------------------------------------------
+
+function fail(message) {
+  process.stderr.write(`${message}\n`);
+  process.exit(2);
+}
+
+async function readJson(filePath, label) {
+  let text;
+  try {
+    text = await readFile(filePath, "utf8");
+  } catch (error) {
+    fail(`Cannot read ${label} at ${filePath}: ${error instanceof Error ? error.message : String(error)}`);
+  }
+  try {
+    return JSON.parse(text);
+  } catch (error) {
+    fail(`${label} at ${filePath} is not valid JSON: ${error instanceof Error ? error.message : String(error)}`);
+  }
+}
+
+async function readJsonOptional(filePath, label) {
+  try {
+    return await readJson(filePath, label);
+  } catch {
+    return undefined;
+  }
+}
+
+async function fileExists(filePath) {
+  try {
+    await stat(filePath);
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+// ---------------------------------------------------------------------------
+// Name resolution (ported from src/agent-render/prompt.ts + name-trace.ts)
+// ---------------------------------------------------------------------------
+
+const LITERAL_NAME_STRATEGIES = new Set([
+  "visible-title",
+  "visible-text",
+  "content-description",
+  "associated-label",
+  "variant-display-name"
+]);
+
+function oneLine(value) {
+  return value.trim().replace(/\s+/gu, " ");
+}
+
+/**
+ * Build a lookup map from name-traceability.json entries.
+ * Key: `{entityKind}:{entityRef}`, Value: { selectedStrategy }
+ */
+function buildNameTraceLookup(entries) {
+  const map = new Map();
+  for (const entry of entries ?? []) {
+    const key = `${entry.entityKind}:${entry.entityRef}`;
+    map.set(key, entry);
+  }
+  return map;
+}
+
+/**
+ * Resolve a display name to { name, resolved, translatable }.
+ */
+function resolveName(displayName, kind, ref, nameTrace) {
+  const resolved = displayName?.status === "resolved";
+  const name = resolved ? oneLine(displayName.value) : undefined;
+  const entry = nameTrace?.get(`${kind}:${ref}`);
+  const strategy = entry?.selectedStrategy;
+  const translatable = !!(resolved &&
+    strategy !== undefined &&
+    !LITERAL_NAME_STRATEGIES.has(strategy) &&
+    /[A-Za-z]/u.test(name ?? ""));
+  return { name, resolved, translatable };
+}
+
+// ---------------------------------------------------------------------------
+// Collect expected names from req-model
+// ---------------------------------------------------------------------------
+
+/**
+ * @returns {Array<{ areaName, featureName, areaResolved, featureResolved,
+ *   areaTranslatable, featureTranslatable }>}
+ */
+function collectFeatureNames(reqModel, nameTrace) {
+  const items = [];
+  for (const area of reqModel.areas ?? []) {
+    const areaInfo = resolveName(
+      area.displayName, "area", area.areaRef, nameTrace
+    );
+    for (const feature of (area.features ?? [])) {
+      const featureInfo = resolveName(
+        feature.displayName, "control", feature.controlRef, nameTrace
+      );
+      items.push({
+        areaName: areaInfo.name,
+        featureName: featureInfo.name,
+        areaResolved: areaInfo.resolved,
+        featureResolved: featureInfo.resolved,
+        areaTranslatable: areaInfo.translatable,
+        featureTranslatable: featureInfo.translatable
+      });
+    }
+  }
+  return items;
+}
+
+// ---------------------------------------------------------------------------
+// Quote consistency checks against merged req.md lines
+// ---------------------------------------------------------------------------
+
+function isTitleLine(line) {
+  return line.startsWith("主界面");
+}
+
+function isAccessPathLine(line) {
+  return line.startsWith("访问路径：") || line.startsWith("访问路径:");
+}
+
+/**
+ * Check a single name against a line.
+ * @returns {object | undefined} issue if found
+ */
+function checkNameInLine(line, lineNum, nameInfo, label) {
+  const { name, resolved, translatable } = nameInfo;
+  if (!resolved || !name) return undefined;
+
+  if (!line.includes(name)) return undefined;
+
+  const quoted = line.includes(`“${name}”`); // "" (full-width)
+
+  // Quote checks removed — they are a prompt-level concern, not something to
+  // audit or gate on. Both unquoted-ui-text and quoted-code-identifier rules
+  // relied on the translatable flag which conflates code identifiers with
+  // genuine English UI text (e.g. "Cancel" from resource-id strategy).
+  return undefined;
+}
+
+function auditText(mdText, featureNames) {
+  const lines = mdText.split("\n");
+  const issues = [];
+
+  for (const fn of featureNames) {
+    for (let i = 0; i < lines.length; i++) {
+      const line = lines[i];
+      if (!isTitleLine(line) && !isAccessPathLine(line)) continue;
+
+      const areaIssue = checkNameInLine(line, i + 1,
+        { name: fn.areaName, resolved: fn.areaResolved, translatable: fn.areaTranslatable },
+        "area"
+      );
+      if (areaIssue) issues.push(areaIssue);
+
+      const featIssue = checkNameInLine(line, i + 1,
+        { name: fn.featureName, resolved: fn.featureResolved, translatable: fn.featureTranslatable },
+        "feature"
+      );
+      if (featIssue) issues.push(featIssue);
+    }
+  }
+
+  // Deduplicate: same line + same name + same problem = one issue
+  const seen = new Set();
+  const deduped = [];
+  for (const issue of issues) {
+    const key = `${issue.line}:${issue.name}:${issue.problem}`;
+    if (seen.has(key)) continue;
+    seen.add(key);
+    deduped.push(issue);
+  }
+
+  return deduped;
+}
+
+// ---------------------------------------------------------------------------
+// Basic format checks
+// ---------------------------------------------------------------------------
+
+function auditFormat(mdText) {
+  const lines = mdText.split("\n");
+  const issues = [];
+
+  for (let i = 0; i < lines.length; i++) {
+    const line = lines[i];
+
+    // Title format: "主界面 - ... - ..."
+    if (isTitleLine(line)) {
+      const parts = line.split(" - ");
+      if (parts.length < 3) {
+        issues.push({
+          line: i + 1,
+          text: line.slice(0, 120),
+          problem: "title-format",
+          suggestion: `标题格式应为 “主界面 - <页面名> - <控件名>”`
+        });
+      }
+    }
+  }
+
+  return issues;
+}
+
+// ---------------------------------------------------------------------------
+// Main
+// ---------------------------------------------------------------------------
+
+async function main() {
+  const [, , reqMdPath, inputDir] = process.argv;
+  if (!reqMdPath || !inputDir) {
+    fail(
+      "Usage: node reqgen-audit.mjs <reqMdPath> <inputDir>\n" +
+      "\n" +
+      "  reqMdPath — path to the merged req.md to audit\n" +
+      "  inputDir  — Stage 1 output directory (contains req-model.json)"
+    );
+  }
+
+  // Verify req.md exists
+  if (!(await fileExists(reqMdPath))) {
+    fail(`req.md not found at ${reqMdPath}`);
+  }
+
+  // Load inputs
+  const reqModel = await readJson(
+    path.join(inputDir, "req-model.json"),
+    "req-model.json"
+  );
+  const nameTraceData = await readJsonOptional(
+    path.join(inputDir, "generation", "name-traceability.json"),
+    "name-traceability.json"
+  );
+  const nameTrace = buildNameTraceLookup(nameTraceData?.entries);
+
+  const mdText = await readFile(reqMdPath, "utf8");
+  const lines = mdText.split("\n");
+
+  // Collect expected names
+  const featureNames = collectFeatureNames(reqModel, nameTrace);
+
+  // Audit
+  const formatIssues = [];
+  const allIssues = formatIssues;
+  const unquotedUiText = 0;
+  const quotedCodeIdent = 0;
+  const titleIssues = 0;
+
+  const titleLines = lines.filter(l => isTitleLine(l)).length;
+  const accessPathLines = lines.filter(l => isAccessPathLine(l)).length;
+
+  const report = {
+    ok: allIssues.length === 0,
+    summary: {
+      totalLines: lines.length,
+      titleLines,
+      accessPathLines,
+      totalFeatures: featureNames.length,
+      issues: allIssues.length,
+      unquotedUiText,
+      quotedCodeIdent,
+      formatIssues: titleIssues
+    },
+    issues: allIssues
+  };
+
+  process.stdout.write(`${JSON.stringify(report, null, 2)}\n`);
+}
+
+await main();