wyvrnpm 2.10.2 → 2.12.2

package/src/bootstrap/index.js

@@ -1,220 +1,220 @@
-'use strict';
-
-const fs   = require('fs');
-const path = require('path');
-const { execFileSync } = require('child_process');
-
-const { tagToVersion, nameFromUrl } = require('./version');
-const { detectFromRepo }            = require('./detect');
-const { lookupCookbook }            = require('./cookbook');
-const log                           = require('../logger');
-
-/**
- * Clone `gitUrl` into `destDir` so bootstrap can read the tree.
- * Defaults to a full clone — bootstrap's target audience is "I forked
- * these repos to maintain them", so they want the history. `--shallow`
- * opts into `--depth 1` (faster, but `git describe --tags` will miss
- * tags that aren't reachable from the single fetched commit, so the
- * version detection degrades to HEAD SHA placeholder + TODO).
- *
- * Uses the user's ambient git auth (SSH keys, credential helper). We do
- * NOT manage credentials here.
- *
- * @param {{ gitUrl: string, destDir: string, ref?: string | null, shallow?: boolean }} opts
- */
-function cloneRepo({ gitUrl, destDir, ref = null, shallow = false }) {
-  const args = ['clone'];
-  if (shallow) args.push('--depth', '1');
-  if (ref)     args.push('--branch', ref);
-  args.push('--', gitUrl, destDir);
-  log.info(`  git ${args.join(' ')}`);
-  execFileSync('git', args, { stdio: 'inherit' });
-}
-
-/**
- * Read HEAD SHA + nearest tag out of an existing clone. Pure
- * read-side — never writes. Returns nulls on failure so the caller
- * can surface a TODO rather than abort.
- *
- * @param {string} repoDir
- * @returns {{ sha: string | null, tag: string | null }}
- */
-function readGitState(repoDir) {
-  const safe = (args) => {
-    try {
-      return execFileSync('git', args, { cwd: repoDir, stdio: ['ignore', 'pipe', 'ignore'] })
-        .toString('utf8').trim() || null;
-    } catch { return null; }
-  };
-  return {
-    sha: safe(['rev-parse', 'HEAD']),
-    // `--abbrev=0` gives the nearest tag without the "-<N>-g<sha>" suffix.
-    tag: safe(['describe', '--tags', '--abbrev=0']),
-  };
-}
-
-/**
- * Compose a first-draft `wyvrn.json` from detection + cookbook data.
- * Pure: no filesystem writes, no network. `compose` is the unit-testable
- * seam between orchestration (`bootstrap`) and persistence.
- *
- * Precedence for each field (highest wins):
- *   CLI override → cookbook hint → filesystem detection → safe default.
- *
- * @param {{
- *   url:        string,
- *   repoDir:    string,
- *   overrides?: { name?: string, version?: string, kind?: string, description?: string },
- *   detect?:    ReturnType<typeof detectFromRepo>,
- *   gitState?:  { sha: string | null, tag: string | null },
- * }} args
- * @returns {{ manifest: object, todos: string[] }}
- */
-function compose({ url, repoDir, overrides = {}, detect = null, gitState = null }) {
-  const todos = [];
-  const detection = detect ?? detectFromRepo(repoDir);
-  const { sha, tag } = gitState ?? { sha: null, tag: null };
-
-  const repoTail = nameFromUrl(url);
-  const cookbook = lookupCookbook(repoTail) ?? {};
-
-  const name = overrides.name || repoTail;
-  if (!name) todos.push('name could not be derived from the URL — set "name" manually.');
-
-  let version = overrides.version || null;
-  if (!version && tag) {
-    version = tagToVersion(tag);
-    if (!version) {
-      todos.push(`nearest tag "${tag}" doesn't match a clean numeric version — set "version" manually (used HEAD SHA as a placeholder).`);
-    }
-  }
-  if (!version) {
-    version = '0.0.0.0';
-    todos.push('no usable git tag found — "version" defaulted to 0.0.0.0. Pin to a real release before publish.');
-  }
-
-  const kind = overrides.kind || cookbook.kind || detection.kind;
-  if (kind === 'unknown') {
-    todos.push('kind could not be detected — set "kind" to ConsoleApp | StaticLib | DynamicLib | HeaderOnlyLib | WebApp | Utility | Service | TestProject.');
-  }
-  for (const note of detection.notes) todos.push(`detect: ${note}`);
-  for (const note of (cookbook.notes ?? [])) todos.push(`cookbook: ${note}`);
-
-  // Safe default recipe for any CMake project. Header-only still goes
-  // through cmake --install so the INTERFACE target + install() rules
-  // land in the published zip.
-  const build = {
-    system:    'cmake',
-    configs:   ['Debug', 'Release', 'RelWithDebInfo', 'MinSizeRel'],
-    configure: cookbook.configure ? [...cookbook.configure] : [],
-    installDir: 'install',
-  };
-
-  const manifest = {
-    name,
-    version,
-    schemaVersion: 2,
-    kind:          kind === 'unknown' ? 'StaticLib' : kind,
-    description:   overrides.description || `TODO: one-line description of ${name}`,
-    dependencies:  cookbook.dependencies ? { ...cookbook.dependencies } : {},
-    build,
-  };
-
-  if (cookbook.dependencies) {
-    todos.push(
-      `dependencies seeded from cookbook: ${Object.keys(cookbook.dependencies).join(', ')}. ` +
-      `Verify versions and pin ranges before publish.`,
-    );
-  }
-
-  // `gitRepo` / `gitSha` are normally captured by `wyvrnpm publish` at
-  // publish time — we leave them out of the manifest (not an author
-  // field) but surface them in the TODO report so the user can
-  // double-check the clone landed at the ref they expected.
-  if (sha) todos.push(`git HEAD at bootstrap: ${sha}`);
-  if (tag) todos.push(`nearest git tag: ${tag}`);
-
-  return { manifest, todos };
-}
-
-/**
- * Full bootstrap flow: optionally clone, read git state, compose manifest,
- * write it to disk. Returns the result so callers (CLI, tests) can decide
- * what to print.
- *
- * @param {{
- *   url:      string,
- *   dest:     string,
- *   ref?:     string | null,
- *   name?:    string,
- *   version?: string,
- *   kind?:    string,
- *   description?: string,
- *   noClone?: boolean,
- *   dryRun?:  boolean,
- *   force?:   boolean,
- * }} opts
- * @returns {{ manifest: object, todos: string[], manifestPath: string, wrote: boolean }}
- */
-function bootstrap(opts) {
-  const {
-    url, dest, ref = null,
-    name, version, kind, description,
-    noClone = false, dryRun = false, force = false, shallow = false,
-  } = opts;
-
-  if (!url && !noClone) throw new Error('bootstrap: --url (or a positional git URL) is required unless --no-clone');
-  if (!dest) throw new Error('bootstrap: --dest (or positional) is required');
-
-  const repoDir = path.resolve(dest);
-
-  if (!noClone) {
-    if (fs.existsSync(repoDir) && !force) {
-      throw new Error(
-        `bootstrap: destination already exists: ${repoDir}\n` +
-        '  Pass --force to reuse it, or --no-clone to operate on it in place.',
-      );
-    }
-    if (fs.existsSync(repoDir) && force) {
-      fs.rmSync(repoDir, { recursive: true, force: true });
-    }
-    cloneRepo({ gitUrl: url, destDir: repoDir, ref, shallow });
-  } else if (!fs.existsSync(repoDir)) {
-    throw new Error(`bootstrap: --no-clone but directory does not exist: ${repoDir}`);
-  }
-
-  const detect   = detectFromRepo(repoDir);
-  const gitState = readGitState(repoDir);
-
-  const { manifest, todos } = compose({
-    url:       url || gitRemoteUrl(repoDir) || '',
-    repoDir,
-    overrides: { name, version, kind, description },
-    detect,
-    gitState,
-  });
-
-  const manifestPath = path.join(repoDir, 'wyvrn.json');
-  let wrote = false;
-  if (!dryRun) {
-    if (fs.existsSync(manifestPath) && !force) {
-      throw new Error(
-        `bootstrap: ${manifestPath} already exists. Pass --force to overwrite, or --dry-run to preview only.`,
-      );
-    }
-    fs.writeFileSync(manifestPath, JSON.stringify(manifest, null, 2) + '\n', 'utf8');
-    wrote = true;
-  }
-
-  return { manifest, todos, manifestPath, wrote };
-}
-
-function gitRemoteUrl(repoDir) {
-  try {
-    return execFileSync('git', ['remote', 'get-url', 'origin'], {
-      cwd: repoDir, stdio: ['ignore', 'pipe', 'ignore'],
-    }).toString('utf8').trim() || null;
-  } catch { return null; }
-}
-
-module.exports = { bootstrap, compose, readGitState, cloneRepo };
+'use strict';
+
+const fs   = require('fs');
+const path = require('path');
+const { execFileSync } = require('child_process');
+
+const { tagToVersion, nameFromUrl } = require('./version');
+const { detectFromRepo }            = require('./detect');
+const { lookupCookbook }            = require('./cookbook');
+const log                           = require('../logger');
+
+/**
+ * Clone `gitUrl` into `destDir` so bootstrap can read the tree.
+ * Defaults to a full clone — bootstrap's target audience is "I forked
+ * these repos to maintain them", so they want the history. `--shallow`
+ * opts into `--depth 1` (faster, but `git describe --tags` will miss
+ * tags that aren't reachable from the single fetched commit, so the
+ * version detection degrades to HEAD SHA placeholder + TODO).
+ *
+ * Uses the user's ambient git auth (SSH keys, credential helper). We do
+ * NOT manage credentials here.
+ *
+ * @param {{ gitUrl: string, destDir: string, ref?: string | null, shallow?: boolean }} opts
+ */
+function cloneRepo({ gitUrl, destDir, ref = null, shallow = false }) {
+  const args = ['clone'];
+  if (shallow) args.push('--depth', '1');
+  if (ref)     args.push('--branch', ref);
+  args.push('--', gitUrl, destDir);
+  log.info(`  git ${args.join(' ')}`);
+  execFileSync('git', args, { stdio: 'inherit' });
+}
+
+/**
+ * Read HEAD SHA + nearest tag out of an existing clone. Pure
+ * read-side — never writes. Returns nulls on failure so the caller
+ * can surface a TODO rather than abort.
+ *
+ * @param {string} repoDir
+ * @returns {{ sha: string | null, tag: string | null }}
+ */
+function readGitState(repoDir) {
+  const safe = (args) => {
+    try {
+      return execFileSync('git', args, { cwd: repoDir, stdio: ['ignore', 'pipe', 'ignore'] })
+        .toString('utf8').trim() || null;
+    } catch { return null; }
+  };
+  return {
+    sha: safe(['rev-parse', 'HEAD']),
+    // `--abbrev=0` gives the nearest tag without the "-<N>-g<sha>" suffix.
+    tag: safe(['describe', '--tags', '--abbrev=0']),
+  };
+}
+
+/**
+ * Compose a first-draft `wyvrn.json` from detection + cookbook data.
+ * Pure: no filesystem writes, no network. `compose` is the unit-testable
+ * seam between orchestration (`bootstrap`) and persistence.
+ *
+ * Precedence for each field (highest wins):
+ *   CLI override → cookbook hint → filesystem detection → safe default.
+ *
+ * @param {{
+ *   url:        string,
+ *   repoDir:    string,
+ *   overrides?: { name?: string, version?: string, kind?: string, description?: string },
+ *   detect?:    ReturnType<typeof detectFromRepo>,
+ *   gitState?:  { sha: string | null, tag: string | null },
+ * }} args
+ * @returns {{ manifest: object, todos: string[] }}
+ */
+function compose({ url, repoDir, overrides = {}, detect = null, gitState = null }) {
+  const todos = [];
+  const detection = detect ?? detectFromRepo(repoDir);
+  const { sha, tag } = gitState ?? { sha: null, tag: null };
+
+  const repoTail = nameFromUrl(url);
+  const cookbook = lookupCookbook(repoTail) ?? {};
+
+  const name = overrides.name || repoTail;
+  if (!name) todos.push('name could not be derived from the URL — set "name" manually.');
+
+  let version = overrides.version || null;
+  if (!version && tag) {
+    version = tagToVersion(tag);
+    if (!version) {
+      todos.push(`nearest tag "${tag}" doesn't match a clean numeric version — set "version" manually (used HEAD SHA as a placeholder).`);
+    }
+  }
+  if (!version) {
+    version = '0.0.0.0';
+    todos.push('no usable git tag found — "version" defaulted to 0.0.0.0. Pin to a real release before publish.');
+  }
+
+  const kind = overrides.kind || cookbook.kind || detection.kind;
+  if (kind === 'unknown') {
+    todos.push('kind could not be detected — set "kind" to ConsoleApp | StaticLib | DynamicLib | HeaderOnlyLib | WebApp | Utility | Service | TestProject.');
+  }
+  for (const note of detection.notes) todos.push(`detect: ${note}`);
+  for (const note of (cookbook.notes ?? [])) todos.push(`cookbook: ${note}`);
+
+  // Safe default recipe for any CMake project. Header-only still goes
+  // through cmake --install so the INTERFACE target + install() rules
+  // land in the published zip.
+  const build = {
+    system:    'cmake',
+    configs:   ['Debug', 'Release', 'RelWithDebInfo', 'MinSizeRel'],
+    configure: cookbook.configure ? [...cookbook.configure] : [],
+    installDir: 'install',
+  };
+
+  const manifest = {
+    name,
+    version,
+    schemaVersion: 2,
+    kind:          kind === 'unknown' ? 'StaticLib' : kind,
+    description:   overrides.description || `TODO: one-line description of ${name}`,
+    dependencies:  cookbook.dependencies ? { ...cookbook.dependencies } : {},
+    build,
+  };
+
+  if (cookbook.dependencies) {
+    todos.push(
+      `dependencies seeded from cookbook: ${Object.keys(cookbook.dependencies).join(', ')}. ` +
+      `Verify versions and pin ranges before publish.`,
+    );
+  }
+
+  // `gitRepo` / `gitSha` are normally captured by `wyvrnpm publish` at
+  // publish time — we leave them out of the manifest (not an author
+  // field) but surface them in the TODO report so the user can
+  // double-check the clone landed at the ref they expected.
+  if (sha) todos.push(`git HEAD at bootstrap: ${sha}`);
+  if (tag) todos.push(`nearest git tag: ${tag}`);
+
+  return { manifest, todos };
+}
+
+/**
+ * Full bootstrap flow: optionally clone, read git state, compose manifest,
+ * write it to disk. Returns the result so callers (CLI, tests) can decide
+ * what to print.
+ *
+ * @param {{
+ *   url:      string,
+ *   dest:     string,
+ *   ref?:     string | null,
+ *   name?:    string,
+ *   version?: string,
+ *   kind?:    string,
+ *   description?: string,
+ *   noClone?: boolean,
+ *   dryRun?:  boolean,
+ *   force?:   boolean,
+ * }} opts
+ * @returns {{ manifest: object, todos: string[], manifestPath: string, wrote: boolean }}
+ */
+function bootstrap(opts) {
+  const {
+    url, dest, ref = null,
+    name, version, kind, description,
+    noClone = false, dryRun = false, force = false, shallow = false,
+  } = opts;
+
+  if (!url && !noClone) throw new Error('bootstrap: --url (or a positional git URL) is required unless --no-clone');
+  if (!dest) throw new Error('bootstrap: --dest (or positional) is required');
+
+  const repoDir = path.resolve(dest);
+
+  if (!noClone) {
+    if (fs.existsSync(repoDir) && !force) {
+      throw new Error(
+        `bootstrap: destination already exists: ${repoDir}\n` +
+        '  Pass --force to reuse it, or --no-clone to operate on it in place.',
+      );
+    }
+    if (fs.existsSync(repoDir) && force) {
+      fs.rmSync(repoDir, { recursive: true, force: true });
+    }
+    cloneRepo({ gitUrl: url, destDir: repoDir, ref, shallow });
+  } else if (!fs.existsSync(repoDir)) {
+    throw new Error(`bootstrap: --no-clone but directory does not exist: ${repoDir}`);
+  }
+
+  const detect   = detectFromRepo(repoDir);
+  const gitState = readGitState(repoDir);
+
+  const { manifest, todos } = compose({
+    url:       url || gitRemoteUrl(repoDir) || '',
+    repoDir,
+    overrides: { name, version, kind, description },
+    detect,
+    gitState,
+  });
+
+  const manifestPath = path.join(repoDir, 'wyvrn.json');
+  let wrote = false;
+  if (!dryRun) {
+    if (fs.existsSync(manifestPath) && !force) {
+      throw new Error(
+        `bootstrap: ${manifestPath} already exists. Pass --force to overwrite, or --dry-run to preview only.`,
+      );
+    }
+    fs.writeFileSync(manifestPath, JSON.stringify(manifest, null, 2) + '\n', 'utf8');
+    wrote = true;
+  }
+
+  return { manifest, todos, manifestPath, wrote };
+}
+
+function gitRemoteUrl(repoDir) {
+  try {
+    return execFileSync('git', ['remote', 'get-url', 'origin'], {
+      cwd: repoDir, stdio: ['ignore', 'pipe', 'ignore'],
+    }).toString('utf8').trim() || null;
+  } catch { return null; }
+}
+
+module.exports = { bootstrap, compose, readGitState, cloneRepo };

