wyvrnpm 2.10.2 → 2.12.2

package/src/bootstrap/detect.js

@@ -1,150 +1,150 @@
-'use strict';
-
-const fs   = require('fs');
-const path = require('path');
-
-/**
- * Inspect a cloned repo directory and infer the wyvrnpm `kind`, plus
- * anything else a bootstrap flow can read off the filesystem cheaply.
- *
- * We explicitly do NOT fully parse CMakeLists.txt — a regex scan is good
- * enough for the 80% case, and the bootstrap command's job is to produce
- * a *first draft* that the human reviews before publish. When the signal
- * is ambiguous we return `unknown` and let the TODO report surface it.
- *
- * @typedef {Object} DetectResult
- * @property {'HeaderOnlyLib' | 'StaticLib' | 'DynamicLib' | 'unknown'} kind
- * @property {boolean} hasCMakeLists       — root CMakeLists.txt present?
- * @property {boolean} hasConfigureAc      — autotools (libsodium, bzip2)?
- * @property {boolean} hasMeson            — meson.build present?
- * @property {string[]} notes              — human-readable signals for the TODO report.
- */
-
-/**
- * @param {string} repoDir
- * @returns {DetectResult}
- */
-function detectFromRepo(repoDir) {
-  const notes = [];
-  const result = {
-    kind:             'unknown',
-    hasCMakeLists:    false,
-    hasConfigureAc:   false,
-    hasMeson:         false,
-    notes,
-  };
-
-  if (!fs.existsSync(repoDir) || !fs.statSync(repoDir).isDirectory()) {
-    notes.push(`directory does not exist: ${repoDir}`);
-    return result;
-  }
-
-  const cmakePath = path.join(repoDir, 'CMakeLists.txt');
-  result.hasCMakeLists  = fs.existsSync(cmakePath);
-  result.hasConfigureAc = fs.existsSync(path.join(repoDir, 'configure.ac'))
-                      || fs.existsSync(path.join(repoDir, 'configure'));
-  result.hasMeson       = fs.existsSync(path.join(repoDir, 'meson.build'));
-
-  if (!result.hasCMakeLists) {
-    if (result.hasConfigureAc) {
-      notes.push(
-        'no CMakeLists.txt — upstream uses autotools. wyvrnpm source-build ' +
-        'supports cmake only; ship a wrapper CMakeLists.txt in your fork or ' +
-        'prebuild and publish as a binary-only artefact.',
-      );
-    } else if (result.hasMeson) {
-      notes.push(
-        'no CMakeLists.txt — upstream uses meson. Same workaround as ' +
-        'autotools: ship a wrapper CMakeLists.txt in your fork.',
-      );
-    } else {
-      notes.push(
-        'no CMakeLists.txt and no recognised build system — likely a header-' +
-        'drop upstream (e.g. imgui, nuklear, stb). Add a small CMakeLists.txt ' +
-        'in the fork that declares an INTERFACE target + install() rules.',
-      );
-    }
-    return result;
-  }
-
-  const kindFromCmake = detectKindFromCMakeLists(cmakePath);
-  result.kind = kindFromCmake.kind;
-  if (kindFromCmake.note) notes.push(kindFromCmake.note);
-  return result;
-}
-
-/**
- * Scan a CMakeLists.txt for the most specific `add_library(<name> <type>)`
- * signal we can find. In order of preference we look for:
- *   INTERFACE  → HeaderOnlyLib
- *   SHARED     → DynamicLib
- *   STATIC     → StaticLib
- *   MODULE     → StaticLib  (rare; treat as static for now)
- *
- * If we find `add_library(<name>)` with no explicit type, CMake's default
- * depends on `BUILD_SHARED_LIBS`. wyvrnpm's convention is to default to
- * `StaticLib` — the consumer can flip via an `options.shared` toggle later.
- *
- * `add_executable(...)` with no `add_library(...)` → the repo ships only a
- * tool, not a library. We return `unknown` so the TODO report surfaces it.
- *
- * @param {string} cmakePath
- * @returns {{ kind: DetectResult['kind'], note?: string }}
- */
-function detectKindFromCMakeLists(cmakePath) {
-  let text;
-  try { text = fs.readFileSync(cmakePath, 'utf8'); }
-  catch { return { kind: 'unknown', note: `could not read ${cmakePath}` }; }
-
-  // Strip line comments so an old "# add_library(foo SHARED ...)" doesn't
-  // poison detection. Block comments in CMake (#[[ ... ]]) are rare; not
-  // worth handling here.
-  const stripped = text.replace(/#[^\n]*/g, '');
-
-  const has = (re) => re.test(stripped);
-
-  // add_library(<name> [STATIC|SHARED|MODULE|OBJECT|INTERFACE|IMPORTED] ...)
-  if (has(/add_library\s*\(\s*[A-Za-z0-9_.+-]+\s+INTERFACE\b/i)) {
-    return { kind: 'HeaderOnlyLib' };
-  }
-  if (has(/add_library\s*\(\s*[A-Za-z0-9_.+-]+\s+SHARED\b/i)) {
-    return {
-      kind: 'DynamicLib',
-      note: 'detected SHARED library — consider declaring an `options.shared` toggle if the upstream respects BUILD_SHARED_LIBS.',
-    };
-  }
-  if (has(/add_library\s*\(\s*[A-Za-z0-9_.+-]+\s+STATIC\b/i)) {
-    return { kind: 'StaticLib' };
-  }
-  if (has(/add_library\s*\(\s*[A-Za-z0-9_.+-]+\s+(MODULE|OBJECT)\b/i)) {
-    return {
-      kind: 'StaticLib',
-      note: 'detected MODULE/OBJECT library — treating as StaticLib. Review.',
-    };
-  }
-  // Implicit-default form: `add_library(<name> <sources>...)` — no type
-  // keyword after the name. Negative lookahead on the recognised types
-  // distinguishes this from the explicit-type cases above (which we've
-  // already checked and returned from).
-  if (has(/add_library\s*\(\s*[A-Za-z0-9_.+-]+\s+(?!(STATIC|SHARED|MODULE|OBJECT|INTERFACE|IMPORTED)\b)/i)) {
-    return {
-      kind: 'StaticLib',
-      note: 'add_library() with no explicit type — defaulting to StaticLib. ' +
-            'If the upstream respects BUILD_SHARED_LIBS, add an `options.shared` toggle.',
-    };
-  }
-  if (has(/add_executable\s*\(/i)) {
-    return {
-      kind: 'unknown',
-      note: 'repo declares add_executable() but no add_library() — looks like ' +
-            'a tool, not a library. Set kind: ConsoleApp in the manifest.',
-    };
-  }
-  return {
-    kind: 'unknown',
-    note: 'no add_library() / add_executable() found at the root CMakeLists.txt. ' +
-          'The library may be declared in a subdirectory — inspect and set kind manually.',
-  };
-}
-
-module.exports = { detectFromRepo, detectKindFromCMakeLists };
+'use strict';
+
+const fs   = require('fs');
+const path = require('path');
+
+/**
+ * Inspect a cloned repo directory and infer the wyvrnpm `kind`, plus
+ * anything else a bootstrap flow can read off the filesystem cheaply.
+ *
+ * We explicitly do NOT fully parse CMakeLists.txt — a regex scan is good
+ * enough for the 80% case, and the bootstrap command's job is to produce
+ * a *first draft* that the human reviews before publish. When the signal
+ * is ambiguous we return `unknown` and let the TODO report surface it.
+ *
+ * @typedef {Object} DetectResult
+ * @property {'HeaderOnlyLib' | 'StaticLib' | 'DynamicLib' | 'unknown'} kind
+ * @property {boolean} hasCMakeLists       — root CMakeLists.txt present?
+ * @property {boolean} hasConfigureAc      — autotools (libsodium, bzip2)?
+ * @property {boolean} hasMeson            — meson.build present?
+ * @property {string[]} notes              — human-readable signals for the TODO report.
+ */
+
+/**
+ * @param {string} repoDir
+ * @returns {DetectResult}
+ */
+function detectFromRepo(repoDir) {
+  const notes = [];
+  const result = {
+    kind:             'unknown',
+    hasCMakeLists:    false,
+    hasConfigureAc:   false,
+    hasMeson:         false,
+    notes,
+  };
+
+  if (!fs.existsSync(repoDir) || !fs.statSync(repoDir).isDirectory()) {
+    notes.push(`directory does not exist: ${repoDir}`);
+    return result;
+  }
+
+  const cmakePath = path.join(repoDir, 'CMakeLists.txt');
+  result.hasCMakeLists  = fs.existsSync(cmakePath);
+  result.hasConfigureAc = fs.existsSync(path.join(repoDir, 'configure.ac'))
+                      || fs.existsSync(path.join(repoDir, 'configure'));
+  result.hasMeson       = fs.existsSync(path.join(repoDir, 'meson.build'));
+
+  if (!result.hasCMakeLists) {
+    if (result.hasConfigureAc) {
+      notes.push(
+        'no CMakeLists.txt — upstream uses autotools. wyvrnpm source-build ' +
+        'supports cmake only; ship a wrapper CMakeLists.txt in your fork or ' +
+        'prebuild and publish as a binary-only artefact.',
+      );
+    } else if (result.hasMeson) {
+      notes.push(
+        'no CMakeLists.txt — upstream uses meson. Same workaround as ' +
+        'autotools: ship a wrapper CMakeLists.txt in your fork.',
+      );
+    } else {
+      notes.push(
+        'no CMakeLists.txt and no recognised build system — likely a header-' +
+        'drop upstream (e.g. imgui, nuklear, stb). Add a small CMakeLists.txt ' +
+        'in the fork that declares an INTERFACE target + install() rules.',
+      );
+    }
+    return result;
+  }
+
+  const kindFromCmake = detectKindFromCMakeLists(cmakePath);
+  result.kind = kindFromCmake.kind;
+  if (kindFromCmake.note) notes.push(kindFromCmake.note);
+  return result;
+}
+
+/**
+ * Scan a CMakeLists.txt for the most specific `add_library(<name> <type>)`
+ * signal we can find. In order of preference we look for:
+ *   INTERFACE  → HeaderOnlyLib
+ *   SHARED     → DynamicLib
+ *   STATIC     → StaticLib
+ *   MODULE     → StaticLib  (rare; treat as static for now)
+ *
+ * If we find `add_library(<name>)` with no explicit type, CMake's default
+ * depends on `BUILD_SHARED_LIBS`. wyvrnpm's convention is to default to
+ * `StaticLib` — the consumer can flip via an `options.shared` toggle later.
+ *
+ * `add_executable(...)` with no `add_library(...)` → the repo ships only a
+ * tool, not a library. We return `unknown` so the TODO report surfaces it.
+ *
+ * @param {string} cmakePath
+ * @returns {{ kind: DetectResult['kind'], note?: string }}
+ */
+function detectKindFromCMakeLists(cmakePath) {
+  let text;
+  try { text = fs.readFileSync(cmakePath, 'utf8'); }
+  catch { return { kind: 'unknown', note: `could not read ${cmakePath}` }; }
+
+  // Strip line comments so an old "# add_library(foo SHARED ...)" doesn't
+  // poison detection. Block comments in CMake (#[[ ... ]]) are rare; not
+  // worth handling here.
+  const stripped = text.replace(/#[^\n]*/g, '');
+
+  const has = (re) => re.test(stripped);
+
+  // add_library(<name> [STATIC|SHARED|MODULE|OBJECT|INTERFACE|IMPORTED] ...)
+  if (has(/add_library\s*\(\s*[A-Za-z0-9_.+-]+\s+INTERFACE\b/i)) {
+    return { kind: 'HeaderOnlyLib' };
+  }
+  if (has(/add_library\s*\(\s*[A-Za-z0-9_.+-]+\s+SHARED\b/i)) {
+    return {
+      kind: 'DynamicLib',
+      note: 'detected SHARED library — consider declaring an `options.shared` toggle if the upstream respects BUILD_SHARED_LIBS.',
+    };
+  }
+  if (has(/add_library\s*\(\s*[A-Za-z0-9_.+-]+\s+STATIC\b/i)) {
+    return { kind: 'StaticLib' };
+  }
+  if (has(/add_library\s*\(\s*[A-Za-z0-9_.+-]+\s+(MODULE|OBJECT)\b/i)) {
+    return {
+      kind: 'StaticLib',
+      note: 'detected MODULE/OBJECT library — treating as StaticLib. Review.',
+    };
+  }
+  // Implicit-default form: `add_library(<name> <sources>...)` — no type
+  // keyword after the name. Negative lookahead on the recognised types
+  // distinguishes this from the explicit-type cases above (which we've
+  // already checked and returned from).
+  if (has(/add_library\s*\(\s*[A-Za-z0-9_.+-]+\s+(?!(STATIC|SHARED|MODULE|OBJECT|INTERFACE|IMPORTED)\b)/i)) {
+    return {
+      kind: 'StaticLib',
+      note: 'add_library() with no explicit type — defaulting to StaticLib. ' +
+            'If the upstream respects BUILD_SHARED_LIBS, add an `options.shared` toggle.',
+    };
+  }
+  if (has(/add_executable\s*\(/i)) {
+    return {
+      kind: 'unknown',
+      note: 'repo declares add_executable() but no add_library() — looks like ' +
+            'a tool, not a library. Set kind: ConsoleApp in the manifest.',
+    };
+  }
+  return {
+    kind: 'unknown',
+    note: 'no add_library() / add_executable() found at the root CMakeLists.txt. ' +
+          'The library may be declared in a subdirectory — inspect and set kind manually.',
+  };
+}
+
+module.exports = { detectFromRepo, detectKindFromCMakeLists };