@formfeed/engine 0.3.2 → 0.3.3

package/index.cjs

@@ -270,6 +270,7 @@ function toDate(value, tz) {
 function escapeHtml(value) {
   return value.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;").replace(/'/g, "&#39;");
 }
+var isNamedArgs = (v) => !!v && typeof v === "object" && !Array.isArray(v) && !(v instanceof Date);
 var str = (v) => v === void 0 || v === null ? "" : String(v);
 var opt = (v, fallback) => v === void 0 || v === null || v === "" ? fallback : v;
 var wordsByLang = {
@@ -304,7 +305,7 @@ var formatHelpers = [
     name: "number",
     doc: {
       signature: "number(value, decimals?, locale?)",
-      description: "Formats a number with grouping and a fixed number of decimals.",
+      description: "Formats a number with grouping. With decimals, exactly that many (rounded half away from zero); without, the decimals the number has, at most three, so 1234.5 \u2192 1.234,5 and 2.34567 \u2192 2,346. Use number(0) for whole numbers.",
       example: "{{ qty | number(2) }} \u2192 1.234,00",
       category: "format"
     },
@@ -398,15 +399,26 @@ var formatHelpers = [
   {
     name: "round",
     doc: {
-      signature: "round(value, decimals = 0)",
-      description: "Rounds half away from zero.",
-      example: "{{ 2.345 | round(2) }} gives 2.35",
+      signature: "round(value, decimals = 0, method = 'common')",
+      description: "Rounds to the given decimals, as Jinja2's round does: 'common' rounds half away from zero, 'floor' always down and 'ceil' always up.",
+      example: "{{ 2.345 | round(2) }} gives 2.35, {{ 2.349 | round(2, 'floor') }} gives 2.34",
       category: "format"
     },
-    fn: (_ctx, value, decimals) => {
+    // `round(2, method='floor')` (Jinja2) and `round: 2, method: 'floor'` (Liquid) arrive as a
+    // trailing object, as does a Handlebars hash
+    fn: (_ctx, value, ...args) => {
       const n = toNumber(value);
-      const f = 10 ** (decimals === void 0 || decimals === null ? 0 : Number(decimals));
-      return Number.isNaN(n) ? "" : Math.round((Math.abs(n) + Number.EPSILON) * f) / f * Math.sign(n);
+      if (Number.isNaN(n)) return "";
+      const named = args.find(isNamedArgs) ?? {};
+      const [decimals, method] = args.filter((a) => !isNamedArgs(a));
+      const places = Number(opt(decimals, opt(named["precision"], opt(named["decimals"], 0))));
+      const how = String(opt(method, opt(named["method"], "common")));
+      const f = 10 ** places;
+      const scaled = Number((Math.abs(n) * f).toPrecision(15));
+      if (how === "floor") return (n < 0 ? -Math.ceil(scaled) : Math.floor(scaled)) / f;
+      if (how === "ceil") return (n < 0 ? -Math.floor(scaled) : Math.ceil(scaled)) / f;
+      if (how !== "common") throw new Error(`round: method must be 'common', 'floor' or 'ceil', not '${how}'`);
+      return Math.round(scaled + Number.EPSILON) / f * Math.sign(n);
     }
   },
   {

package/index.js

@@ -140,6 +140,7 @@ function toDate(value, tz) {
 function escapeHtml(value) {
   return value.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;").replace(/'/g, "&#39;");
 }
+var isNamedArgs = (v) => !!v && typeof v === "object" && !Array.isArray(v) && !(v instanceof Date);
 var str = (v) => v === void 0 || v === null ? "" : String(v);
 var opt = (v, fallback) => v === void 0 || v === null || v === "" ? fallback : v;
 var wordsByLang = {
@@ -174,7 +175,7 @@ var formatHelpers = [
     name: "number",
     doc: {
       signature: "number(value, decimals?, locale?)",
-      description: "Formats a number with grouping and a fixed number of decimals.",
+      description: "Formats a number with grouping. With decimals, exactly that many (rounded half away from zero); without, the decimals the number has, at most three, so 1234.5 \u2192 1.234,5 and 2.34567 \u2192 2,346. Use number(0) for whole numbers.",
       example: "{{ qty | number(2) }} \u2192 1.234,00",
       category: "format"
     },
@@ -268,15 +269,26 @@ var formatHelpers = [
   {
     name: "round",
     doc: {
-      signature: "round(value, decimals = 0)",
-      description: "Rounds half away from zero.",
-      example: "{{ 2.345 | round(2) }} gives 2.35",
+      signature: "round(value, decimals = 0, method = 'common')",
+      description: "Rounds to the given decimals, as Jinja2's round does: 'common' rounds half away from zero, 'floor' always down and 'ceil' always up.",
+      example: "{{ 2.345 | round(2) }} gives 2.35, {{ 2.349 | round(2, 'floor') }} gives 2.34",
       category: "format"
     },
-    fn: (_ctx, value, decimals) => {
+    // `round(2, method='floor')` (Jinja2) and `round: 2, method: 'floor'` (Liquid) arrive as a
+    // trailing object, as does a Handlebars hash
+    fn: (_ctx, value, ...args) => {
       const n = toNumber(value);
-      const f = 10 ** (decimals === void 0 || decimals === null ? 0 : Number(decimals));
-      return Number.isNaN(n) ? "" : Math.round((Math.abs(n) + Number.EPSILON) * f) / f * Math.sign(n);
+      if (Number.isNaN(n)) return "";
+      const named = args.find(isNamedArgs) ?? {};
+      const [decimals, method] = args.filter((a) => !isNamedArgs(a));
+      const places = Number(opt(decimals, opt(named["precision"], opt(named["decimals"], 0))));
+      const how = String(opt(method, opt(named["method"], "common")));
+      const f = 10 ** places;
+      const scaled = Number((Math.abs(n) * f).toPrecision(15));
+      if (how === "floor") return (n < 0 ? -Math.ceil(scaled) : Math.floor(scaled)) / f;
+      if (how === "ceil") return (n < 0 ? -Math.floor(scaled) : Math.ceil(scaled)) / f;
+      if (how !== "common") throw new Error(`round: method must be 'common', 'floor' or 'ceil', not '${how}'`);
+      return Math.round(scaled + Number.EPSILON) / f * Math.sign(n);
     }
   },
   {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@formfeed/engine",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "description": "The Formfeed template engine (Jinja2, Liquid, Handlebars) for the browser and Node.",
   "license": "MIT",
   "type": "module",