@jaredwray/fumanchu 1.0.2 → 1.1.0

package/README.md

@@ -13,7 +13,7 @@ Handlebars + Helpers Together
 
 ## Table of Contents
 * [Using in Nodejs](#using-in-nodejs)
-* [Using in Browser](#using-in-browser)
+* [Just using Handlebar Helpers](#using-handlebars-helpers)
 * [Helpers](#helpers)
 * [How to Contribute](#how-to-contribute)
 * [License and Copyright](#license-and-copyright)
@@ -21,7 +21,9 @@ Handlebars + Helpers Together
 ## Usage Nodejs
 
 ```bash
-npm install @jaredwray/fumanchu
+npm install @jaredwray/fumanchu --save
+// or
+yarn add @jaredwray/fumanchu
 ```
 
 ```javascript
@@ -33,6 +35,20 @@ console.log(html);
 
 It's just that easy! No need to add Handlebars to your project, it's already included.
 
+## Using Handlebars Helpers
+
+If you only want to use handlebar helpers you can easily do that by doing the following:
+
+```javascript
+var helpers = require('@jaredwray/fumanchu').handlebarHelpers;
+var handlebars = require('handlebars');
+helpers({ handlebars: handlebars });
+var fn = handlebars.compile('{{add value 5}}');
+console.log(fn);
+```
+
+Notice that in this scenario you are accessing helpers via `handlebarHelpers` from `fumanchu` instead of just using handlebars via fumanchu directly.
+
 ## Helpers
 More than 180 Handlebars helpers in ~20 categories. Helpers can be used with Assemble, Generate, Verb, Ghost, gulp-handlebars, grunt-handlebars, consolidate, or any node.js/Handlebars project.
 
@@ -78,13 +94,13 @@ Visit the: [code](lib/array.js) | [unit tests](test/array.js) | [issues](https:/
 * **[isArray](#isArray)** ([code](lib/array.js#L244) | [tests](test/array.js#L172))
 * **[itemAt](#itemAt)** ([code](lib/array.js#L263) | [tests](test/array.js#L182))
 * **[join](#join)** ([code](lib/array.js#L294) | [tests](test/array.js#L225))
-* **[equalsLength](#equalsLength)** ([code](lib/array.js#L313) | [no tests])
+* **[equalsLength](#equalsLength)** ([code](lib/array.js#L313) | [tests](test/array.js#L494))
 * **[last](#last)** ([code](lib/array.js#L349) | [tests](test/array.js#L240))
 * **[length](#length)** ([code](lib/array.js#L379) | [tests](test/array.js#L254))
 * **[lengthEqual](#lengthEqual)** ([code](lib/array.js#L395) | [tests](test/array.js#L254))
 * **[map](#map)** ([code](lib/array.js#L414) | [tests](test/array.js#L266))
 * **[pluck](#pluck)** ([code](lib/array.js#L445) | [tests](test/array.js#L300))
-* **[reverse](#reverse)** ([code](lib/array.js#L473) | [no tests])
+* **[reverse](#reverse)** ([code](lib/array.js#L473) | [tests](test/array.js#L506))
 * **[some](#some)** ([code](lib/array.js#L504) | [tests](test/array.js#L308))
 * **[sort](#sort)** ([code](lib/array.js#L532) | [tests](test/array.js#L333))
 * **[sortBy](#sortBy)** ([code](lib/array.js#L557) | [tests](test/array.js#L358))
@@ -133,7 +149,7 @@ Visit the: [code](lib/comparison.js) | [unit tests](test/comparison.js) | [issue
 * **[lt](#lt)** ([code](lib/comparison.js#L411) | [tests](test/comparison.js#L449))
 * **[lte](#lte)** ([code](lib/comparison.js#L435) | [tests](test/comparison.js#L476))
 * **[neither](#neither)** ([code](lib/comparison.js#L456) | [tests](test/comparison.js#L511))
-* **[not](#not)** ([code](lib/comparison.js#L470) | [no tests])
+* **[not](#not)** ([code](lib/comparison.js#L470) | [tests](test/comparison.js#L624))
 * **[or](#or)** ([code](lib/comparison.js#L492) | [tests](test/comparison.js#L523))
 * **[unlessEq](#unlessEq)** ([code](lib/comparison.js#L518) | [tests](test/comparison.js#L556))
 * **[unlessGt](#unlessGt)** ([code](lib/comparison.js#L538) | [tests](test/comparison.js#L567))
@@ -211,37 +227,37 @@ Visit the: [code](lib/match.js) | [unit tests](test/match.js) | [issues](https:/
 
 * **[match](#match)** ([code](lib/match.js#L23) | [tests](test/match.js#L13))
 * **[isMatch](#isMatch)** ([code](lib/match.js#L47) | [tests](test/match.js#L61))
-* **[mm](#mm)** ([code](lib/match.js#L56) | [no tests])
+* **[mm](#mm)** ([code](lib/match.js#L56) | [tests](test/match.js#L67))
 
 ### [math helpers](#math)
 
 Visit the: [code](lib/math.js) | [unit tests](test/math.js) | [issues](https://github.com/jonathas/handlebars-helpers/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+math+helpers))
 
-* **[abs](#abs)** ([code](lib/math.js#L15) | [no tests])
+* **[abs](#abs)** ([code](lib/math.js#L15) | [test](test/math.js#L149))
 * **[add](#add)** ([code](lib/math.js#L31) | [tests](test/math.js#L10))
-* **[avg](#avg)** ([code](lib/math.js#L54) | [no tests])
+* **[avg](#avg)** ([code](lib/math.js#L54) | [tests](test/math.js#L25))
 * **[ceil](#ceil)** ([code](lib/math.js#L69) | [tests](test/math.js#L29))
 * **[divide](#divide)** ([code](lib/math.js#L84) | [tests](test/math.js#L36))
 * **[floor](#floor)** ([code](lib/math.js#L102) | [tests](test/math.js#L43))
-* **[minus](#minus)** ([code](lib/math.js#L118) | [no tests])
-* **[modulo](#modulo)** ([code](lib/math.js#L137) | [no tests])
+* **[minus](#minus)** ([code](lib/math.js#L118) | [tests](test/math.js#L169))
+* **[modulo](#modulo)** ([code](lib/math.js#L137) | [tests](test/math.js#L191))
 * **[multiply](#multiply)** ([code](lib/math.js#L157) | [tests](test/math.js#L50))
-* **[plus](#plus)** ([code](lib/math.js#L175) | [no tests])
+* **[plus](#plus)** ([code](lib/math.js#L175) | [tests](test/math.js#L231))
 * **[random](#random)** ([code](lib/math.js#L194) | [tests](test/math.js#L102))
 * **[remainder](#remainder)** ([code](lib/math.js#L212) | [tests](test/math.js#L57))
 * **[round](#round)** ([code](lib/math.js#L224) | [tests](test/math.js#L69))
 * **[subtract](#subtract)** ([code](lib/math.js#L241) | [tests](test/math.js#L76))
 * **[sum](#sum)** ([code](lib/math.js#L263) | [tests](test/math.js#L83))
-* **[times](#times)** ([code](lib/math.js#L286) | [no tests])
+* **[times](#times)** ([code](lib/math.js#L286) | [tests](test/math.js#L299))
 
 ### [misc helpers](#misc)
 
 Visit the: [code](lib/misc.js) | [unit tests](test/misc.js) | [issues](https://github.com/jonathas/handlebars-helpers/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+misc+helpers))
 
-* **[frame](#frame)** ([code](lib/misc.js#L11) | [no tests])
+* **[frame](#frame)** ([code](lib/misc.js#L11) | [tests](test/misc.js#L1))
 * **[option](#option)** ([code](lib/misc.js#L26) | [tests](test/misc.js#L20))
 * **[noop](#noop)** ([code](lib/misc.js#L39) | [tests](test/misc.js#L13))
-* **[typeOf](#typeOf)** ([code](lib/misc.js#L59) | [no tests])
+* **[typeOf](#typeOf)** ([code](lib/misc.js#L59) | [tests](test/misc.js#L38))
 * **[withHash](#withHash)** ([code](lib/misc.js#L71) | [tests](test/misc.js#L38))
 
 ### [number helpers](#number)
@@ -287,21 +303,21 @@ Visit the: [code](lib/path.js) | [unit tests](test/path.js) | [issues](https://g
 * **[basename](#basename)** ([code](lib/path.js#L81) | [tests](test/path.js#L47))
 * **[stem](#stem)** ([code](lib/path.js#L100) | [tests](test/path.js#L58))
 * **[extname](#extname)** ([code](lib/path.js#L119) | [tests](test/path.js#L69))
-* **[resolve](#resolve)** ([code](lib/path.js#L138) | [no tests])
+* **[resolve](#resolve)** ([code](lib/path.js#L138) | [tests](test/path.js#L145))
 * **[segments](#segments)** ([code](lib/path.js#L166) | [tests](test/path.js#L80))
 
 ### [regex helpers](#regex)
 
 Visit the: [code](lib/regex.js) | [unit tests](test/regex.js) | [issues](https://github.com/jonathas/handlebars-helpers/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+regex+helpers))
 
-* **[toRegex](#toRegex)** ([code](lib/regex.js#L19) | [no tests])
-* **[test](#test)** ([code](lib/regex.js#L42) | [no tests])
+* **[toRegex](#toRegex)** ([code](lib/regex.js#L19) | [tests](test/regex.js#10))
+* **[test](#test)** ([code](lib/regex.js#L42) | [tests](test/regex.js#15))
 
 ### [string helpers](#string)
 
 Visit the: [code](lib/string.js) | [unit tests](test/string.js) | [issues](https://github.com/jonathas/handlebars-helpers/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+string+helpers))
 
-* **[append](#append)** ([code](lib/string.js#L22) | [no tests])
+* **[append](#append)** ([code](lib/string.js#L22) | [tests](test/string.js#L9))
 * **[camelcase](#camelcase)** ([code](lib/string.js#L41) | [tests](test/string.js#L10))
 * **[capitalize](#capitalize)** ([code](lib/string.js#L60) | [tests](test/string.js#L25))
 * **[capitalizeAll](#capitalizeAll)** ([code](lib/string.js#L77) | [tests](test/string.js#L36))
@@ -309,7 +325,7 @@ Visit the: [code](lib/string.js) | [unit tests](test/string.js) | [issues](https
 * **[chop](#chop)** ([code](lib/string.js#L125) | [tests](test/string.js#L58))
 * **[dashcase](#dashcase)** ([code](lib/string.js#L143) | [tests](test/string.js#L73))
 * **[dotcase](#dotcase)** ([code](lib/string.js#L162) | [tests](test/string.js#L88))
-* **[downcase](#downcase)** ([code](lib/string.js#L182) | [no tests])
+* **[downcase](#downcase)** ([code](lib/string.js#L182) | [tests](test/string.js#L391))
 * **[ellipsis](#ellipsis)** ([code](lib/string.js#L202) | [tests](test/string.js#L103))
 * **[hyphenate](#hyphenate)** ([code](lib/string.js#L223) | [tests](test/string.js#L118))
 * **[isString](#isString)** ([code](lib/string.js#L240) | [tests](test/string.js#L129))
@@ -318,12 +334,12 @@ Visit the: [code](lib/string.js) | [unit tests](test/string.js) | [issues](https
 * **[pascalcase](#pascalcase)** ([code](lib/string.js#L303) | [tests](test/string.js#L173))
 * **[pathcase](#pathcase)** ([code](lib/string.js#L323) | [tests](test/string.js#L188))
 * **[plusify](#plusify)** ([code](lib/string.js#L343) | [tests](test/string.js#L203))
-* **[prepend](#prepend)** ([code](lib/string.js#L363) | [no tests])
-* **[raw](#raw)** ([code](lib/string.js#L385) | [no tests])
-* **[remove](#remove)** ([code](lib/string.js#L413) | [no tests])
-* **[removeFirst](#removeFirst)** ([code](lib/string.js#L432) | [no tests])
+* **[prepend](#prepend)** ([code](lib/string.js#L363) | [tests](test/string.js#L409))
+* **[raw](#raw)** ([code](lib/string.js#L385) | [tests](test/string.js#L465))
+* **[remove](#remove)** ([code](lib/string.js#L413) | [tests](test/string.js#L416)
+* **[removeFirst](#removeFirst)** ([code](lib/string.js#L432) | [tests](test/string.js#L422))
 * **[replace](#replace)** ([code](lib/string.js#L452) | [tests](test/string.js#L222))
-* **[replaceFirst](#replaceFirst)** ([code](lib/string.js#L473) | [no tests])
+* **[replaceFirst](#replaceFirst)** ([code](lib/string.js#L473) | [tests](test/string.js#L428))
 * **[reverse](#reverse)** ([code](lib/string.js#L492) | [tests](test/string.js#L241))
 * **[sentence](#sentence)** ([code](lib/string.js#L509) | [tests](test/string.js#L252))
 * **[snakecase](#snakecase)** ([code](lib/string.js#L528) | [tests](test/string.js#L263))
@@ -331,11 +347,11 @@ Visit the: [code](lib/string.js) | [unit tests](test/string.js) | [issues](https
 * **[startsWith](#startsWith)** ([code](lib/string.js#L572) | [tests](test/string.js#L293))
 * **[titleize](#titleize)** ([code](lib/string.js#L596) | [tests](test/string.js#L312))
 * **[trim](#trim)** ([code](lib/string.js#L623) | [tests](test/string.js#L323))
-* **[trimLeft](#trimLeft)** ([code](lib/string.js#L639) | [no tests])
-* **[trimRight](#trimRight)** ([code](lib/string.js#L657) | [no tests])
+* **[trimLeft](#trimLeft)** ([code](lib/string.js#L639) | [tests](test/string.js#L436))
+* **[trimRight](#trimRight)** ([code](lib/string.js#L657) | [tests](test/string.js#L441))
 * **[truncate](#truncate)** ([code](lib/string.js#L680) | [tests](test/string.js#L338))
-* **[truncateWords](#truncateWords)** ([code](lib/string.js#L712) | [no tests])
-* **[upcase](#upcase)** ([code](lib/string.js#L742) | [no tests])
+* **[truncateWords](#truncateWords)** ([code](lib/string.js#L712) | [tests](test/string.js#L447)))
+* **[upcase](#upcase)** ([code](lib/string.js#L742) | [tests](test/string.js#458))
 * **[uppercase](#uppercase)** ([code](lib/string.js#L763) | [tests](test/string.js#L362))
 
 ### [url helpers](#url)
@@ -343,14 +359,14 @@ Visit the: [code](lib/string.js) | [unit tests](test/string.js) | [issues](https
 Visit the: [code](lib/url.js) | [unit tests](test/url.js) | [issues](https://github.com/jonathas/handlebars-helpers/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+url+helpers))
 
 * **[encodeURI](#encodeURI)** ([code](lib/url.js#L19) | [tests](test/url.js#L31))
-* **[escape](#escape)** ([code](lib/url.js#L34) | [no tests])
+* **[escape](#escape)** ([code](lib/url.js#L34) | [tests](test/url.js#L81))
 * **[decodeURI](#decodeURI)** ([code](lib/url.js#L48) | [tests](test/url.js#L38))
-* **[url_encode](#url_encode)** ([code](lib/url.js#L59) | [no tests])
-* **[url_decode](#url_decode)** ([code](lib/url.js#L68) | [no tests])
+* **[url_encode](#url_encode)** ([code](lib/url.js#L59) | [tests](test/url.js#L89))
+* **[url_decode](#url_decode)** ([code](lib/url.js#L68) | [tests](test/url.js#L93))
 * **[urlResolve](#urlResolve)** ([code](lib/url.js#L82) | [tests](test/url.js#L11))
 * **[urlParse](#urlParse)** ([code](lib/url.js#L94) | [tests](test/url.js#L45))
 * **[stripQuerystring](#stripQuerystring)** ([code](lib/url.js#L106) | [tests](test/url.js#L24))
-* **[stripProtocol](#stripProtocol)** ([code](lib/url.js#L126) | [no tests])
+* **[stripProtocol](#stripProtocol)** ([code](lib/url.js#L126) | [tests](test/url.js#L53))
 
 ***
 

package/index.d.ts

@@ -1,16 +1,3 @@
 // index.d.ts
-
-// Importing types from the handlebars package
-import { Handlebars } from 'handlebars';
-
-// Assuming helpers.js exports a function. Adjust as needed.
-interface HelpersFunction {
-    (config: { handlebars: typeof Handlebars }): void;
-}
-
-// Since you're exporting the handlebars instance itself:
-declare const handlebars: typeof Handlebars;
-
-export = handlebars;
-
-
+import * as Handlebars from 'handlebars';
+export = Handlebars;

package/index.js

@@ -5,3 +5,4 @@ const handlebars = HandlebarsLib.create();
 helpers({ handlebars: handlebars });
 
 module.exports = handlebars;
+module.exports.handlebarHelpers = helpers;

package/lib/math.js

@@ -32,9 +32,6 @@ helpers.add = function(a, b) {
   if (isNumber(a) && isNumber(b)) {
     return Number(a) + Number(b);
   }
-  if (typeof a === 'string' && typeof b === 'string') {
-    return a + b;
-  }
   return '';
 };
 

package/lib/path.js

@@ -5,6 +5,15 @@ var path = require('path');
 var utils = require('./utils');
 var helpers = module.exports;
 
+utils.expectedType = (variableName, expectedType, variableValue) => {
+  const actualType = Object.prototype.toString.call(variableValue).slice(8, -1).toLowerCase();
+
+  if (actualType !== expectedType) {
+      throw new TypeError(`Expected ${variableName} to be of type ${expectedType}, but got ${actualType}`);
+  }
+};
+
+
 /**
  * Get the directory path segment from the given `filepath`.
  *

package/lib/regex.js

@@ -43,7 +43,7 @@ helpers.test = function(str, regex) {
   if (!util.isString(str)) {
     return false;
   }
-  if (!utils.typeOf(regex) === 'regexp') {
+  if (utils.typeOf(regex) !== 'regexp') {
     throw new TypeError('expected a regular expression');
   }
   return regex.test(str);

package/lib/string.js

@@ -460,7 +460,7 @@ helpers.replace = function(str, a, b) {
  * Replace the first occurrence of substring `a` with substring `b`.
  *
  * ```handlebars
- * {{replace "a b a b a b" "a" "z"}}
+ * {{replaceFirst "a b a b a b" "a" "z"}}
  * <!-- results in:  'z b a b a b' -->
  * ```
  * @param {String} `str`
@@ -695,9 +695,9 @@ helpers.truncate = function(str, limit, suffix) {
  *
  * ```handlebars
  * truncateWords("foo bar baz", 1);
- * <!-- results in:  'foo…' -->
+ * <!-- results in:  'foo...' -->
  * truncateWords("foo bar baz", 2);
- * <!-- results in:  'foo bar…' -->
+ * <!-- results in:  'foo bar...' -->
  * truncateWords("foo bar baz", 3);
  * <!-- results in:  'foo bar baz' -->
  * ```
@@ -712,12 +712,12 @@ helpers.truncate = function(str, limit, suffix) {
 helpers.truncateWords = function(str, count, suffix) {
   if (util.isString(str) && isNumber(count)) {
     if (typeof suffix !== 'string') {
-      suffix = '…';
+      suffix = '...';
     }
 
     var num = Number(count);
-    var arr = str.split(/[ \t]/);
-    if (num > arr.length) {
+    var arr = str.split(' ');
+    if (num < arr.length) {
       arr = arr.slice(0, num);
     }
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@jaredwray/fumanchu",
   "description": "Handlebars + Helpers = Fumanchu",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "homepage": "https://github.com/jaredwray/fumanchu",
   "author": "Jared Wray (me@jaredwray.com)",
   "keywords": [
@@ -97,15 +97,13 @@
   "source": "index.js",
   "main": "index.js",
   "types": "index.d.ts",
-  "browser": "dist/fumanchu.min.js",
   "engines": {
     "node": ">=14"
   },
   "scripts": {
     "test": "c8 mocha --reporter list",
     "test:ci": "c8 --reporter=lcov mocha --reporter list",
-    "build": "parcel build --dist-dir dist",
-    "clean": "rm -rf node_modules && rm -rf dist && rm -rf .parcel-cache"
+    "clean": "rm -rf node_modules && rm -rf coverage"
   },
   "dependencies": {
     "arr-flatten": "^1.1.0",
@@ -138,22 +136,10 @@
     "year": "^0.2.1"
   },
   "devDependencies": {
-    "@parcel/watcher": "^2.3.0",
     "c8": "^8.0.1",
     "chai": "^4.3.8",
-    "global-modules": "^2.0.0",
     "mocha": "^10.2.0",
-    "parcel": "^2.9.3",
     "template-helpers": "^1.0.1",
     "templates": "^1.2.9"
-  },
-  "browserslist": [
-    "last 1 version",
-    "> 1%",
-    "not dead"
-  ],
-  "targets": {
-    "main": false,
-    "types": false
   }
 }