hbs-magic 0.1.0

package/examples/advanced_csharp-url-helpers/input/template.hbs

@@ -0,0 +1,44 @@
+using System;
+using System.Collections.Generic;
+
+namespace ExampleProject.Common.FrontendUrlHelpers;
+
+//--------------------------------------------------------------------------------------------------------------
+// <auto-generated>
+//     This file was auto-generated by "hbs-magic" CLI.
+//     Do not modify this file manually. Instead, modify the template and regenerate the code.
+// </auto-generated>
+//--------------------------------------------------------------------------------------------------------------
+
+public static class Routes
+{
+{{#each this.Routes}}
+  {{> node}}
+{{/each}}
+}
+
+public interface IRouteQueryParams
+{
+    public string GetQueryString();
+}
+
+{{#each this.QueryParamCollections}}
+public class {{@key}}QueryParams : IRouteQueryParams
+{
+    {{#each this}}
+    public {{{csType this}}}? {{csFieldName @key}} { get; init; }
+    {{/each}}
+
+    public string GetQueryString()
+    {
+        var queryParams = new List<string>();
+
+        {{#each this}}
+        if ({{{csNullableCheck @key this}}})
+          queryParams.Add($"{{@key}}={ {{{csNullableValue @key this}}} }");
+        {{/each}}
+
+        return string.Join("&", queryParams);
+    }
+}
+{{/each}}

package/examples/advanced_csharp-url-helpers/input/template_partial_node.hbs

@@ -0,0 +1,32 @@
+{{#if (isGroup this)}}
+  public static class {{@key}}
+  {
+  {{#each this}}
+    {{#> node }}
+      Failover content
+    {{/node}}
+  {{/each}}
+  }
+{{/if}}
+
+{{#if (isRoute this)}}
+  public static class {{@key}}
+  {
+  public static string Link(
+  string siteUrl
+  {{#each routeParams}}
+    , {{{csType this}}} {{@key}}
+  {{/each}}
+  {{#if queryParams}}
+    , {{@key}}QueryParams queryParams
+  {{/if}}
+  ) =>
+  siteUrl + "{{route}}"
+  {{#each routeParams}}
+    .Replace(":{{@key}}", {{@key}}.ToString())
+  {{/each}}
+  {{#if queryParams}}
+    + "?" + queryParams.GetQueryString()
+  {{/if}};
+  }
+{{/if}}

package/examples/from-api_ts-api-client/Result.gen.ts

@@ -0,0 +1,189 @@
+//--------------------------------------------------------------------------------------------------------------
+// <auto-generated>
+//     This file was auto-generated by "hbs-magic" CLI.
+//     Do not modify this file manually. Instead, modify the template and regenerate the code.
+// </auto-generated>
+//--------------------------------------------------------------------------------------------------------------
+
+export async function updatePet() {
+  // put /pet
+
+  console.log("Calling put /pet");
+}
+
+export async function addPet() {
+  // post /pet
+
+  console.log("Calling post /pet");
+}
+
+export async function findPetsByStatus(status: string) {
+  // get /pet/findByStatus
+
+  const params = {
+    status,
+  };
+  console.log("Params:", params);
+
+  console.log("Calling get /pet/findByStatus");
+}
+
+export async function findPetsByTags(tags: string[]) {
+  // get /pet/findByTags
+
+  const params = {
+    tags,
+  };
+  console.log("Params:", params);
+
+  console.log("Calling get /pet/findByTags");
+}
+
+export async function getPetById(petId: number) {
+  // get /pet/{petId}
+
+  const params = {
+    petId,
+  };
+  console.log("Params:", params);
+
+  console.log("Calling get /pet/{petId}");
+}
+
+export async function updatePetWithForm(
+  petId: number,
+  name: string,
+  status: string,
+) {
+  // post /pet/{petId}
+
+  const params = {
+    petId,
+    name,
+    status,
+  };
+  console.log("Params:", params);
+
+  console.log("Calling post /pet/{petId}");
+}
+
+export async function deletePet(api_key: string, petId: number) {
+  // delete /pet/{petId}
+
+  const params = {
+    api_key,
+    petId,
+  };
+  console.log("Params:", params);
+
+  console.log("Calling delete /pet/{petId}");
+}
+
+export async function uploadFile(petId: number, additionalMetadata: string) {
+  // post /pet/{petId}/uploadImage
+
+  const params = {
+    petId,
+    additionalMetadata,
+  };
+  console.log("Params:", params);
+
+  console.log("Calling post /pet/{petId}/uploadImage");
+}
+
+export async function getInventory() {
+  // get /store/inventory
+
+  console.log("Calling get /store/inventory");
+}
+
+export async function placeOrder() {
+  // post /store/order
+
+  console.log("Calling post /store/order");
+}
+
+export async function getOrderById(orderId: number) {
+  // get /store/order/{orderId}
+
+  const params = {
+    orderId,
+  };
+  console.log("Params:", params);
+
+  console.log("Calling get /store/order/{orderId}");
+}
+
+export async function deleteOrder(orderId: number) {
+  // delete /store/order/{orderId}
+
+  const params = {
+    orderId,
+  };
+  console.log("Params:", params);
+
+  console.log("Calling delete /store/order/{orderId}");
+}
+
+export async function createUser() {
+  // post /user
+
+  console.log("Calling post /user");
+}
+
+export async function createUsersWithListInput() {
+  // post /user/createWithList
+
+  console.log("Calling post /user/createWithList");
+}
+
+export async function loginUser(username: string, password: string) {
+  // get /user/login
+
+  const params = {
+    username,
+    password,
+  };
+  console.log("Params:", params);
+
+  console.log("Calling get /user/login");
+}
+
+export async function logoutUser() {
+  // get /user/logout
+
+  console.log("Calling get /user/logout");
+}
+
+export async function getUserByName(username: string) {
+  // get /user/{username}
+
+  const params = {
+    username,
+  };
+  console.log("Params:", params);
+
+  console.log("Calling get /user/{username}");
+}
+
+export async function updateUser(username: string) {
+  // put /user/{username}
+
+  const params = {
+    username,
+  };
+  console.log("Params:", params);
+
+  console.log("Calling put /user/{username}");
+}
+
+export async function deleteUser(username: string) {
+  // delete /user/{username}
+
+  const params = {
+    username,
+  };
+  console.log("Params:", params);
+
+  console.log("Calling delete /user/{username}");
+}

package/examples/from-api_ts-api-client/input/hbs-helpers.ts

@@ -0,0 +1,53 @@
+/**
+ * Builds a function name from operationId or falls back to method + path.
+ */
+function operationName(op: any, method: string, path: string) {
+  if (op.operationId) return op.operationId;
+
+  return (
+    method +
+    path
+      .replace(/[{}]/g, "")
+      .split("/")
+      .filter(Boolean)
+      .map((p, i) => (i === 0 ? p : p.charAt(0).toUpperCase() + p.slice(1)))
+      .join("")
+  );
+}
+
+/**
+ * Extracts parameters array safely.
+ */
+function getParams(op: any) {
+  return op.parameters || [];
+}
+
+function hasParams(op: any) {
+  return op.parameters && op.parameters.length > 0;
+}
+
+/**
+ * Converts OpenAPI types to TypeScript types (very minimal).
+ */
+function tsType(schema: any): string {
+  if (!schema) return "any";
+
+  switch (schema.type) {
+    case "integer":
+    case "number":
+      return "number";
+    case "boolean":
+      return "boolean";
+    case "array":
+      return `${tsType(schema.items)}[]`;
+    default:
+      return "string";
+  }
+}
+
+export default {
+  operationName,
+  getParams,
+  hasParams,
+  tsType,
+};

package/examples/from-api_ts-api-client/input/template.hbs

@@ -0,0 +1,30 @@
+//--------------------------------------------------------------------------------------------------------------
+// <auto-generated>
+//     This file was auto-generated by "hbs-magic" CLI.
+//     Do not modify this file manually. Instead, modify the template and regenerate the code.
+// </auto-generated>
+//--------------------------------------------------------------------------------------------------------------
+
+{{#each paths}}
+    {{#each this}}
+        export async function {{operationName this @key @../key}}(
+        {{#each (getParams this)}}
+            {{name}}: {{tsType schema}}{{#unless @last}},{{/unless}}
+        {{/each}}
+        ) {
+        // {{@key}} {{@../key}}
+
+        {{#if (hasParams this)}}
+            const params = {
+            {{#each (getParams this)}}
+                {{name}},
+            {{/each}}
+            };
+            console.log("Params:", params);
+        {{/if}}
+
+        console.log("Calling {{@key}} {{@../key}}");
+        }
+
+    {{/each}}
+{{/each}}

package/examples/simple_assets-helper/Result.gen.ts

@@ -0,0 +1,36 @@
+import dummy_audio_1SFX from "examples/simple_assets-helper/external-input/dummy_audio_1.mp3";
+import dummy_audio_2SFX from "examples/simple_assets-helper/external-input/dummy_audio_2.mp3";
+import dummy_audio_3SFX from "examples/simple_assets-helper/external-input/dummy_audio_3.mp3";
+
+//--------------------------------------------------------------------------------------------------------------
+// <auto-generated>
+//     This file was auto-generated by "hbs-magic" CLI.
+//     Do not modify this file manually. Instead, modify the template and regenerate the code.
+// </auto-generated>
+//--------------------------------------------------------------------------------------------------------------
+
+export interface SoundSource {
+  src: string;
+  name: string;
+}
+
+export enum SoundEffect {
+  dummy_audio_1 = "dummy_audio_1",
+  dummy_audio_2 = "dummy_audio_2",
+  dummy_audio_3 = "dummy_audio_3",
+}
+
+export const SoundEffects: Record<SoundEffect, SoundSource> = {
+  [SoundEffect.dummy_audio_1]: {
+    src: dummy_audio_1SFX,
+    name: SoundEffect.dummy_audio_1,
+  },
+  [SoundEffect.dummy_audio_2]: {
+    src: dummy_audio_2SFX,
+    name: SoundEffect.dummy_audio_2,
+  },
+  [SoundEffect.dummy_audio_3]: {
+    src: dummy_audio_3SFX,
+    name: SoundEffect.dummy_audio_3,
+  },
+};

package/examples/simple_assets-helper/input/preparation-script.ts

@@ -0,0 +1,45 @@
+import { readdir, stat } from "fs/promises";
+import path from "path";
+
+async function getFiles(dir: string) {
+  let results: string[] = [];
+
+  const items = await readdir(dir);
+
+  for (const item of items) {
+    const fullPath = path.join(dir, item);
+    const stats = await stat(fullPath);
+
+    if (stats.isDirectory()) {
+      results = results.concat(await getFiles(fullPath));
+    } else {
+      results.push(fullPath);
+    }
+  }
+
+  return results;
+}
+
+function getNameFromPath(
+  path: string,
+  includeExtension: boolean = true,
+): string {
+  return includeExtension
+    ? (path.split("\\").pop() ?? "")
+    : path.slice(path.lastIndexOf("\\") + 1, path.lastIndexOf("."));
+}
+
+/**
+ *  Example of preparation script that reads the contents of some assets folder
+ *  into an object for Handlebars template input.
+ */
+export default async function preparationScript() {
+  const sounds = (
+    await getFiles("examples/simple_assets-helper/external-input")
+  ).map((path) => ({
+    name: getNameFromPath(path, false),
+    path: path.replace(/\\/g, "/"),
+  }));
+
+  return { soundEffects: sounds };
+}

package/examples/simple_assets-helper/input/template.hbs

@@ -0,0 +1,31 @@
+{{#each soundEffects}}
+    import {{name}}SFX from "{{path}}";
+{{/each}}
+
+//--------------------------------------------------------------------------------------------------------------
+// <auto-generated>
+//     This file was auto-generated by "hbs-magic" CLI.
+//     Do not modify this file manually. Instead, modify the template and regenerate the code.
+// </auto-generated>
+//--------------------------------------------------------------------------------------------------------------
+
+export interface SoundSource {
+src: string;
+name: string;
+}
+
+export enum SoundEffect {
+{{#each soundEffects}}
+    {{name}} = '{{name}}',
+{{/each}}
+}
+
+export const SoundEffects: Record<SoundEffect, SoundSource>  = {
+{{#each soundEffects}}
+    [SoundEffect.{{name}}]:
+    {
+    src: {{name}}SFX,
+    name: SoundEffect.{{name}},
+    },
+{{/each}}
+}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "hbs-magic",
+  "version": "0.1.0",
+  "description": "A CLI tool designed to simplify source-generation with Handlebars templates as much as humanly possible.",
+  "keywords": [
+    "source-code-generation",
+    "source-generation",
+    "code-generation",
+    "handlebars",
+    "hbs",
+    "cli",
+    "typescript"
+  ],
+  "homepage": "https://github.com/IvanKobtsev/hbs-magic#readme",
+  "bugs": {
+    "url": "https://github.com/IvanKobtsev/hbs-magic/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/IvanKobtsev/hbs-magic.git"
+  },
+  "license": "MIT",
+  "author": "xubarashi",
+  "type": "module",
+  "main": "./dist/bin/cli.js",
+  "bin": {
+    "hbs-magic": "./dist/bin/cli.js"
+  },
+  "scripts": {
+    "build": "tsc",
+    "render-examples": "tsc && npm run assets-helper && npm run ts-api-client && npm run csharp-url-helpers",
+    "csharp-url-helpers": "hbs-magic --hbs=examples/advanced_csharp-url-helpers/input --output=examples/advanced_csharp-url-helpers/Result.gen.cs",
+    "ts-api-client": "hbs-magic --input=https://petstore3.swagger.io/api/v3/openapi.json --hbs=examples/from-api_ts-api-client/input --output=examples/from-api_ts-api-client/Result.gen.ts",
+    "assets-helper": "hbs-magic --hbs=examples/simple_assets-helper/input --output=examples/simple_assets-helper/Result.gen.ts"
+  },
+  "devDependencies": {
+    "@types/node": "17.0.24",
+    "@types/node-fetch": "^2.6.13",
+    "react-router-url-params": "^0.9.2",
+    "ts-morph": "^27.0.2",
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "concurrently": "^9.2.1",
+    "esbuild": "^0.27.4",
+    "esbuild-register": "^3.6.0",
+    "handlebars": "^4.7.8",
+    "node-fetch": "^3.3.2",
+    "prettier": "^3.8.1",
+    "ts-node": "^10.9.2"
+  }
+}

package/src/cli-messages.ts

@@ -0,0 +1,88 @@
+export const inputDataNotFound = `No input data found.
+
+Please provide data using one of the following options:
+
+1. Use the "--input" flag with a path or URL to a JSON file
+   Example: hbs-magic --input=./data.json
+
+2. Add a preparation script:
+   - File name: preparation-script.ts or preparation-script.js
+   - Must export a default function that returns the data object
+   - Place it inside your .hbs template folder
+
+3. Add a default JSON file:
+   - File name: input-data.json
+   - Place it inside your .hbs template folder
+
+Need help? Run: hbs-magic --help`;
+
+export const multipleSourcesDetected = `Warning: Multiple input sources detected.
+
+hbs-magic will use only one source based on the following priority:
+
+1. --input flag
+2. preparation-script.ts/js
+3. input-data.json
+
+The highest-priority source will be used. All others will be ignored.
+
+Tip: Remove unused inputs to make your setup clearer.`;
+
+export const positionalArgumentsNotAllowed = `No positional arguments allowed. Use '--key=value' format.`;
+
+export const hbsMagicCliUsage = `Usage: [--input=<json>] --hbs=<folder> --output=<file> [--disable-formatting]
+    --input: Optional JSON input file path. If not provided, the script will look for "input-data.json" in the specified hbs folder.
+    --hbs: Required folder containing the Handlebars template, optional helpers, partials, and preparation script.
+    --output: Required output file path where the generated source code will be written.
+    --disable-formatting: Optional flag to disable auto-formatting of the output file after generation.`;
+
+export const hbsMagicHelp = `hbs-magic — source-code generation with Handlebars templates
+
+Usage:
+  hbs-magic --hbs=<folder> --output=<file> [--input=<json>] [--disable-formatting]
+
+Required flags:
+  --hbs=<folder>        Folder containing your Handlebars template and optional
+                        helpers, partials, and preparation script.
+  --output=<file>       Path where the generated file will be written.
+
+Optional flags:
+  --input=<json>        External JSON data source — a local file path or a URL.
+  --disable-formatting  Skip auto-formatting of the generated output.
+  --help                Show this help message.
+
+Input folder structure:
+  The --hbs folder can contain any combination of these files:
+
+  template.hbs              (required)  The Handlebars template to render.
+  input-data.json           (optional)  Static JSON data for the template.
+  preparation-script.ts     (optional)  Script exporting a default function
+                                        that returns the data object.
+  hbs-helpers.ts            (optional)  Custom Handlebars helpers. Must export
+                                        a default object: { helperName: fn }.
+  template_partial_*.hbs    (optional)  Partials, named by the part after the
+                                        second "_" (e.g. template_partial_row.hbs
+                                        registers a partial called "row").
+
+Data source priority:
+  If multiple sources are provided, only one is used:
+    1. --input flag          (highest)
+    2. preparation-script
+    3. input-data.json       (lowest)
+
+Auto-formatting:
+  Output files are automatically formatted based on extension:
+    .ts .tsx .js .jsx  →  Prettier
+    .cs                →  CSharpier
+
+Examples:
+  # Simple: static JSON + template
+  hbs-magic --hbs=gen/input --output=src/result.gen.ts
+
+  # From a remote API
+  hbs-magic --input=https://api.example.com/openapi.json --hbs=gen/input --output=src/client.gen.ts
+
+  # With formatting disabled
+  hbs-magic --hbs=gen/input --output=src/result.gen.ts --disable-formatting
+
+Documentation: https://github.com/IvanKobtsev/hbs-magic#readme`;