package/src/bootstrap/version.js

@@ -1,72 +1,72 @@
-'use strict';
-
-/**
- * Parse an upstream git tag into wyvrnpm's 4-part version scheme.
- *
- * Most C++ OSS projects publish 3-part semver tags (`v1.2.3`, `11.0.2`,
- * `1.3.12`). wyvrnpm uses a 4-part `major.minor.patch.build` scheme
- * throughout (see CLAUDE.md §4.2). We pad the upstream tag with `.0` for
- * the build component so published manifests look like `1.3.12.0`.
- *
- * Accepted tag shapes:
- *   v1.2.3      → "1.2.3.0"
- *   1.2.3       → "1.2.3.0"
- *   v1.2.3.4    → "1.2.3.4"
- *   v11.0       → "11.0.0.0"  (2-part — padded)
- *   v11         → "11.0.0.0"  (1-part — padded)
- *   release-1.2 → "1.2.0.0"   (strips a leading "release-" / "ver-")
- *
- * Rejected (returns null):
- *   empty / non-string
- *   tags with suffixes ("1.2.3-rc1", "1.2.3+git", "1.2.3a") — callers
- *     fall back to the HEAD SHA and flag a TODO
- *   tags with 5+ numeric components
- *
- * @param {string | null} tag
- * @returns {string | null} 4-part version, or null when the tag can't be
- *                          cleanly promoted.
- */
-function tagToVersion(tag) {
-  if (typeof tag !== 'string') return null;
-  let t = tag.trim();
-  if (!t) return null;
-
-  // Strip the most common prefixes authors use on git tags. Longest
-  // alternatives first so `version-2.0` matches the whole word, not
-  // just the leading `v`. We keep the allowlist tight — we'd rather
-  // fall through than silently misparse `release-candidate-1.2.3`.
-  t = t.replace(/^(version|release|ver|v)[-_.]?/i, '');
-
-  // Must be bare numeric segments separated by dots, nothing else.
-  if (!/^\d+(\.\d+){0,3}$/.test(t)) return null;
-
-  const parts = t.split('.').map((n) => parseInt(n, 10));
-  if (parts.some((n) => !Number.isFinite(n) || n < 0)) return null;
-
-  while (parts.length < 4) parts.push(0);
-  return parts.join('.');
-}
-
-/**
- * Derive a wyvrnpm package name from a git URL.
- *
- *   https://github.com/fmtlib/fmt.git          → "fmt"
- *   git@github.com:fmtlib/fmt.git              → "fmt"
- *   https://gitlab.com/bzip2/bzip2.git         → "bzip2"
- *   https://github.com/Tencent/rapidjson.git   → "rapidjson"
- *   https://github.com/nlohmann/json.git       → "json"  (caller may want "nlohmann-json")
- *
- * Pure: does not hit the network.
- *
- * @param {string} url
- * @returns {string}
- */
-function nameFromUrl(url) {
-  if (typeof url !== 'string' || !url.trim()) return '';
-  const trimmed = url.trim().replace(/\/$/, '');
-  // Split on the last slash or colon (SSH form).
-  const tail = trimmed.split(/[/:]/).pop() || '';
-  return tail.replace(/\.git$/i, '');
-}
-
-module.exports = { tagToVersion, nameFromUrl };
+'use strict';
+
+/**
+ * Parse an upstream git tag into wyvrnpm's 4-part version scheme.
+ *
+ * Most C++ OSS projects publish 3-part semver tags (`v1.2.3`, `11.0.2`,
+ * `1.3.12`). wyvrnpm uses a 4-part `major.minor.patch.build` scheme
+ * throughout (see CLAUDE.md §4.2). We pad the upstream tag with `.0` for
+ * the build component so published manifests look like `1.3.12.0`.
+ *
+ * Accepted tag shapes:
+ *   v1.2.3      → "1.2.3.0"
+ *   1.2.3       → "1.2.3.0"
+ *   v1.2.3.4    → "1.2.3.4"
+ *   v11.0       → "11.0.0.0"  (2-part — padded)
+ *   v11         → "11.0.0.0"  (1-part — padded)
+ *   release-1.2 → "1.2.0.0"   (strips a leading "release-" / "ver-")
+ *
+ * Rejected (returns null):
+ *   empty / non-string
+ *   tags with suffixes ("1.2.3-rc1", "1.2.3+git", "1.2.3a") — callers
+ *     fall back to the HEAD SHA and flag a TODO
+ *   tags with 5+ numeric components
+ *
+ * @param {string | null} tag
+ * @returns {string | null} 4-part version, or null when the tag can't be
+ *                          cleanly promoted.
+ */
+function tagToVersion(tag) {
+  if (typeof tag !== 'string') return null;
+  let t = tag.trim();
+  if (!t) return null;
+
+  // Strip the most common prefixes authors use on git tags. Longest
+  // alternatives first so `version-2.0` matches the whole word, not
+  // just the leading `v`. We keep the allowlist tight — we'd rather
+  // fall through than silently misparse `release-candidate-1.2.3`.
+  t = t.replace(/^(version|release|ver|v)[-_.]?/i, '');
+
+  // Must be bare numeric segments separated by dots, nothing else.
+  if (!/^\d+(\.\d+){0,3}$/.test(t)) return null;
+
+  const parts = t.split('.').map((n) => parseInt(n, 10));
+  if (parts.some((n) => !Number.isFinite(n) || n < 0)) return null;
+
+  while (parts.length < 4) parts.push(0);
+  return parts.join('.');
+}
+
+/**
+ * Derive a wyvrnpm package name from a git URL.
+ *
+ *   https://github.com/fmtlib/fmt.git          → "fmt"
+ *   git@github.com:fmtlib/fmt.git              → "fmt"
+ *   https://gitlab.com/bzip2/bzip2.git         → "bzip2"
+ *   https://github.com/Tencent/rapidjson.git   → "rapidjson"
+ *   https://github.com/nlohmann/json.git       → "json"  (caller may want "nlohmann-json")
+ *
+ * Pure: does not hit the network.
+ *
+ * @param {string} url
+ * @returns {string}
+ */
+function nameFromUrl(url) {
+  if (typeof url !== 'string' || !url.trim()) return '';
+  const trimmed = url.trim().replace(/\/$/, '');
+  // Split on the last slash or colon (SSH form).
+  const tail = trimmed.split(/[/:]/).pop() || '';
+  return tail.replace(/\.git$/i, '');
+}
+
+module.exports = { tagToVersion, nameFromUrl };