breeze-bindgen 1.1.0 → 1.1.2

package/README.md

@@ -39,14 +39,23 @@ breeze-bindgen -i <input_header_file> [options]
 
 **Options:**
 
-*   `-i, --input <input_header_file>`: Path to the input C++ header file to process. (Required)
-*   `-o, --output <output_directory>`: Directory where the generated `binding_qjs.h` and `binding_types.d.ts` files will be saved. Defaults to `generated_bindings` in the input file's directory if not specified.
-*   `--clang <clang_executable_path>`: Optional path to the `clang++` executable.
-*   `--cppBindingOutputFile <filename>`: Name of the generated C++ binding file. Defaults to `binding_qjs.h`.
-*   `--tsDefinitionOutputFile <filename>`: Name of the generated TypeScript definition file. Defaults to `binding_types.d.ts`.
-*   `--astJsonTempFile <filename>`: Temporary file name for the clang AST JSON output. Defaults to `ast.temp.json`.
-*   `--quickjsTypesPath <filepath>`: Path to the `quickjs-types.txt` file relative to the bindgen directory. Defaults to `quickjs-types.txt`.
-*   `--nameFilter <filter>`: Clang AST dump filter for names (e.g., "breeze::js"). Defaults to "breeze::js".
+      --version                 Show version number                    [boolean]
+  -i, --input                   Path to the input C++ header file to process.
+                                                             [string] [required]
+  -o, --output                  Directory where the generated binding.h and
+                                definition.d.ts files will be saved.    [string]
+      --clang                   Optional path to the clang++ executable.[string]
+      --cppBindingOutputFile    Name of the generated C++ binding file.
+                                             [string] [default: "binding_qjs.h"]
+      --tsDefinitionOutputFile  Name of the generated TypeScript definition
+                                file.   [string] [default: "binding_types.d.ts"]
+      --tsModuleName            Name of the TypeScript module.
+                                                  [string] [default: "BreezeJS"]
+      --extTypesPath            Path to additional type definitions.
+                                                          [string] [default: ""]
+      --nameFilter              Clang AST dump filter for names (e.g.,
+                                "breeze::js").  [string] [default: "breeze::js"]
+  -h, --help                    Show help                              [boolean]
 
 **Example:**
 

package/dist/cli.mjs

@@ -195,7 +195,7 @@ function parseFunctionQualType(type) {
   if (state !== 2 /* Done */) throw new Error("Invalid function type");
   return { returnType, args };
 }
