@jaredwray/fumanchu 3.0.2 → 3.0.4

package/README.md

@@ -10,28 +10,7 @@ Handlebars + Helpers Together
 [![GitHub license](https://img.shields.io/github/license/jaredwray/fumanchu)](https://github.com/jaredwray/fumanchu/blob/master/LICENSE)
 [![npm](https://img.shields.io/npm/dm/@jaredwray/fumanchu)](https://npmjs.com/package/@jaredwray/fumanchu)
 
-[Handlebars](https://github.com/handlebars-lang/handlebars.js) + [Handlebars-helpers](https://github.com/helpers/handlebars-helpers) (helpers are now maintained in this project) combined into a single package. Easily use in your nodejs as it is a drop in replacement when using handlebars directly.
-
-We plan to make significant changes over time with this project such as the following:
-- **(Completed)** Remove all dependencies on `handlebars-helpers` and maintain all helpers in this project
-- **(Completed)** Migration to `vitest` as a testing framework
-- **(Completed)** Migration to `xo` as a linting framework
-- **(In Progress)** Migrate to Typescript with full typing support
-- **(In Progress)** Replace module dependencies that are no longer supported with supported ones
-- Migration to ESM and CJS support using cross compatible code
-- Move to better documentation and examples where it makes sense
-- Add in browser support via CDN (this will remove the nodejs specific helpers)
-
-# Breaking Changes from v2 to v3
-
-Because of the complexity in the legacy helpers library we have moved to exporting the libraries and a helper function to make it easier to use. Here are the exports:
-
-- `handlebars` - This is an instance of handlebars library without any helpers. It is the same as calling `Handlebars.create()`
-- `helpers` - This is a function that takes an object with a `handlebars` key and adds all the helpers to the handlebars instance. This is the same as calling `helpers({ handlebars: handlebars }, { ..options })`
-- `createHandlebars` - This is an async function that returns a handlebars instance with all the helpers added. This is the same as calling `helpers({ handlebars: handlebars }, { ..options })` but async.
-- `Handlebars` - This is the handlebars library itself. It is the same as calling `require('handlebars')`
-
-Please see the examples below for how to use the library.
+[Handlebars](https://github.com/handlebars-lang/handlebars.js) + [Handlebars-helpers](https://github.com/helpers/handlebars-helpers) (helpers are now maintained in this project) combined into a single package. Easily use it as a drop in replacement when using handlebars directly.
 
 # Table of Contents
 * [Using in Nodejs](#using-in-nodejs)
@@ -130,39 +109,6 @@ Currently **189 helpers** in **20 categories**:
 
 # All helpers
 
-### [array helpers](#array)
-
-Visit the: [code](lib/array.js) | [unit tests](test/array.js) | [issues](https://github.com/jonathas/handlebars-helpers/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+array+helpers))
-
-* **[after](#after)** ([code](lib/array.js#L22) | [tests](test/array.js#L13))
-* **[arrayify](#arrayify)** ([code](lib/array.js#L39) | [tests](test/array.js#L29))
-* **[before](#before)** ([code](lib/array.js#L58) | [tests](test/array.js#L36))
-* **[eachIndex](#eachIndex)** ([code](lib/array.js#L77) | [tests](test/array.js#L58))
-* **[filter](#filter)** ([code](lib/array.js#L102) | [tests](test/array.js#L91))
-* **[first](#first)** ([code](lib/array.js#L142) | [tests](test/array.js#L65))
-* **[forEach](#forEach)** ([code](lib/array.js#L184) | [tests](test/array.js#L123))
-* **[inArray](#inArray)** ([code](lib/array.js#L224) | [tests](test/array.js#L160))
-* **[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) | [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) | [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))
-* **[withAfter](#withAfter)** ([code](lib/array.js#L588) | [tests](test/array.js#L390))
-* **[withBefore](#withBefore)** ([code](lib/array.js#L618) | [tests](test/array.js#L397))
-* **[withFirst](#withFirst)** ([code](lib/array.js#L648) | [tests](test/array.js#L404))
-* **[withGroup](#withGroup)** ([code](lib/array.js#L692) | [tests](test/array.js#L418))
-* **[withLast](#withLast)** ([code](lib/array.js#L727) | [tests](test/array.js#L428))
-* **[withSort](#withSort)** ([code](lib/array.js#L766) | [tests](test/array.js#L442))
-* **[unique](#unique)** ([code](lib/array.js#L816) | [tests](test/array.js#L483))
-
 ### [code helpers](#code)
 
 Visit the: [code](lib/code.js) | [unit tests](test/code.js) | [issues](https://github.com/jonathas/handlebars-helpers/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+code+helpers))
@@ -417,552 +363,7 @@ Visit the: [code](lib/url.js) | [unit tests](test/url.js) | [issues](https://git
 * **[stripQuerystring](#stripQuerystring)** ([code](lib/url.js#L106) | [tests](test/url.js#L24))
 * **[stripProtocol](#stripProtocol)** ([code](lib/url.js#L126) | [tests](test/url.js#L53))
 
-***
-
-## array
-
-### [{{after}}](lib/array.js#L22)
-
-Returns all of the items in an array after the specified index. Opposite of [before](#before).
-
-**Params**
-
-* `array` **{Array}**: Collection
-* `n` **{Number}**: Starting index (number of items to exclude)
-* `returns` **{Array}**: Array exluding `n` items.
-
-**Example**
-
-```html
-<!-- array: ['a', 'b', 'c'] -->
-{{after array 1}}
-<!-- results in: '["c"]' -->
-```
-
-### [{{arrayify}}](lib/array.js#L39)
-
-Cast the given `value` to an array.
-
-**Params**
-
-* `value` **{any}**
-* `returns` **{Array}**
-
-**Example**
-
-```html
-{{arrayify "foo"}}
-<!-- results in: [ "foo" ] -->
-```
-
-### [{{before}}](lib/array.js#L58)
-
-Return all of the items in the collection before the specified count. Opposite of [after](#after).
-
-**Params**
-
-* `array` **{Array}**
-* `n` **{Number}**
-* `returns` **{Array}**: Array excluding items after the given number.
-
-**Example**
-
-```html
-<!-- array: ['a', 'b', 'c'] -->
-{{before array 2}}
-<!-- results in: '["a", "b"]' -->
-```
-
-### [{{eachIndex}}](lib/array.js#L77)
-
-**Params**
-
-* `array` **{Array}**
-* `options` **{Object}**
-* `returns` **{String}**
-
-**Example**
-
-```html
-<!-- array: ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h'] -->
-{{#eachIndex array}}
-  {{item}} is {{index}}
-{{/eachIndex}}
-```
-
-### [{{filter}}](lib/array.js#L102)
-
-Block helper that filters the given array and renders the block for values that evaluate to `true`, otherwise the inverse block is returned.
-
-**Params**
-
-* `array` **{Array}**
-* `value` **{any}**
-* `options` **{Object}**
-* `returns` **{String}**
-
-**Example**
-
-```html
-<!-- array: ['a', 'b', 'c'] -->
-{{#filter array "foo"}}AAA{{else}}BBB{{/filter}}
-<!-- results in: 'BBB' -->
-```
-
-### [{{first}}](lib/array.js#L142)
-
-Returns the first item, or first `n` items of an array.
-
-**Params**
-
-* `array` **{Array}**
-* `n` **{Number}**: Number of items to return, starting at `0`.
-* `returns` **{Array}**
-
-**Example**
-
-```html
-{{first "['a', 'b', 'c', 'd', 'e']" 2}}
-<!-- results in: '["a", "b"]' -->
-```
-
-### [{{forEach}}](lib/array.js#L184)
-
-Iterates over each item in an array and exposes the current item in the array as context to the inner block. In addition to the current array item, the helper exposes the following variables to the inner block:
-
-* `index`
-* `total`
-* `isFirst`
-* `isLast`
-Also, `@index` is exposed as a private variable, and additional
-private variables may be defined as hash arguments.
-
-**Params**
-
-* `array` **{Array}**
-* `returns` **{String}**
-
-**Example**
-
-```html
-<!-- accounts = [
-{'name': 'John', 'email': 'john@example.com'},
-{'name': 'Malcolm', 'email': 'malcolm@example.com'},
-{'name': 'David', 'email': 'david@example.com'}
-] -->
-
-{{#forEach accounts}}
-  <a href="mailto:{{ email }}" title="Send an email to {{ name }}">
-    {{ name }}
-  </a>{{#unless isLast}}, {{/unless}}
-{{/forEach}}
-```
-
-### [{{inArray}}](lib/array.js#L224)
-
-Block helper that renders the block if an array has the given `value`. Optionally specify an inverse block to render when the array does not have the given value.
-
-**Params**
-
-* `array` **{Array}**
-* `value` **{any}**
-* `options` **{Object}**
-* `returns` **{String}**
-
-**Example**
-
-```html
-<!-- array: ['a', 'b', 'c'] -->
-{{#inArray array "d"}}
-  foo
-{{else}}
-  bar
-{{/inArray}}
-<!-- results in: 'bar' -->
-```
-
-### [{{isArray}}](lib/array.js#L244)
-
-Returns true if `value` is an es5 array.
-
-**Params**
-
-* `value` **{any}**: The value to test.
-* `returns` **{Boolean}**
-
-**Example**
-
-```html
-{{isArray "abc"}}
-<!-- results in: false -->
-
-<!-- array: [1, 2, 3] -->
-{{isArray array}}
-<!-- results in: true -->
-```
-
-### [{{itemAt}}](lib/array.js#L263)
-
-Returns the item from `array` at index `idx`.
-
-**Params**
-
-* `array` **{Array}**
-* `idx` **{Number}**
-* `returns` **{any}** `value`
-
-**Example**
-
-```html
-<!-- array: ['a', 'b', 'c'] -->
-{{itemAt array 1}}
-<!-- results in: 'b' -->
-```
-
-### [{{join}}](lib/array.js#L294)
-
-Join all elements of array into a string, optionally using a given separator.
-
-**Params**
-
-* `array` **{Array}**
-* `separator` **{String}**: The separator to use. Defaults to `,`.
-* `returns` **{String}**
-
-**Example**
-
-```html
-<!-- array: ['a', 'b', 'c'] -->
-{{join array}}
-<!-- results in: 'a, b, c' -->
-
-{{join array '-'}}
-<!-- results in: 'a-b-c' -->
-```
-### [{{equalsLength}}](lib/array.js#L313)
-
-Returns true if the the length of the given `value` is equal
-to the given `length`. Can be used as a block or inline helper.
-
-**Params**
-
-* `value` **{Array|String}**
-* `length` **{Number}**
-* `options` **{Object}**
-* `returns` **{String}**
-
-### [{{last}}](lib/array.js#L349)
-
-Returns the last item, or last `n` items of an array or string. Opposite of [first](#first).
-
-**Params**
-
-* `value` **{Array|String}**: Array or string.
-* `n` **{Number}**: Number of items to return from the end of the array.
-* `returns` **{Array}**
-
-**Example**
-
-```html
-<!-- var value = ['a', 'b', 'c', 'd', 'e'] -->
-
-{{last value}}
-<!-- results in: ['e'] -->
-
-{{last value 2}}
-<!-- results in: ['d', 'e'] -->
-
-{{last value 3}}
-<!-- results in: ['c', 'd', 'e'] -->
-```
-
-### [{{length}}](lib/array.js#L379)
-
-Returns the length of the given string or array.
 
-**Params**
-
-* `value` **{Array|Object|String}**
-* `returns` **{Number}**: The length of the value.
-
-**Example**
-
-```html
-{{length '["a", "b", "c"]'}}
-<!-- results in: 3 -->
-
-<!-- results in: myArray = ['a', 'b', 'c', 'd', 'e']; -->
-{{length myArray}}
-<!-- results in: 5 -->
-
-<!-- results in: myObject = {'a': 'a', 'b': 'b'}; -->
-{{length myObject}}
-<!-- results in: 2 -->
-```
-
-### [{{lengthEqual}}](lib/array.js#L395)
-
-Alias for [equalsLength](#equalsLength)
-
-### [{{map}}](lib/array.js#L414)
-
-Returns a new array, created by calling `function` on each element of the given `array`. For example,
-
-**Params**
-
-* `array` **{Array}**
-* `fn` **{Function}**
-* `returns` **{String}**
-
-**Example**
-
-```html
-<!-- array: ['a', 'b', 'c'], and "double" is a
-fictitious function that duplicates letters -->
-{{map array double}}
-<!-- results in: '["aa", "bb", "cc"]' -->
-```
-
-### [{{pluck}}](lib/array.js#L445)
-
-Map over the given object or array or objects and create an array of values from the given `prop`. Dot-notation may be used (as a string) to get nested properties.
-
-**Params**
-
-* `collection` **{Array|Object}**
-* `prop` **{Function}**
-* `returns` **{String}**
-
-**Example**
-
-```html
-// {{pluck items "data.title"}}
-<!-- results in: '["aa", "bb", "cc"]' -->
-```
-
-### [{{reverse}}](lib/array.js#L473)
-
-Reverse the elements in an array, or the characters in a string.
-
-**Params**
-
-* `value` **{Array|String}**
-* `returns` **{Array|String}**: Returns the reversed string or array.
-
-**Example**
-
-```html
-<!-- value: 'abcd' -->
-{{reverse value}}
-<!-- results in: 'dcba' -->
-<!-- value: ['a', 'b', 'c', 'd'] -->
-{{reverse value}}
-<!-- results in: ['d', 'c', 'b', 'a'] -->
-```
-
-### [{{some}}](lib/array.js#L504)
-
-Block helper that returns the block if the callback returns true for some value in the given array.
-
-**Params**
-
-* `array` **{Array}**
-* `iter` **{Function}**: Iteratee
-* **{Options}**: Handlebars provided options object
-* `returns` **{String}**
-
-**Example**
-
-```html
-<!-- array: [1, 'b', 3] -->
-{{#some array isString}}
-  Render me if the array has a string.
-{{else}}
-  Render me if it doesn't.
-{{/some}}
-<!-- results in: 'Render me if the array has a string.' -->
-```
-
-### [{{sort}}](lib/array.js#L532)
-
-Sort the given `array`. If an array of objects is passed, you may optionally pass a `key` to sort on as the second argument. You may alternatively pass a sorting function as the second argument.
-
-**Params**
-
-* `array` **{Array}**: the array to sort.
-* `key` **{String|Function}**: The object key to sort by, or sorting function.
-
-**Example**
-
-```html
-<!-- array: ['b', 'a', 'c'] -->
-{{sort array}}
-<!-- results in: '["a", "b", "c"]' -->
-```
-
-### [{{sortBy}}](lib/array.js#L557)
-
-Sort an `array`. If an array of objects is passed, you may optionally pass a `key` to sort on as the second argument. You may alternatively pass a sorting function as the second argument.
-
-**Params**
-
-* `array` **{Array}**: the array to sort.
-* `props` **{String|Function}**: One or more properties to sort by, or sorting functions to use.
-
-**Example**
-
-```html
-<!-- array: [{a: 'zzz'}, {a: 'aaa'}] -->
-{{sortBy array "a"}}
-<!-- results in: '[{"a":"aaa"}, {"a":"zzz"}]' -->
-```
-
-### [{{withAfter}}](lib/array.js#L588)
-
-Use the items in the array _after_ the specified index as context inside a block. Opposite of [withBefore](#withBefore).
-
-**Params**
-
-* `array` **{Array}**
-* `idx` **{Number}**
-* `options` **{Object}**
-* `returns` **{Array}**
-
-**Example**
-
-```html
-<!-- array: ['a', 'b', 'c', 'd', 'e'] -->
-{{#withAfter array 3}}
-  {{this}}
-{{/withAfter}}
-<!-- results in: "de" -->
-```
-
-### [{{withBefore}}](lib/array.js#L618)
-
-Use the items in the array _before_ the specified index as context inside a block. Opposite of [withAfter](#withAfter).
-
-**Params**
-
-* `array` **{Array}**
-* `idx` **{Number}**
-* `options` **{Object}**
-* `returns` **{Array}**
-
-**Example**
-
-```html
-<!-- array: ['a', 'b', 'c', 'd', 'e'] -->
-{{#withBefore array 3}}
-  {{this}}
-{{/withBefore}}
-<!-- results in: 'ab' -->
-```
-
-### [{{withFirst}}](lib/array.js#L648)
-
-Use the first item in a collection inside a handlebars block expression. Opposite of [withLast](#withLast).
-
-**Params**
-
-* `array` **{Array}**
-* `idx` **{Number}**
-* `options` **{Object}**
-* `returns` **{String}**
-
-**Example**
-
-```html
-<!-- array: ['a', 'b', 'c'] -->
-{{#withFirst array}}
-  {{this}}
-{{/withFirst}}
-<!-- results in: 'a' -->
-```
-
-### [{{withGroup}}](lib/array.js#L692)
-
-Block helper that groups array elements by given group `size`.
-
-**Params**
-
-* `array` **{Array}**: The array to iterate over
-* `size` **{Number}**: The desired length of each array "group"
-* `options` **{Object}**: Handlebars options
-* `returns` **{String}**
-
-**Example**
-
-```html
-<!-- array: ['a','b','c','d','e','f','g','h'] -->
-{{#withGroup array 4}}
-  {{#each this}}
-    {{.}}
-  {{each}}
-  <br>
-{{/withGroup}}
-<!-- results in: -->
-<!-- 'a','b','c','d'<br> -->
-<!-- 'e','f','g','h'<br> -->
-```
-
-### [{{withLast}}](lib/array.js#L727)
-
-Use the last item or `n` items in an array as context inside a block. Opposite of [withFirst](#withFirst).
-
-**Params**
-
-* `array` **{Array}**
-* `idx` **{Number}**: The starting index.
-* `options` **{Object}**
-* `returns` **{String}**
-
-**Example**
-
-```html
-<!-- array: ['a', 'b', 'c'] -->
-{{#withLast array}}
-  {{this}}
-{{/withLast}}
-<!-- results in: 'c' -->
-```
-
-### [{{withSort}}](lib/array.js#L766)
-
-Block helper that sorts a collection and exposes the sorted collection as context inside the block.
-
-**Params**
-
-* `array` **{Array}**
-* `prop` **{String}**
-* `options` **{Object}**: Specify `reverse="true"` to reverse the array.
-* `returns` **{String}**
-
-**Example**
-
-```html
-<!-- array: ['b', 'a', 'c'] -->
-{{#withSort array}}{{this}}{{/withSort}}
-<!-- results in: 'abc' -->
-```
-
-### [{{unique}}](lib/array.js#L816)
-
-Block helper that return an array with all duplicate values removed. Best used along with a [each](#each) helper.
-
-**Params**
-
-* `array` **{Array}**
-* `options` **{Object}**
-* `returns` **{Array}**
-
-**Example**
-
-```html
-<!-- array: ['a', 'a', 'c', 'b', 'e', 'e'] -->
-{{#each (unique array)}}{{.}}{{/each}}
-<!-- results in: 'acbe' -->
-```
 
 ### [{{embed}}](lib/code.js#L23)
 

package/dist/index.js

@@ -2031,8 +2031,8 @@ var require_helpers = __commonJS({
 });
 
 // src/index.ts
-var src_exports = {};
-__export(src_exports, {
+var index_exports = {};
+__export(index_exports, {
   Handlebars: () => Handlebars,
   HelperRegistry: () => HelperRegistry,
   createHandlebars: () => createHandlebars,
@@ -2040,16 +2040,36 @@ __export(src_exports, {
   handlebars: () => handlebars,
   helpers: () => helpers2
 });
-module.exports = __toCommonJS(src_exports);
+module.exports = __toCommonJS(index_exports);
 var HandlebarsLib = __toESM(require("handlebars"));
 
 // src/helpers/date.ts
+var import_chrono_node = require("chrono-node");
+var import_dayjs = __toESM(require("dayjs"));
 var year = () => (/* @__PURE__ */ new Date()).getFullYear().toString();
+var date = (humanReadableDate, formatString) => {
+  const parsedDate = (0, import_chrono_node.parseDate)(humanReadableDate);
+  if (!parsedDate) {
+    throw new Error(`Unable to parse date: ${humanReadableDate}`);
+  }
+  return (0, import_dayjs.default)(parsedDate).format(formatString);
+};
 var helpers = [
   {
     name: "year",
     category: "date",
     fn: year
+  },
+  {
+    name: "date",
+    category: "date",
+    fn: date
+  },
+  {
+    /* Adding this in for legacy support */
+    name: "moment",
+    category: "date",
+    fn: date
   }
 ];
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@jaredwray/fumanchu",
   "description": "Handlebars + Helpers = Fumanchu",
-  "version": "3.0.2",
+  "version": "3.0.4",
   "homepage": "https://github.com/jaredwray/fumanchu",
   "author": "Jared Wray (me@jaredwray.com)",
   "source": "dist/index.js",
@@ -10,6 +10,7 @@
   "scripts": {
     "test": "xo --fix && vitest run --coverage",
     "test:ci": "xo && vitest run --coverage",
+    "test:all": "npm run test && npm run test:legacy",
     "test:legacy": "npm run build && c8 mocha",
     "test:legacy:ci": "npm run build && c8 --reporter=lcov mocha",
     "build": "rimraf ./dist && tsup ./src/index.ts --format cjs --dts --clean",
@@ -58,10 +59,12 @@
   "dependencies": {
     "arr-flatten": "^1.1.0",
     "array-sort": "^1.0.0",
-    "cacheable": "^1.8.5",
+    "cacheable": "^1.8.10",
+    "chrono-node": "^2.8.0",
     "create-frame": "^1.0.0",
+    "dayjs": "^1.11.13",
     "define-property": "^2.0.2",
-    "ent": "^2.2.1",
+    "ent": "^2.2.2",
     "extend-shallow": "^3.0.2",
     "for-in": "^1.0.2",
     "for-own": "^1.0.0",
@@ -73,7 +76,7 @@
     "handlebars-utils": "^1.0.6",
     "has-value": "^2.0.2",
     "helper-date": "^1.0.1",
-    "highlight.js": "^11.10.0",
+    "highlight.js": "^11.11.1",
     "html-tag": "^2.0.0",
     "is-even": "^1.0.0",
     "is-glob": "^4.0.3",
@@ -90,20 +93,20 @@
     "year": "^0.2.1"
   },
   "devDependencies": {
-    "@vitest/coverage-v8": "^2.1.8",
-    "c8": "^10.1.2",
+    "@vitest/coverage-v8": "^3.1.1",
+    "c8": "^10.1.3",
     "chai": "^4.3.10",
-    "docula": "^0.9.5",
+    "docula": "^0.11.0",
     "engine-handlebars": "^1.1.0",
     "lodash": "^4.17.21",
     "mocha": "^10.8.2",
     "rimraf": "^6.0.1",
     "template-helpers": "^1.0.1",
     "templates": "^1.2.9",
-    "tsup": "^8.3.5",
+    "tsup": "^8.4.0",
     "typecript": "^0.0.1-security",
-    "typescript": "^5.7.2",
-    "vitest": "^2.1.8",
+    "typescript": "^5.8.3",
+    "vitest": "^3.1.1",
     "xo": "^0.60.0"
   },
   "xo": {