@jaredwray/fumanchu 1.3.0 → 1.4.0

package/index.d.ts

@@ -1,3 +1,5 @@
-// index.d.ts
-import * as Handlebars from 'handlebars';
-export = Handlebars;
+import HandlebarsLib from 'handlebars';
+declare const handlebars: typeof HandlebarsLib;
+declare let handlebarHelpers: any;
+export default handlebars;
+export { handlebarHelpers };

package/index.mjs

@@ -2,10 +2,15 @@ import HandlebarsLib from 'handlebars';
 
 const handlebars = HandlebarsLib.create();
 
+// Variable to hold the helpers function
+let handlebarHelpers;
+
 import('./helpers.js').then((module) => {
-    const helpers = module.default;
-    helpers({ handlebars: handlebars });
-    });
+    handlebarHelpers = module.default;
+    handlebarHelpers({ handlebars: handlebars });
+});
 
 // Exporting for ESM
 export default handlebars;
+export { handlebarHelpers };
+

package/lib/markdown.js

@@ -1,7 +1,7 @@
 'use strict';
 const hljs = require('highlight.js');
 const utils = require('handlebars-utils');
-const Remarkable = require('remarkable');
+const {Remarkable} = require('remarkable');
 
 /**
  * Expose markdown `helpers` (for performance we're using getters so
@@ -55,7 +55,7 @@ Object.defineProperty(helpers, 'markdown', {
  * @api public
  */
 
-helpers.md = require('helper-md');
+helpers.md = require('./md.js');
 
 
 helpers.helpersForMarkdown = function(config) {

package/lib/md.js

@@ -0,0 +1,119 @@
+/*!
+ * helper-markdown <https://github.com/jonschlinkert/helper-markdown>
+ *
+ * Copyright (c) 2014 Jon Schlinkert, contributors.
+ * Licensed under the MIT license.
+ */
+
+'use strict';
+
+var fs = require('fs');
+var path = require('path');
+const { Remarkable } = require('remarkable');
+var extend = require('extend-shallow');
+var exists = require('fs-exists-sync');
+var ent = require('ent');
+
+/**
+ * Expose `md` helper
+ */
+
+var helper = module.exports = function(name, options, cb) {
+  if (typeof options === 'function') {
+    cb = options;
+    options = {};
+  }
+
+  if (typeof cb !== 'function') {
+    return helper.sync.apply(this, arguments);
+  }
+
+	/* c8 ignore next 3 */
+  if (typeof this === 'undefined' || typeof this.app === 'undefined') {
+    throw new Error('md async helper expects `app` to be exposed on the context');
+  }
+
+  var opts = extend({cwd: process.cwd()}, this.options, options);
+  opts = extend({}, opts, opts.hash);
+  var md = markdown(opts);
+
+  var filepath = path.resolve(opts.cwd, name);
+  var view;
+  var str = '';
+
+  if (exists(filepath)) {
+    // create a collection to ensure middleware is consistent
+    this.app.create('mdfiles');
+    str = fs.readFileSync(filepath, 'utf8');
+    view = this.app.mdfile(filepath, {path: filepath, content: str});
+  } else {
+    view = this.app.find(name);
+  }
+	 /* c8 ignore next 4 */
+  if (typeof view === 'undefined') {
+    cb(null, '');
+    return;
+  }
+
+  view.content = ent.decode(md.render(view.content));
+  this.app.render(view, this.context, function(err, res) {
+    if (err) return cb(err);
+    cb(null, res.content);
+  });
+};
+
+helper.sync = function(name, options) {
+  var ctx = this || {};
+  var app = ctx.app || {};
+
+  var opts = extend({cwd: process.cwd()}, ctx.options, options);
+  opts = extend({}, opts, opts.hash);
+  var md = markdown(opts);
+
+  var filepath = path.resolve(opts.cwd, name);
+  var view;
+  var html = '';
+  var str = '';
+
+  if (exists(filepath)) {
+    str = fs.readFileSync(filepath, 'utf8');
+    html = ent.decode(md.render(str));
+  } else if (app.views) {
+    view = app.find(name);
+    if (view) {
+      html = view.content = ent.decode(md.render(view.content));
+    }
+  }
+
+  if (view && typeof view.compile === 'function') {
+    view.compile(opts);
+    var data = ctx.cache ? ctx.cache.data : {};
+    ctx = extend({}, data, view.data);
+    return view.fn(ctx);
+  }
+
+  if (typeof this.compile === 'function') {
+    var fn = this.compile(html);
+    return fn(this);
+  }
+  return html;
+};
+
+/**
+ * Shared settings for remarkable
+ *
+ * @param {Object} `options`
+ * @return {Object}
+ * @api private
+ */
+
+function markdown(options) {
+	let optsConfig = options || {};
+	optsConfig.breaks = true;
+	optsConfig.html = true;
+	optsConfig.langPrefix = 'lang-';
+	optsConfig.typographer = false;
+	optsConfig.xhtmlOut = false;
+	const md = new Remarkable(optsConfig);
+	return md;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@jaredwray/fumanchu",
   "description": "Handlebars + Helpers = Fumanchu",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "homepage": "https://github.com/jaredwray/fumanchu",
   "author": "Jared Wray (me@jaredwray.com)",
   "keywords": [
@@ -117,6 +117,7 @@
     "array-sort": "^1.0.0",
     "create-frame": "^1.0.0",
     "define-property": "^2.0.2",
+    "ent": "^2.2.0",
     "falsey": "^1.0.0",
     "for-in": "^1.0.2",
     "for-own": "^1.0.0",
@@ -127,7 +128,6 @@
     "handlebars-utils": "^1.0.6",
     "has-value": "^2.0.2",
     "helper-date": "^1.0.1",
-    "helper-md": "^0.2.2",
     "highlight.js": "^11.9.0",
     "html-tag": "^2.0.0",
     "is-even": "^1.0.0",
@@ -136,18 +136,21 @@
     "kind-of": "^6.0.3",
     "lazy-cache": "^2.0.2",
     "logging-helpers": "^1.0.0",
-    "micromatch": "^4.0.5",
+    "micromatch": "^4.0.7",
     "relative": "^3.0.2",
+    "remarkable": "^2.0.1",
     "striptags": "^3.2.0",
     "to-gfm-code-block": "^0.1.1",
     "year": "^0.2.1"
   },
   "devDependencies": {
-    "c8": "^9.1.0",
+    "c8": "^10.1.2",
     "chai": "^4.3.10",
+    "lodash": "^4.17.21",
     "mocha": "^10.4.0",
-    "rimraf": "^5.0.5",
+    "rimraf": "^5.0.7",
     "template-helpers": "^1.0.1",
-    "templates": "^1.2.9"
+    "templates": "^1.2.9",
+    "typescript": "^5.5.2"
   }
 }