-function processAstAndGenerateCode(astArr, originalCppFilePath, nameFilter, additionalTypes) {
+function processAstAndGenerateCode(astArr, originalCppFilePath, nameFilter, additionalTypes, tsModuleName) {
   const origFileContent = readFileSync(originalCppFilePath, "utf-8").split("\n").map((v) => v.trim());
   const structNames = [];
   const resolveUnderPath = (path, resolveName) => {
@@ -214,11 +214,11 @@ function processAstAndGenerateCode(astArr, originalCppFilePath, nameFilter, addi
     const parsed = parser2.parse(type, (name) => resolveUnderPath(path, name));
     return parser2.formatToC(parsed);
   };
-  let binding = `// This file is generated by bindgen
+  let binding = `// This file is generated by Breeze.JS Bindgen (https://github.com/breeze-shell/breeze-js-bindgen)
 // Do not modify this file manually!
 
 #pragma once
-#include "binding_types.h" // Assuming this will be in the same output directory
+#include "binding_types.h"
 #include "quickjs.h"
 #include "quickjspp.hpp"
 
@@ -230,7 +230,7 @@ struct js_bind {
   let typescriptDef = `// This file is generated by bindgen
 // Do not modify this file manually!
 
-declare module 'mshell' { // TODO: Make module name configurable or derive
+declare module '${tsModuleName}' {
 `;
   const generateForRecordDecl = (node_struct, path) => {
     if (node_struct.kind !== "CXXRecordDecl") throw new Error("Node is not a RecordDecl");
@@ -391,7 +391,7 @@ export class ${tsClassName}${bases.length > 0 ? ` extends ${bases.map((base) =>
     if (tsNamespace) typescriptDef += `
 }`;
   };
-  const enumerateStructDecls = (node, callback, path = ["breeze"]) => {
+  const enumerateStructDecls = (node, callback, path = [nameFilter.split("::")[0]]) => {
     if (node.kind === "CXXRecordDecl" && node.name && node.inner) {
       callback(node, path);
     }
@@ -436,7 +436,8 @@ function generateBindingsAndDefinitions(config) {
     cppBindingOutputFile = DEFAULT_CPP_BINDING_OUTPUT_FILE,
     tsDefinitionOutputFile = DEFAULT_TS_DEFINITION_OUTPUT_FILE,
     additionalTypes = "",
-    nameFilter = DEFAULT_NAME_FILTER
+    nameFilter = DEFAULT_NAME_FILTER,
+    tsModuleName = "mshell"
   } = config;
   const absoluteCppFilePath = resolvePath(cppFilePath);
   const absoluteOutputDir = resolvePath(outputDir);
@@ -482,7 +483,7 @@ ${clangProcess.stderr}`);
   if (!astArr || astArr.length === 0) {
     log.warn(`No AST data was parsed. This might mean the ast-dump-filter ("${nameFilter.slice(0, -2)}") didn't match anything, or the input file is empty or has no relevant declarations.`);
   }
-  const { cppBinding, tsDefinitions } = processAstAndGenerateCode(astArr, absoluteCppFilePath, nameFilter, additionalTypes);
+  const { cppBinding, tsDefinitions } = processAstAndGenerateCode(astArr, absoluteCppFilePath, nameFilter, additionalTypes, tsModuleName);
   if (!existsSync(absoluteOutputDir)) {
     try {
       mkdirSync(absoluteOutputDir, { recursive: true });
@@ -5178,7 +5179,6 @@ async function main() {
     alias: "o",
     type: "string",
     description: "Directory where the generated binding.h and definition.d.ts files will be saved."
-    // Default will be set later based on input file if not provided
   }).option("clang", {
     type: "string",
     description: "Optional path to the clang++ executable."
@@ -5190,10 +5190,10 @@ async function main() {
     type: "string",
     description: "Name of the generated TypeScript definition file.",
     default: "binding_types.d.ts"
-  }).option("astJsonTempFile", {
+  }).option("tsModuleName", {
     type: "string",
-    description: "Temporary file name for the clang AST JSON output.",
-    default: "ast.temp.json"
+    description: "Name of the TypeScript module.",
+    default: "BreezeJS"
   }).option("extTypesPath", {
     type: "string",
     description: "Path to additional type definitions.",
@@ -5202,7 +5202,6 @@ async function main() {
     type: "string",
     description: 'Clang AST dump filter for names (e.g., "breeze::js").',
     default: "breeze::js"
-    // Note: core.ts adds "::" internally
   }).help().alias("h", "help").parse();
   try {
     const inputFile = resolvePath2(argv.input);
@@ -5227,8 +5226,8 @@ async function main() {
       cppBindingOutputFile: argv.cppBindingOutputFile,
       tsDefinitionOutputFile: argv.tsDefinitionOutputFile,
       additionalTypes: argv.extTypesPath ? readFileSync5(resolvePath2(argv.extTypesPath), "utf-8") : "",
-      nameFilter: argv.nameFilter + "::"
-      // Add "::" back for internal use
+      nameFilter: argv.nameFilter + "::",
+      tsModuleName: argv.tsModuleName
     });
     log2("Binding generation finished successfully.");
   } catch (error) {

package/dist/core.cjs

@@ -406,7 +406,7 @@ function parseFunctionQualType(type) {
   if (state !== 2 /* Done */) throw new Error("Invalid function type");
   return { returnType, args };
 }
-function processAstAndGenerateCode(astArr, originalCppFilePath, nameFilter, additionalTypes) {
+function processAstAndGenerateCode(astArr, originalCppFilePath, nameFilter, additionalTypes, tsModuleName) {
   const origFileContent = (0, import_node_fs.readFileSync)(originalCppFilePath, "utf-8").split("\n").map((v) => v.trim());
   const structNames = [];
   const resolveUnderPath = (path, resolveName) => {
@@ -425,11 +425,11 @@ function processAstAndGenerateCode(astArr, originalCppFilePath, nameFilter, addi
     const parsed = parser.parse(type, (name) => resolveUnderPath(path, name));
     return parser.formatToC(parsed);
   };
-  let binding = `// This file is generated by bindgen
+  let binding = `// This file is generated by Breeze.JS Bindgen (https://github.com/breeze-shell/breeze-js-bindgen)
 // Do not modify this file manually!
 
 #pragma once
-#include "binding_types.h" // Assuming this will be in the same output directory
+#include "binding_types.h"
 #include "quickjs.h"
 #include "quickjspp.hpp"
 
@@ -441,7 +441,7 @@ struct js_bind {
   let typescriptDef = `// This file is generated by bindgen
 // Do not modify this file manually!
 
-declare module 'mshell' { // TODO: Make module name configurable or derive
+declare module '${tsModuleName}' {
 `;
   const generateForRecordDecl = (node_struct, path) => {
     if (node_struct.kind !== "CXXRecordDecl") throw new Error("Node is not a RecordDecl");
@@ -602,7 +602,7 @@ export class ${tsClassName}${bases.length > 0 ? ` extends ${bases.map((base) =>
     if (tsNamespace) typescriptDef += `
 }`;
   };
-  const enumerateStructDecls = (node, callback, path = ["breeze"]) => {
+  const enumerateStructDecls = (node, callback, path = [nameFilter.split("::")[0]]) => {
     if (node.kind === "CXXRecordDecl" && node.name && node.inner) {
       callback(node, path);
     }
@@ -647,7 +647,8 @@ function generateBindingsAndDefinitions(config) {
     cppBindingOutputFile = DEFAULT_CPP_BINDING_OUTPUT_FILE,
     tsDefinitionOutputFile = DEFAULT_TS_DEFINITION_OUTPUT_FILE,
     additionalTypes = "",
-    nameFilter = DEFAULT_NAME_FILTER
+    nameFilter = DEFAULT_NAME_FILTER,
+    tsModuleName = "mshell"
   } = config;
   const absoluteCppFilePath = (0, import_node_path.resolve)(cppFilePath);
   const absoluteOutputDir = (0, import_node_path.resolve)(outputDir);
@@ -693,7 +694,7 @@ ${clangProcess.stderr}`);
   if (!astArr || astArr.length === 0) {
     import_fancy_log.default.warn(`No AST data was parsed. This might mean the ast-dump-filter ("${nameFilter.slice(0, -2)}") didn't match anything, or the input file is empty or has no relevant declarations.`);
   }
-  const { cppBinding, tsDefinitions } = processAstAndGenerateCode(astArr, absoluteCppFilePath, nameFilter, additionalTypes);
+  const { cppBinding, tsDefinitions } = processAstAndGenerateCode(astArr, absoluteCppFilePath, nameFilter, additionalTypes, tsModuleName);
   if (!(0, import_node_fs.existsSync)(absoluteOutputDir)) {
     try {
       (0, import_node_fs.mkdirSync)(absoluteOutputDir, { recursive: true });

package/dist/core.mjs

@@ -401,7 +401,7 @@ function parseFunctionQualType(type) {
   if (state !== 2 /* Done */) throw new Error("Invalid function type");
   return { returnType, args };
 }
-function processAstAndGenerateCode(astArr, originalCppFilePath, nameFilter, additionalTypes) {
+function processAstAndGenerateCode(astArr, originalCppFilePath, nameFilter, additionalTypes, tsModuleName) {
   const origFileContent = readFileSync(originalCppFilePath, "utf-8").split("\n").map((v) => v.trim());
   const structNames = [];
   const resolveUnderPath = (path, resolveName) => {
@@ -420,11 +420,11 @@ function processAstAndGenerateCode(astArr, originalCppFilePath, nameFilter, addi
     const parsed = parser.parse(type, (name) => resolveUnderPath(path, name));
     return parser.formatToC(parsed);
   };
-  let binding = `// This file is generated by bindgen
+  let binding = `// This file is generated by Breeze.JS Bindgen (https://github.com/breeze-shell/breeze-js-bindgen)
 // Do not modify this file manually!
 
 #pragma once
-#include "binding_types.h" // Assuming this will be in the same output directory
+#include "binding_types.h"
 #include "quickjs.h"
 #include "quickjspp.hpp"
 
@@ -436,7 +436,7 @@ struct js_bind {
   let typescriptDef = `// This file is generated by bindgen
 // Do not modify this file manually!
 
-declare module 'mshell' { // TODO: Make module name configurable or derive
+declare module '${tsModuleName}' {
 `;
   const generateForRecordDecl = (node_struct, path) => {
     if (node_struct.kind !== "CXXRecordDecl") throw new Error("Node is not a RecordDecl");
@@ -597,7 +597,7 @@ export class ${tsClassName}${bases.length > 0 ? ` extends ${bases.map((base) =>
     if (tsNamespace) typescriptDef += `
 }`;
   };
-  const enumerateStructDecls = (node, callback, path = ["breeze"]) => {
+  const enumerateStructDecls = (node, callback, path = [nameFilter.split("::")[0]]) => {
     if (node.kind === "CXXRecordDecl" && node.name && node.inner) {
       callback(node, path);
     }
@@ -642,7 +642,8 @@ function generateBindingsAndDefinitions(config) {
     cppBindingOutputFile = DEFAULT_CPP_BINDING_OUTPUT_FILE,
     tsDefinitionOutputFile = DEFAULT_TS_DEFINITION_OUTPUT_FILE,
     additionalTypes = "",
-    nameFilter = DEFAULT_NAME_FILTER
+    nameFilter = DEFAULT_NAME_FILTER,
+    tsModuleName = "mshell"
   } = config;
   const absoluteCppFilePath = resolvePath(cppFilePath);
   const absoluteOutputDir = resolvePath(outputDir);
@@ -688,7 +689,7 @@ ${clangProcess.stderr}`);
   if (!astArr || astArr.length === 0) {
     import_fancy_log.default.warn(`No AST data was parsed. This might mean the ast-dump-filter ("${nameFilter.slice(0, -2)}") didn't match anything, or the input file is empty or has no relevant declarations.`);
   }
-  const { cppBinding, tsDefinitions } = processAstAndGenerateCode(astArr, absoluteCppFilePath, nameFilter, additionalTypes);
+  const { cppBinding, tsDefinitions } = processAstAndGenerateCode(astArr, absoluteCppFilePath, nameFilter, additionalTypes, tsModuleName);
   if (!existsSync(absoluteOutputDir)) {
     try {
       mkdirSync(absoluteOutputDir, { recursive: true });

package/package.json

@@ -1,7 +1,7 @@
 {
   "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e",
   "name": "breeze-bindgen",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",