feat: add generate command (#244)

Author: nmerget

.gitignore

@@ -15,5 +15,6 @@ yarn.lock
 ## Genrated files
 test/**/*.mjs
 test/**/*.js
+test/generate/**/*.ts
 test/init/game
 /src/commands/init/generated.ts

docs/API.md

@@ -16,6 +16,18 @@ Build typescript files
 | `--dry`           |       | Do a dry run with this command - prints/returns output |    `❌`   |                      |
 | `--minifyClasses` |       | Minifies GodotJS classes                               |    `❌`   | `true`               |
 
+## generate
+
+Generate typescript utility files
+
+> You can use `generate.json` as a config file. 
+  By default it tries to search for the configuration otherwise use a correct path by passing `--config=./generate.json`.
+
+| long    | short | description                                     | required | defaultValue |
+| :------ | :---: | :---------------------------------------------- | :------: | :----------- |
+| `--src` |       | Relative path where script files located        |    `❌`   | `"."`        |
+| `--out` |       | Relative path where generated files are written |    `❌`   | `"."`        |
+
 ## init
 
 Creates a new GodotJS project with TypeScript support

package-lock.json

@@ -47,6 +47,7 @@
     "globals": "^16.0.0",
     "husky": "^9.0.11",
     "markdown-table": "^3.0.3",
+    "nodemon": "3.1.10",
     "npm-run-all2": "8.0.1",
     "prettier": "^3.0.3",
     "tsx": "^4.19.1",

package.json

@@ -0,0 +1,20 @@
+import { ProgramOptionsType } from "../../data";
+import { ConfigType, OutConfigType } from "../../utils/shared";
+
+export type GenerateConfigType = {
+  src?: string;
+} & OutConfigType &
+  ConfigType;
+
+export const generateOptions: ProgramOptionsType[] = [
+  {
+    name: "src",
+    defaultValue: ".",
+    description: "Relative path where script files located",
+  },
+  {
+    name: "out",
+    defaultValue: ".",
+    description: "Relative path where generated files are written",
+  },
+];

src/commands/generate/data.ts

@@ -0,0 +1,39 @@
+import { writeFileSync } from "node:fs";
+import { resolve } from "node:path";
+import { GDScript } from "./parse";
+
+const getResourcePath = (filePath: string) => {
+  return `"res://${filePath.replace(/\\/g, "/")}"`;
+};
+
+export const generateGDScriptPathsFile = (
+  gdScripts: GDScript[],
+  outputPath: string,
+) => {
+  const imports = gdScripts.map(({ class_name }) => class_name).join(",");
+  const pathTypes = gdScripts
+    .map(({ filePath }) => getResourcePath(filePath))
+    .join("\n| ");
+  const classTypes = gdScripts.map(({ class_name }) => class_name).join("\n| ");
+
+  const fileContent = `import { ResourceLoader } from "godot";
+  import { ${imports} } from "gdscript";
+  
+  type GDScriptPaths = ${pathTypes} | string;
+
+  type GDScriptClasses = ${classTypes} | unknown;
+  
+  /**
+ * Instantiate a GDScript class with \`.new()\`.
+ * @param path Local path to the GDScript file.
+ */
+  export function instantiate_gdscript<T extends GDScriptClasses>(
+  path: GDScriptPaths ,
+): T {
+  return ResourceLoader.load(path).call("new") as T;
+  }
+  `;
+
+  const resolvedPath = resolve(outputPath);
+  writeFileSync(resolvedPath, fileContent, "utf-8");
+};