initial impl with wontache

Author: rtfpessoa

package.json

@@ -82,7 +82,7 @@
   },
   "dependencies": {
     "diff": "5.1.0",
-    "hogan.js": "3.0.2"
+    "wontache": "^0.1.0"
   },
   "optionalDependencies": {
     "highlight.js": "11.6.0"

scripts/hulk.ts

@@ -1,3 +1,5 @@
+// eslint-disable-next-line @typescript-eslint/triple-slash-reference
+/// <reference path="../typings/wontache/wontache.d.ts" />
 /*
  *  Copyright 2011 Twitter, Inc.
  *  Licensed under the Apache License, Version 2.0 (the "License");
@@ -16,7 +18,7 @@
 import * as path from 'path';
 import * as fs from 'fs';
 
-import * as hogan from 'hogan.js';
+import mustache from 'wontache';
 import nopt from 'nopt';
 import * as mkderp from 'mkdirp';
 
@@ -107,25 +109,20 @@ function removeByteOrderMark(text: string): string {
 }
 
 // Wrap templates
-function wrap(file: string, name: string, openedFile: string): string {
-  const hoganTemplateString = `new Hogan.Template(${hogan.compile(openedFile, { asString: true })})`;
+function wrap(name: string, openedFile: string): string {
+  const templateString = mustache(openedFile).source;
 
   const objectName = options.variable || 'templates';
   const objectAccessor = `${objectName}["${name}"]`;
-  const objectStmt = `${objectAccessor} = ${hoganTemplateString};`;
+  const objectStmt = `${objectAccessor} = ${templateString};`;
 
   switch (options.wrapper) {
-    case 'amd':
-      return `define(${
-        !options.outputdir ? `"${path.join(path.dirname(file), name)}", ` : ''
-      }["hogan.js"], function(Hogan) { return ${hoganTemplateString}; });`;
-
     case 'node':
       // If we have a template per file the export will expose the template directly
       return options.outputdir ? `global.${objectStmt};\nmodule.exports = ${objectAccessor};` : `global.${objectStmt}`;
 
     case 'ts':
-      return `// @ts-ignore\n${objectStmt}`;
+      return `// eslint-disable-next-line @typescript-eslint/ban-ts-comment\n// @ts-ignore\n${objectStmt}`;
     default:
       return objectStmt;
   }
@@ -137,16 +134,18 @@ function prepareOutput(content: string): string {
     case 'amd':
       return content;
     case 'node':
-      return `(function() {
+      return `const mustache = require('wontache');
+(function() {
 if (!!!global.${variableName}) global.${variableName} = {};
-var Hogan = require("hogan.js");
 ${content}
 ${!options.outputdir ? `module.exports = global.${variableName};\n` : ''})();`;
 
     case 'ts':
-      return `import * as Hogan from "hogan.js";
-type CompiledTemplates = { [name: string]: Hogan.Template };
-export const ${variableName}: CompiledTemplates = {};
+      return `/* eslint-disable @typescript-eslint/no-unused-vars */
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-nocheck
+import mustache, { CompiledTemplate } from 'wontache';
+export const defaultTemplates: { [_: string]: CompiledTemplate } = {};
 ${content}`;
 
     default:
@@ -172,7 +171,7 @@ const templates = extractFiles(options.argv.remain)
     if (!timmedFileContents) return;
 
     const name = namespace(path.basename(file).replace(/\..*$/, ''));
-    const cleanFileContents = wrap(file, name, removeByteOrderMark(timmedFileContents));
+    const cleanFileContents = wrap(name, removeByteOrderMark(timmedFileContents));
 
     if (!options.outputdir) return cleanFileContents;
 

src/hoganjs-utils.ts

@@ -1,4 +1,4 @@
-import * as Hogan from 'hogan.js';
+import mustache, { CompiledTemplate, Partials } from 'wontache';
 
 import { defaultTemplates } from './diff2html-templates';
 
@@ -7,7 +7,7 @@ export interface RawTemplates {
 }
 
 export interface CompiledTemplates {
-  [name: string]: Hogan.Template;
+  [name: string]: CompiledTemplate;
 }
 
 export interface HoganJsUtilsConfig {
@@ -21,7 +21,7 @@ export default class HoganJsUtils {
   constructor({ compiledTemplates = {}, rawTemplates = {} }: HoganJsUtilsConfig) {
     const compiledRawTemplates = Object.entries(rawTemplates).reduce<CompiledTemplates>(
       (previousTemplates, [name, templateString]) => {
-        const compiledTemplate: Hogan.Template = Hogan.compile(templateString, { asString: false });
+        const compiledTemplate: CompiledTemplate = mustache(templateString);
         return { ...previousTemplates, [name]: compiledTemplate };
       },
       {},
@@ -30,21 +30,21 @@ export default class HoganJsUtils {
     this.preCompiledTemplates = { ...defaultTemplates, ...compiledTemplates, ...compiledRawTemplates };
   }
 
-  static compile(templateString: string): Hogan.Template {
-    return Hogan.compile(templateString, { asString: false });
+  static compile(templateString: string): CompiledTemplate {
+    return mustache(templateString);
   }
 
-  render(namespace: string, view: string, params: Hogan.Context, partials?: Hogan.Partials, indent?: string): string {
+  render(namespace: string, view: string, params: object, partials?: Partials): string {
     const templateKey = this.templateKey(namespace, view);
     try {
       const template = this.preCompiledTemplates[templateKey];
-      return template.render(params, partials, indent);
+      return template(params, { partials });
     } catch (e) {
       throw new Error(`Could not find template to render '${templateKey}'`);
     }
   }
 
-  template(namespace: string, view: string): Hogan.Template {
+  template(namespace: string, view: string): CompiledTemplate {
     return this.preCompiledTemplates[this.templateKey(namespace, view)];
   }
 

src/line-by-line-renderer.ts

@@ -63,17 +63,19 @@ export default class LineByLineRenderer {
     const fileIconTemplate = this.hoganUtils.template(iconsBaseTemplatesPath, 'file');
     const fileTagTemplate = this.hoganUtils.template(tagsBaseTemplatesPath, renderUtils.getFileIcon(file));
 
-    return fileDiffTemplate.render({
+    return fileDiffTemplate({
       file: file,
       fileHtmlId: renderUtils.getHtmlId(file),
       diffs: diffs,
-      filePath: filePathTemplate.render(
+      filePath: filePathTemplate(
         {
           fileDiffName: renderUtils.filenameDiff(file),
         },
         {
-          fileIcon: fileIconTemplate,
-          fileTag: fileTagTemplate,
+          partials: {
+            fileIcon: fileIconTemplate,
+            fileTag: fileTagTemplate,
+          },
         },
       ),
     });

src/side-by-side-renderer.ts

@@ -63,17 +63,19 @@ export default class SideBySideRenderer {
     const fileIconTemplate = this.hoganUtils.template(iconsBaseTemplatesPath, 'file');
     const fileTagTemplate = this.hoganUtils.template(tagsBaseTemplatesPath, renderUtils.getFileIcon(file));
 
-    return fileDiffTemplate.render({
+    return fileDiffTemplate({
       file: file,
       fileHtmlId: renderUtils.getHtmlId(file),
       diffs: diffs,
-      filePath: filePathTemplate.render(
+      filePath: filePathTemplate(
         {
           fileDiffName: renderUtils.filenameDiff(file),
         },
         {
-          fileIcon: fileIconTemplate,
-          fileTag: fileTagTemplate,
+          partials: {
+            fileIcon: fileIconTemplate,
+            fileTag: fileTagTemplate,
+          },
         },
       ),
     });

typings/wontache/wontache.d.ts

@@ -0,0 +1,13 @@
+declare module 'wontache' {
+  export default function compile(template: string | object): CompiledTemplate;
+  type Partials = {
+    [_: string]: string | object;
+  };
+  type Options = {
+    partials?: Partials;
+  };
+  interface CompiledTemplate {
+    (data: object, opt?: Options): string;
+    source: string;
+  }
+}

yarn.lock

@@ -1162,7 +1162,7 @@
   resolved "https://registry.yarnpkg.com/@xtuc/long/-/long-4.2.2.tgz#d291c6a4e97989b5c61d9acf396ae4fe133a718d"
   integrity sha512-NuHqBY1PB/D8xU6s/thBgOAiAP7HOYDQ32+BFZILJ8ivkUkAHQnWfn6WhL79Owj1qmUnoN/YPhktdIoucipkAQ==
 
-abbrev@1, abbrev@^1.0.0:
+abbrev@^1.0.0:
   version "1.1.1"
   resolved "https://registry.yarnpkg.com/abbrev/-/abbrev-1.1.1.tgz#f8f2c887ad10bf67f634f005b6987fed3179aac8"
   integrity sha512-nne9/IiQ/hzIhY6pdDnbBtz7DjPTKrY00P/zvPSm5pOFkl6xuGrGnXn/VtTNNfNtAfZ9/1RtehkszU9qcTii0Q==
@@ -3485,14 +3485,6 @@ [email protected]:
   resolved "https://registry.yarnpkg.com/highlight.js/-/highlight.js-11.6.0.tgz#a50e9da05763f1bb0c1322c8f4f755242cff3f5a"
   integrity sha512-ig1eqDzJaB0pqEvlPVIpSSyMaO92bH1N2rJpLMN/nX396wTpDA4Eq0uK+7I/2XG17pFaaKE0kjV/XPeGt7Evjw==
 
-[email protected]:
-  version "3.0.2"
-  resolved "https://registry.yarnpkg.com/hogan.js/-/hogan.js-3.0.2.tgz#4cd9e1abd4294146e7679e41d7898732b02c7bfd"
-  integrity sha512-RqGs4wavGYJWE07t35JQccByczmNUXQT0E12ZYV1VKYu5UiAU9lsos/yBAcf840+zrUQQxgVduCR5/B8nNtibg==
-  dependencies:
-    mkdirp "0.3.0"
-    nopt "1.0.10"
-
 html-escaper@^2.0.0:
   version "2.0.2"
   resolved "https://registry.yarnpkg.com/html-escaper/-/html-escaper-2.0.2.tgz#dfd60027da36a36dfcbe236262c00a5822681453"
@@ -4869,11 +4861,6 @@ mixin-deep@^1.1.3:
     for-in "^1.0.2"
     is-extendable "^1.0.1"
 
-[email protected]:
-  version "0.3.0"
-  resolved "https://registry.yarnpkg.com/mkdirp/-/mkdirp-0.3.0.tgz#1bbf5ab1ba827af23575143490426455f481fe1e"
-  integrity sha512-OHsdUcVAQ6pOtg5JYWpCBo9W/GySVuwvP9hueRMW7UqshC0tbfzLv8wjySTPm3tfUZ/21CE9E1pJagOA91Pxew==
-
 [email protected]:
   version "1.0.4"
   resolved "https://registry.yarnpkg.com/mkdirp/-/mkdirp-1.0.4.tgz#3eb5ed62622756d79a5f0e2a221dfebad75c2f7e"
@@ -4957,13 +4944,6 @@ node-releases@^2.0.6:
   resolved "https://registry.yarnpkg.com/node-releases/-/node-releases-2.0.6.tgz#8a7088c63a55e493845683ebf3c828d8c51c5503"
   integrity sha512-PiVXnNuFm5+iYkLBNeq5211hvO38y63T0i2KKh2KnUs3RpzJ+JtODFjkD8yjLwnDkTYF1eKXheUwdssR+NRZdg==
 
-[email protected]:
-  version "1.0.10"
-  resolved "https://registry.yarnpkg.com/nopt/-/nopt-1.0.10.tgz#6ddd21bd2a31417b92727dd585f8a6f37608ebee"
-  integrity sha512-NWmpvLSqUrgrAC9HCuxEvb+PSloHpqVu+FqcO4eeF2h5qYRhA7ev6KvelyQAKtegUbC6RypJnlEOhd8vloNKYg==
-  dependencies:
-    abbrev "1"
-
 [email protected]:
   version "6.0.0"
   resolved "https://registry.yarnpkg.com/nopt/-/nopt-6.0.0.tgz#245801d8ebf409c6df22ab9d95b65e1309cdb16d"
@@ -6999,6 +6979,11 @@ unbzip2-stream@^1.0.9:
     buffer "^5.2.1"
     through "^2.3.8"
 
+underscore@^1.13.0-2:
+  version "1.13.4"
+  resolved "https://registry.yarnpkg.com/underscore/-/underscore-1.13.4.tgz#7886b46bbdf07f768e0052f1828e1dcab40c0dee"
+  integrity sha512-BQFnUDuAQ4Yf/cYY5LNrK9NCJFKriaRbD9uR1fTeXnBeoa97W0i41qkZfGO9pSo8I5KzjAcSY2XYtdf0oKd7KQ==
+
 universalify@^2.0.0:
   version "2.0.0"
   resolved "https://registry.yarnpkg.com/universalify/-/universalify-2.0.0.tgz#75a4984efedc4b08975c5aeb73f530d02df25717"
@@ -7241,6 +7226,13 @@ wildcard@^2.0.0:
   resolved "https://registry.yarnpkg.com/wildcard/-/wildcard-2.0.0.tgz#a77d20e5200c6faaac979e4b3aadc7b3dd7f8fec"
   integrity sha512-JcKqAHLPxcdb9KM49dufGXn2x3ssnfjbcaQdLlfZsL9rH9wgDQjUtDxbo8NE0F6SFvydeu1VhZe7hZuHsB2/pw==
 
+wontache@^0.1.0:
+  version "0.1.0"
+  resolved "https://registry.yarnpkg.com/wontache/-/wontache-0.1.0.tgz#125154b1c01e2bb15bae0924f4e96de11c282945"
+  integrity sha512-UH4ikvEVRtvqY3DoW9/NjctB11FDuHjkKPO1tjaUVIVnZevxNtvba7lhR7H5TfMBVCpF2jwxH1qlu0UQSQ/zCw==
+  dependencies:
+    underscore "^1.13.0-2"
+
 word-wrap@^1.2.3:
   version "1.2.3"
   resolved "https://registry.yarnpkg.com/word-wrap/-/word-wrap-1.2.3.tgz#610636f6b1f703891bd34771ccb17fb93b47079c"