rsformat 0.2.0 → 0.2.2

package/lib/format.d.ts

@@ -5,3 +5,14 @@
  * @param params Parameters to be inserted into the format string
  */
 export declare function format(str: string, ...params: any[]): string;
+/**
+ * Raw formatting behaviour function called by `format` and printing functions.
+ *
+ * @param str String used for formatting
+ * @param params Parameters to be inserted into the format string
+ * @param options Options passed into formatting
+ * @param options.colors Whether to use colors in debug formatting
+ */
+export declare function fmt_raw(str: string, params: any[], options?: {
+    colors: boolean;
+}): string;

package/lib/format.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.format = void 0;
+exports.fmt_raw = exports.format = void 0;
 const node_util_1 = require("node:util");
 /**
  * Regex to match for possible formatting insertion points.
@@ -27,6 +27,18 @@ const FORMAT_REGEX = (/\{{2}|\}{2}|\{(\d*?)(?::(?:(.?)(\^|>|<))?(\+)?(#)?(0)?(\d
  * @param params Parameters to be inserted into the format string
  */
 function format(str, ...params) {
+    return fmt_raw(str, params);
+}
+exports.format = format;
+/**
+ * Raw formatting behaviour function called by `format` and printing functions.
+ *
+ * @param str String used for formatting
+ * @param params Parameters to be inserted into the format string
+ * @param options Options passed into formatting
+ * @param options.colors Whether to use colors in debug formatting
+ */
+function fmt_raw(str, params, options = { colors: false }) {
     // Counter used for insertion of unnumbered values
     let param_counter = 0;
     str = str.replace(FORMAT_REGEX, ($, $param_number, $fill_character, $align_direction, $sign, $pretty, $pad_zeroes, $width, $precision, $type) => {
@@ -45,21 +57,22 @@ function format(str, ...params) {
             throw new Error(`parameter ${$param_number || param_counter - 1} either NaN or not provided`);
         }
         let param_type = typeof param;
+        let true_length = -1;
         // Process parameter type
         switch ($type) {
-            case "o":
+            case 'o':
                 param = param.toString(8);
                 break;
-            case "x":
+            case 'x':
                 param = param.toString(16);
                 break;
-            case "X":
+            case 'X':
                 param = param.toString(16).toUpperCase();
                 break;
-            case "b":
+            case 'b':
                 param = param.toString(2);
                 break;
-            case "e":
+            case 'e':
                 switch (param_type) {
                     case 'number':
                         param = param.toExponential();
@@ -75,7 +88,7 @@ function format(str, ...params) {
                         break;
                 }
                 break;
-            case "E":
+            case 'E':
                 switch (param_type) {
                     case 'number':
                         param = param.toExponential().toUpperCase();
@@ -91,10 +104,18 @@ function format(str, ...params) {
                         break;
                 }
                 break;
-            case "?":
+            case '?':
+                // Do not force sign or align to precision when using inspect
+                $sign = undefined;
+                $precision = undefined;
+                true_length = (0, node_util_1.inspect)(param, {
+                    depth: Infinity,
+                    colors: false,
+                    compact: $pretty !== '#'
+                }).length;
                 param = (0, node_util_1.inspect)(param, {
                     depth: Infinity,
-                    colors: true,
+                    colors: options.colors,
                     compact: $pretty !== '#'
                 });
                 break;
@@ -103,11 +124,14 @@ function format(str, ...params) {
                 break;
         }
         ;
+        if (true_length == -1) {
+            true_length = param.length;
+        }
         // Compute radix-point precision on numbers
         if (param_type == 'number' && $precision) {
-            let [pre, post] = param.split(".");
+            let [pre, post] = param.split('.');
             if (post === undefined) {
-                post = "";
+                post = '';
             }
             let precision = +$precision.substring(1, $precision.length);
             if (post.length > precision) {
@@ -117,7 +141,7 @@ function format(str, ...params) {
                 while (post.length < precision) {
                     post = post + '0';
                 }
-            param = pre + "." + post;
+            param = pre + '.' + post;
         }
         let width;
         if ($width === undefined) {
@@ -154,34 +178,30 @@ function format(str, ...params) {
             }
             param = maybe_sign + param;
         }
-        if (!filled && width) {
+        if (!filled && width > true_length) {
             // Compute fill/align
             $align_direction ||= '>';
             $fill_character ||= ' ';
+            let left = '';
+            let right = '';
+            let diff = width - true_length;
             switch ($align_direction) {
                 case '>':
-                    while (width - param.length > 0) {
-                        param = $fill_character + param;
-                    }
+                    left = $fill_character.repeat(diff);
                     break;
                 case '<':
-                    while (width - param.length > 0) {
-                        param = param + $fill_character;
-                    }
+                    right = $fill_character.repeat(diff);
                     break;
                 case '^':
-                    while (width - param.length > 1) {
-                        param = $fill_character + param + $fill_character;
-                    }
-                    // Prioritise right-aligment on uneven alignment
-                    if (width - param.length == 1) {
-                        param = $fill_character + param;
-                    }
+                    left = $fill_character.repeat(diff - diff / 2);
+                    // Prioritise right-aligment on uneven length
+                    right = $fill_character.repeat(diff / 2 + diff % 2);
                     break;
             }
+            param = left + param + right;
         }
         return param;
     });
     return str;
 }
-exports.format = format;
+exports.fmt_raw = fmt_raw;

package/lib/print.js

@@ -16,7 +16,7 @@ function Printer(outStream = node_process_1.default.stdout, errStream = node_pro
          * @param params Parameters to be inserted into the format string
          */
         print: function print(format_string, ...params) {
-            outStream.write((0, format_1.format)(format_string, ...params));
+            outStream.write((0, format_1.fmt_raw)(format_string, params, { colors: true }));
         },
         /**
          * Print a format string to an output stream (usually process.stdout)
@@ -26,7 +26,7 @@ function Printer(outStream = node_process_1.default.stdout, errStream = node_pro
          * @param params Parameters to be inserted into the format string
          */
         println: function println(format_string, ...params) {
-            outStream.write((0, format_1.format)(format_string, ...params) + "\n");
+            outStream.write((0, format_1.fmt_raw)(format_string, params, { colors: true }) + '\n');
         },
         /**
          * Print a format string to an error stream (usually process.stderr).
@@ -35,7 +35,7 @@ function Printer(outStream = node_process_1.default.stdout, errStream = node_pro
          * @param params Parameters to be inserted into the format string
          */
         eprint: function eprint(format_string, ...params) {
-            errStream.write((0, format_1.format)(format_string, ...params));
+            errStream.write((0, format_1.fmt_raw)(format_string, params, { colors: true }));
         },
         /**
          * Print a format string to an error stream (usually process.stderr)
@@ -45,7 +45,7 @@ function Printer(outStream = node_process_1.default.stdout, errStream = node_pro
          * @param params Parameters to be inserted into the format string
          */
         eprintln: function eprintln(format_string, ...params) {
-            errStream.write((0, format_1.format)(format_string, ...params) + "\n");
+            errStream.write((0, format_1.fmt_raw)(format_string, params, { colors: true }) + '\n');
         },
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rsformat",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "Formatting/printing library for JavaScript that takes after rust's string formatting ",
   "files": [
     "lib",
@@ -16,10 +16,6 @@
       "default": "./lib/*.js"
     }
   },
-  "scripts": {
-    "build": "tsc",
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
   "keywords": [
     "fmt",
     "format",
@@ -28,11 +24,16 @@
     "println",
     "printf",
     "console",
-    "log"
+    "log",
+    "console.log"
   ],
   "author": "Alfio (https://github.com/p2js)",
   "license": "ISC",
   "devDependencies": {
     "@types/node": "^22.8.6"
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "echo \"Error: no test specified\" && exit 1"
   }
 }