Expansion support in gyp-to-cmake (#9)

* Add expansion support to gyp-to-cmake

* Add more examples

Author: kraenhansen

package-lock.json

@@ -14,6 +14,7 @@
   },
   "dependencies": {
     "@commander-js/extra-typings": "^13.1.0",
-    "commander": "^13.1.0"
+    "commander": "^13.1.0",
+    "gyp-parser": "^1.0.4"
   }
 }

packages/gyp-to-cmake/package.json

@@ -0,0 +1,3 @@
+declare module "gyp-parser" {
+  export function parse(input: string): unknown;
+}

packages/gyp-to-cmake/src/gyp-parser.d.ts

@@ -1,6 +1,8 @@
 import assert from "node:assert/strict";
 import fs from "node:fs";
 
+import { parse } from "gyp-parser";
+
 export type GypTarget = {
   target_name: string;
   sources: string[];
@@ -73,8 +75,7 @@ export function readBindingFile(
 ): GypBinding {
   try {
     const contents = fs.readFileSync(path, "utf-8");
-    // TODO: Use a loose json parser to allow single quotes (and comments)
-    const json = JSON.parse(contents);
+    const json = parse(contents);
     assertBinding(json, disallowUnknownProperties);
     return json;
   } catch (err) {

packages/gyp-to-cmake/src/gyp.ts

@@ -1,3 +1,5 @@
+import cp from "node:child_process";
+
 import type { GypBinding } from "./gyp.js";
 
 const DEFAULT_NAPI_VERSION = 8;
@@ -6,6 +8,7 @@ export type GypToCmakeListsOptions = {
   gyp: GypBinding;
   projectName: string;
   napiVersion?: number;
+  executeCmdExpansions?: boolean;
   unsupportedBehaviour?: "skip" | "warn" | "throw";
 };
 
@@ -26,17 +29,23 @@ export function bindingGypToCmakeLists({
   gyp,
   projectName,
   napiVersion = DEFAULT_NAPI_VERSION,
+  executeCmdExpansions = true,
   unsupportedBehaviour = "skip",
 }: GypToCmakeListsOptions): string {
-  function filterExpansion(value: string) {
+  function mapExpansion(value: string): string[] {
     if (!isCmdExpansion(value)) {
-      return true;
+      return [value];
+    } else if (executeCmdExpansions) {
+      const cmd = value.trim().replace(/^<!@?/, "");
+      const output = cp.execSync(cmd, { encoding: "utf-8" }).trim();
+      // Split on whitespace, if the expansion starts with "<!@"
+      return value.trim().startsWith("<!@") ? output.split(/\s/) : [output];
     } else if (unsupportedBehaviour === "throw") {
       throw new Error(`Unsupported command expansion: ${value}`);
     } else if (unsupportedBehaviour === "warn") {
       console.warn(`Unsupported command expansion: ${value}`);
     }
-    return false;
+    return [value];
   }
 
   const lines: string[] = [
@@ -57,12 +66,12 @@ export function bindingGypToCmakeLists({
     // TODO: Handle "ldflags"
 
     const escapedJoinedSources = target.sources
-      .filter(filterExpansion)
+      .flatMap(mapExpansion)
       .map(escapePath)
       .join(" ");
 
     const escapedJoinedIncludes = (target.include_dirs || [])
-      .filter(filterExpansion)
+      .flatMap(mapExpansion)
       .map(escapePath)
       .join(" ");
 
@@ -71,9 +80,8 @@ export function bindingGypToCmakeLists({
       `add_library(${targetName} SHARED ${escapedJoinedSources} \${CMAKE_JS_SRC})`,
       `set_target_properties(${targetName} PROPERTIES PREFIX "" SUFFIX ".node")`,
       `target_include_directories(${targetName} PRIVATE ${escapedJoinedIncludes} \${CMAKE_JS_INC})`,
-      `target_link_libraries(${targetName} PRIVATE \${CMAKE_JS_LIB})`
-      // TODO: Consider declaring the C++ standard version
-      // `target_compile_features(${targetName} PRIVATE cxx_std_17)`
+      `target_link_libraries(${targetName} PRIVATE \${CMAKE_JS_LIB})`,
+      `target_compile_features(${targetName} PRIVATE cxx_std_17)`
       // or
       // `set_target_properties(${targetName} PROPERTIES CXX_STANDARD 11 CXX_STANDARD_REQUIRED YES CXX_EXTENSIONS NO)`,
     );

packages/gyp-to-cmake/src/transformer.ts

@@ -1,9 +1,14 @@
 module.exports = {
   "1-getting-started": {
-    "1_hello_world": () => require("./examples/1-getting-started/1_hello_world/napi/hello.js"),
-    "2_function_arguments": () => require("./examples/1-getting-started/2_function_arguments/napi/addon.js"),
-    "3_callbacks": () => require("./examples/1-getting-started/3_callbacks/napi/addon.js"),
-    "4_object_factory": () => require("./examples/1-getting-started/4_object_factory/napi/addon.js"),
+    "1_hello_world/napi": () => require("./examples/1-getting-started/1_hello_world/napi/hello.js"),
+    "1_hello_world/node-addon-api": () => require("./examples/1-getting-started/1_hello_world/node-addon-api/hello.js"),
+    "1_hello_world/node-addon-api-addon-class": () => require("./examples/1-getting-started/1_hello_world/node-addon-api-addon-class/hello.js"),
+    "2_function_arguments/napi": () => require("./examples/1-getting-started/2_function_arguments/napi/addon.js"),
+    "2_function_arguments/node-addon-api": () => require("./examples/1-getting-started/2_function_arguments/node-addon-api/addon.js"),
+    "3_callbacks/napi": () => require("./examples/1-getting-started/3_callbacks/napi/addon.js"),
+    "3_callbacks/node-addon-api": () => require("./examples/1-getting-started/3_callbacks/node-addon-api/addon.js"),
+    "4_object_factory/napi": () => require("./examples/1-getting-started/4_object_factory/napi/addon.js"),
+    "4_object_factory/node-addon-api": () => require("./examples/1-getting-started/4_object_factory/node-addon-api/addon.js"),
     "5_function_factory": () => require("./examples/1-getting-started/5_function_factory/napi/addon.js"),
   },
   "5-async-work": {

packages/node-addon-examples/index.js

@@ -6,14 +6,14 @@ import { EXAMPLES_DIR } from "./cmake-projects.mjs";
 
 const ALLOW_LIST = [
   "1-getting-started/1_hello_world/napi/",
-  // "1-getting-started/1_hello_world/node-addon-api/"
-  // "1-getting-started/1_hello_world/node-addon-api-addon-class/"
+  "1-getting-started/1_hello_world/node-addon-api/",
+  "1-getting-started/1_hello_world/node-addon-api-addon-class/",
   "1-getting-started/2_function_arguments/napi/",
-  // "1-getting-started/2_function_arguments/node-addon-api/",
+  "1-getting-started/2_function_arguments/node-addon-api/",
   "1-getting-started/3_callbacks/napi/",
-  // "1-getting-started/3_callbacks/node-addon-api/",
+  "1-getting-started/3_callbacks/node-addon-api/",
   "1-getting-started/4_object_factory/napi/",
-  // "1-getting-started/4_object_factory/node-addon-api/",
+  "1-getting-started/4_object_factory/node-addon-api/",
   "1-getting-started/5_function_factory/napi/",
   // "1-getting-started/5_function_factory/node-addon-api/",
   // "1-getting-started/6_object_wrap/napi/", // TODO: Fix C++ support to allow lambda functions
@@ -66,12 +66,4 @@ for (const src of ALLOW_LIST) {
   const destPath = path.join(EXAMPLES_DIR, src);
   console.log("Copying from", srcPath, "to", destPath);
   fs.cpSync(srcPath, destPath, { recursive: true });
-  // Patch binding.gyp files
-  // TODO: Make the gyp-to-cmake tool handle single quotes in binding.gyp files
-  const bindingGypPath = path.join(destPath, "binding.gyp");
-  if (fs.existsSync(bindingGypPath)) {
-    const contents = fs.readFileSync(bindingGypPath, "utf-8");
-    const patchedContents = contents.replaceAll("'", '"');
-    fs.writeFileSync(bindingGypPath, patchedContents, "utf-8");
-  }
 }