sync-header-metadata 2.3.0

package/src/sync.js

@@ -0,0 +1,265 @@
+// vim:set expandtab shiftwidth=4 filetype=javascript:
+// SPDX-License-Identifier: GPL-3.0-only
+
+//
+//
+// ~chewygumxx/sync-header-metadata.git
+// ::: :/src/sync.js
+//
+//
+
+"use strict";
+
+const fs = require("node:fs");
+const path = require("node:path");
+const { execFileSync } = require("node:child_process");
+
+// A file opts out of header syncing by explicitly unsetting the
+// 'sync-header-metadata' boolean attribute in .gitattributes, e.g.:
+//   /LICENSE -sync-header-metadata
+//
+// default.gitattributes ships a baseline exclusion list (LICENSE, lockfiles,
+// *.json, etc.) via `core.attributesFile`, which git consults only as a
+// last resort. Any matching line in the repo's own .gitattributes/
+// info/attributes always takes precedence over it.
+const ATTR = "sync-header-metadata";
+const DEFAULT_ATTRIBUTES_FILE = path.join(
+    __dirname,
+    "..",
+    "default.gitattributes",
+);
+
+// ------------------------------
+// Helpers: Resolve Header Lines
+// ------------------------------
+
+function findRepoMarker(lines) {
+    for (let i = 0; i < lines.length; i++) {
+        const m = REPO_MARKER_RE.exec(lines[i]);
+        if (m)
+            return {
+                index: i,
+                splitAt: m.index,
+                current: m[1],
+            };
+    }
+    return null;
+}
+
+const REPO_MARKER_RE = /~(\S+\/\S+?)\.git\s*$/;
+const PATH_MARKER_RE = / ::: :(\/\S*)\s*$/;
+function findPathMarker(lines) {
+    for (let i = 0; i < lines.length; i++) {
+        const m = PATH_MARKER_RE.exec(lines[i]);
+        if (m)
+            return {
+                index: i,
+                splitAt: m.index + m[0].indexOf(m[1]),
+                current: m[1],
+            };
+    }
+    return null;
+}
+
+// Shared by the Action (run.js) and the CLI (bin/sync-header-metadata.js);
+// each entry point resolves its own inputs and exits with the returned code.
+function sync({ mode, repository, log, cwd = process.cwd() }) {
+    const verify = mode === "verify";
+
+    // ------------------------
+    // Helper: Resolve Tracked
+    // ------------------------
+
+    try {
+        execFileSync("git", ["--version"], { stdio: "ignore" });
+    } catch {
+        log.fatal("Dependency not found in PATH: git", 127);
+    }
+
+    let repoRoot;
+    try {
+        repoRoot = execFileSync(
+            "git",
+            ["-C", cwd, "rev-parse", "--show-toplevel"],
+            { encoding: "utf8" },
+        ).trim();
+    } catch {
+        log.fatal("Not inside a git repository");
+    }
+
+    let fileListRaw;
+    try {
+        fileListRaw = execFileSync("git", ["-C", repoRoot, "ls-files", "-z"], {
+            encoding: "utf8",
+        });
+    } catch (err) {
+        log.fatal(`Failed to list tracked files: ${err.message}`);
+    }
+    const allFiles = fileListRaw.split("\0").filter(Boolean);
+
+    let checkAttrRaw = "";
+    if (allFiles.length > 0) {
+        checkAttrRaw = execFileSync(
+            "git",
+            [
+                "-c",
+                `core.attributesFile=${DEFAULT_ATTRIBUTES_FILE}`,
+                "-C",
+                repoRoot,
+                "check-attr",
+                "-z",
+                "--stdin",
+                ATTR,
+            ],
+            { input: allFiles.join("\0"), encoding: "utf8" },
+        );
+    }
+    const attrParts = checkAttrRaw.split("\0");
+    attrParts.pop();
+    const ignored = new Set();
+    for (let i = 0; i < attrParts.length; i += 3) {
+        if (attrParts[i + 2] === "unset") ignored.add(attrParts[i]);
+    }
+    const files = allFiles.filter((f) => !ignored.has(f));
+
+    if (files.length === 0) {
+        log.warn({
+            title: "Nothing Found",
+            message: "No tracked files found in repository",
+        });
+        return 0;
+    }
+
+    // ------------
+    // Parse Files
+    // ------------
+
+    let parsed = 0,
+        unreadable = 0;
+    let repoUpdated = 0,
+        repoCorrect = 0,
+        repoNotFound = 0;
+    let pathUpdated = 0,
+        pathCorrect = 0,
+        pathNotFound = 0;
+
+    for (const relpath of files) {
+        const filePath = `${repoRoot}/${relpath}`;
+        const repoPath = `/${relpath}`;
+
+        // Read
+        let content;
+        try {
+            content = fs.readFileSync(filePath, "utf8");
+            parsed++;
+        } catch {
+            log.warn({
+                file: relpath,
+                title: "Failed to read file as utf8 encoded",
+                message: `Consider ignoring with .gitattributes: \`${repoPath} -${ATTR}\` `,
+            });
+            unreadable++;
+            continue;
+        }
+        const eol = content.includes("\r\n") ? "\r\n" : "\n";
+        const lines = content.split(/\r\n|\n/);
+
+        // Repository
+        let changed = false;
+        const repoMarker = findRepoMarker(lines);
+        if (!repoMarker) {
+            log.warn({
+                file: relpath,
+                title: "Repo line not found",
+                message: "",
+            });
+            repoNotFound++;
+        } else if (repoMarker.current === repository) {
+            log.info(`Repo line correct: ${repoPath}`);
+            repoCorrect++;
+        } else if (verify) {
+            log.error({
+                file: relpath,
+                title: "Repo line out-of-sync",
+                message: `${repoMarker.current} =/= ${repository}`,
+                startLine: repoMarker.index + 1,
+            });
+            repoUpdated++;
+        } else {
+            const leader = lines[repoMarker.index].slice(0, repoMarker.splitAt);
+            lines[repoMarker.index] = `${leader}~${repository}.git`;
+            changed = true;
+            log.notice({
+                file: relpath,
+                title: "Repo line updated",
+                message: `${repoMarker.current} -> ${repository}`,
+                startLine: repoMarker.index + 1,
+            });
+            repoUpdated++;
+        }
+
+        // Filepath
+        const pathMarker = findPathMarker(lines);
+        if (!pathMarker) {
+            log.warn({
+                file: relpath,
+                title: "Path line not found",
+                message: "",
+            });
+            pathNotFound++;
+        } else if (pathMarker.current === repoPath) {
+            log.info(`Path line correct: ${repoPath}`);
+            pathCorrect++;
+        } else if (verify) {
+            log.error({
+                file: relpath,
+                title: "Path line out-of-sync",
+                message: `${pathMarker.current} =/= ${repoPath}`,
+                startLine: pathMarker.index + 1,
+            });
+            pathUpdated++;
+        } else {
+            const leader = lines[pathMarker.index].slice(0, pathMarker.splitAt);
+            lines[pathMarker.index] = `${leader}${repoPath}`;
+            changed = true;
+            log.notice({
+                file: relpath,
+                title: "Path line updated",
+                message: `${pathMarker.current} -> ${repoPath}`,
+                startLine: pathMarker.index + 1,
+            });
+            pathUpdated++;
+        }
+
+        // Write
+        if (changed) {
+            fs.writeFileSync(filePath, lines.join(eol));
+        }
+    }
+
+    // ---------------
+    // Post-Execution
+    // ---------------
+
+    const summary =
+        `    Files parsed: ${parsed}\n` +
+        `    Repo line - ${verify ? "Out-of-Sync" : "Updated"}: ${repoUpdated}, Correct: ${repoCorrect}, Not found: ${repoNotFound}\n` +
+        `    Path line - ${verify ? "Out-of-Sync" : "Updated"}: ${pathUpdated}, Correct: ${pathCorrect}, Not found: ${pathNotFound}\n` +
+        `    Files unreadable: ${unreadable}`;
+
+    let sumTitle;
+    if (verify) {
+        if (repoUpdated > 0 || pathUpdated > 0) {
+            sumTitle = "Verification Failed";
+            log.error({ title: sumTitle, message: `${sumTitle}:\n${summary}` });
+            return 1;
+        }
+        sumTitle = "Verification Passed";
+    } else {
+        sumTitle = "Update Complete";
+    }
+    log.notice({ title: sumTitle, message: `${sumTitle}:\n${summary}` });
+    return 0;
+}
+
+module.exports = { sync };