chore: migrate to handlebars

Author: raideer

package-lock.json

@@ -309,7 +309,6 @@
     "deploy": "vsce publish"
   },
   "devDependencies": {
-    "@types/ejs": "^3.1.5",
     "@types/lodash-es": "^4.17.12",
     "@types/mocha": "^10.0.10",
     "@types/node": "20.x",
@@ -336,16 +335,17 @@
     "vsce": "^2.15.0"
   },
   "dependencies": {
+    "@types/handlebars": "^4.1.0",
     "@vscode-elements/elements": "^1.11.0",
     "@xml-tools/ast": "^5.0.5",
     "@xml-tools/content-assist": "^3.1.11",
     "@xml-tools/parser": "^1.0.11",
     "@xml-tools/simple-schema": "^3.0.5",
     "@xml-tools/validation": "^1.0.16",
-    "ejs": "^3.1.10",
     "fast-xml-parser": "^4.5.1",
     "formik": "^2.4.6",
     "glob": "^11.0.1",
+    "handlebars": "^4.7.8",
     "indent-string": "^5.0.0",
     "lodash-es": "^4.17.21",
     "minimatch": "^10.0.1",

package.json

@@ -1,23 +1,40 @@
-import { render } from 'ejs';
+import { create } from 'handlebars';
 import { resolve } from 'path';
 import FileSystem from 'util/FileSystem';
-import Logger from 'util/Logger';
 import { Uri } from 'vscode';
+import Logger from 'util/Logger';
 
 export default class GenerateFromTemplate {
-  public static async generate(template: string, data?: any): Promise<string> {
+  public static async generate(template: string, data?: Record<string, any>): Promise<string> {
     try {
       const templatePath = this.getTemplatePath(template);
       const templateContent = await FileSystem.readFile(Uri.file(templatePath));
-      const content = render(templateContent, data);
+      const handlebars = create();
+      this.registerHelpers(handlebars);
+      this.registerPartials(handlebars);
+      const compiledTemplate = handlebars.compile(templateContent);
+      const content = compiledTemplate(data);
       return content;
     } catch (error) {
-      console.error(error);
+      Logger.log('Failed to generate template', String(error));
       throw error;
     }
   }
 
   protected static getTemplatePath(templateName: string): string {
-    return resolve(FileSystem.getExtensionPath('templates'), templateName + '.ejs');
+    return resolve(FileSystem.getExtensionPath('templates/handlebars'), templateName + '.hbs');
+  }
+
+  protected static registerHelpers(handlebars: typeof Handlebars): void {
+    handlebars.registerHelper('ifeq', (a: string, b: string, options: any) => {
+      if (a === b) {
+        return options.fn(this);
+      }
+      return options.inverse(this);
+    });
+  }
+
+  protected static registerPartials(handlebars: typeof Handlebars): void {
+    handlebars.registerPartial('fileHeader', '{{#if fileHeader}}\n{{{fileHeader}}}\n{{/if}}');
   }
 }

src/generator/util/GenerateFromTemplate.ts

@@ -1,4 +1,4 @@
-Copyright © <%= year %>-present <%= copyright %>
+Copyright © {{ year }}-present {{ copyright }}
 
     Permission is hereby granted, free of charge, to any person obtaining a copy
     of this software and associated documentation files (the "Software"), to deal

templates/graphqls/blank-schema.ejs renamed to templates/handlebars/graphql/blank-schema.hbs

@@ -0,0 +1,8 @@
+<?php
+
+{{> fileHeader}}
+declare(strict_types=1);
+
+use Magento\Framework\Component\ComponentRegistrar;
+
+ComponentRegistrar::register(ComponentRegistrar::MODULE, '{{ vendor }}_{{ module }}', __DIR__);

templates/license/apache2.ejs renamed to templates/handlebars/license/apache2.hbs

@@ -1,7 +1,5 @@
 <?xml version="1.0"?>
-<% if (fileHeader) { -%>
-<%- fileHeader %>
-<% } -%>
+{{> fileHeader}}
 <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:noNamespaceSchemaLocation="urn:magento:framework:Acl/etc/acl.xsd">
 </config>