@ktpartners/dgs-platform 2.6.2

package/deliver-great-systems/bin/lib/identity.cjs

@@ -0,0 +1,125 @@
+/**
+ * Identity — Git identity resolution and author formatting
+ *
+ * Provides requireGitIdentity() for gate-checking git user configuration
+ * and formatAuthorString() for producing file metadata author strings.
+ *
+ * Called at the start of every DGS write command. Read-only commands
+ * (list-ideas, list-specs, list-docs, search) skip the gate check.
+ */
+
+const { execSync } = require('child_process');
+const { output, error } = require('./core.cjs');
+
+// ─── Identity Resolution ─────────────────────────────────────────────────────
+
+/**
+ * Resolves the current git user identity from git config.
+ *
+ * @param {string} [cwd] - Working directory for git config lookup.
+ *   If omitted, uses process.cwd().
+ * @param {Object} [execOptions] - Additional options passed to execSync
+ *   (e.g., { env: { PATH: '' } } for testing git-not-installed path).
+ * @returns {{ name: string, email: string }}
+ *   name is always a trimmed string with length >= 2.
+ *   email is a trimmed string, or '' if user.email is not configured.
+ * @throws {Error} If git is not installed, or user.name is missing/too short.
+ */
+function requireGitIdentity(cwd, execOptions) {
+  const opts = Object.assign(
+    { encoding: 'utf-8', stdio: 'pipe' },
+    cwd ? { cwd } : {},
+    execOptions || {}
+  );
+
+  // ── Resolve user.name ───────────────────────────────────────────────────
+  let name;
+  try {
+    name = execSync('git config user.name', opts);
+  } catch (e) {
+    // Distinguish "git not installed" from "config key not set"
+    if (e.code === 'ENOENT' || (e.message && e.message.includes('not found'))) {
+      throw new Error(
+        'Git is not installed or not in your PATH.\n' +
+        'DGS requires Git. Install it from https://git-scm.com/ and try again.'
+      );
+    }
+    // git config exits 1 when the key is not set — treat as empty
+    name = '';
+  }
+
+  name = (name || '').trim();
+
+  if (!name || name.length < 2) {
+    throw new Error(
+      'DGS requires a git username (at least 2 characters). Set one with:\n' +
+      '  git config --global user.name "Your Name"\n' +
+      'Then try again.'
+    );
+  }
+
+  // ── Resolve user.email (optional) ───────────────────────────────────────
+  let email;
+  try {
+    email = execSync('git config user.email', opts);
+  } catch {
+    email = '';
+  }
+
+  email = (email || '').trim();
+
+  return { name, email };
+}
+
+// ─── Author Formatting ───────────────────────────────────────────────────────
+
+/**
+ * Formats an identity object into an author string for file metadata.
+ *
+ * @param {{ name: string, email: string }} identity
+ * @returns {string} "Name <email>" when email is present, "Name" when absent.
+ */
+function formatAuthorString(identity) {
+  if (identity.email) {
+    return identity.name + ' <' + identity.email + '>';
+  }
+  return identity.name;
+}
+
+// ─── Author Name Extraction ─────────────────────────────────────────────────
+
+/**
+ * Extracts the name portion from an author string, stripping the email.
+ *
+ * @param {string|null|undefined} author - Author string (e.g., "Name <email>")
+ * @returns {string} Name portion only, or empty string for null/undefined/empty.
+ */
+function extractNameFromAuthor(author) {
+  if (!author) return '';
+  const match = author.match(/^(.+?)\s*<[^>]+>$/);
+  return match ? match[1].trim() : author;
+}
+
+// ─── CLI Command ────────────────────────────────────────────────────────────
+
+/**
+ * CLI handler for `identity resolve`.
+ * Resolves the current git identity and outputs it as JSON or raw author string.
+ *
+ * @param {string} cwd - Working directory
+ * @param {boolean} raw - If true, output raw author string only
+ */
+function cmdIdentityResolve(cwd, raw) {
+  let identity;
+  try {
+    identity = requireGitIdentity(cwd);
+  } catch (e) {
+    error(e.message);
+  }
+  const authorString = formatAuthorString(identity);
+  output({ name: identity.name, email: identity.email, author: authorString }, raw, authorString);
+}
+
+// ─── Exports ─────────────────────────────────────────────────────────────────
+
+module.exports = { requireGitIdentity, formatAuthorString, extractNameFromAuthor, cmdIdentityResolve };