rsformat 0.2.1 → 0.2.3

package/README.md

@@ -90,7 +90,7 @@ format('{:.>7}', [1,2]); // '....1,2'
 
 #### Pretty Printing
 
-In some instances (namely debug and hexadecimal formatting), adding a `#` before the format specifier will use an alternative 'pretty' printing style. This amounts to using non-compact `util.inspect` for debug printing (spanning multiple lines), and adding 0x to hexadecimal numbers.
+In some instances (namely debug, binary, octal and hexadecimal formatting), adding a `#` before the format specifier will use an alternative 'pretty' printing style. This amounts to using non-compact `util.inspect` for debug printing (spanning multiple lines), and adding 0b/0o/0x as a prefix for the numbers formatted as powers of two.
 
 ```js
 format('{:#X}', 255); // '0xFF'

package/lib/format.js

@@ -57,21 +57,22 @@ function fmt_raw(str, params, options = { colors: false }) {
             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();
@@ -87,7 +88,7 @@ function fmt_raw(str, params, options = { colors: false }) {
                         break;
                 }
                 break;
-            case "E":
+            case 'E':
                 switch (param_type) {
                     case 'number':
                         param = param.toExponential().toUpperCase();
@@ -103,7 +104,15 @@ function fmt_raw(str, params, options = { colors: false }) {
                         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: options.colors,
@@ -115,11 +124,14 @@ function fmt_raw(str, params, options = { colors: false }) {
                 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) {
@@ -129,7 +141,7 @@ function fmt_raw(str, params, options = { colors: false }) {
                 while (post.length < precision) {
                     post = post + '0';
                 }
-            param = pre + "." + post;
+            param = pre + '.' + post;
         }
         let width;
         if ($width === undefined) {
@@ -153,9 +165,20 @@ function fmt_raw(str, params, options = { colors: false }) {
             else {
                 maybe_sign = '';
             }
-            //If the type is x or X and pretty printing enabled, add 0x
-            if ((($type === 'x') || ($type === 'X')) && ($pretty === '#')) {
-                maybe_sign += '0x';
+            // If pretty printing is enabled and the formating calls for a prefix, add it
+            if ($pretty === '#') {
+                switch ($type) {
+                    case 'o':
+                        maybe_sign += "0o";
+                        break;
+                    case 'x':
+                    case 'X':
+                        maybe_sign += "0x";
+                        break;
+                    case 'b':
+                        maybe_sign += "0b";
+                        break;
+                }
             }
             //pad with zeroes if specified  
             if ($pad_zeroes === '0') {
@@ -166,31 +189,27 @@ function fmt_raw(str, params, options = { colors: false }) {
             }
             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;
     });

package/lib/print.d.ts

@@ -1,6 +1,8 @@
 /// <reference types="node" />
 import { Writable } from 'node:stream';
-export declare function Printer(outStream?: Writable, errStream?: Writable): {
+export declare function Printer(outStream?: Writable, errStream?: Writable, options?: {
+    debugColors: boolean;
+}): {
     /**
      * Print a format string to an output stream (usually process.stdout).
      *

package/lib/print.js

@@ -7,7 +7,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.eprintln = exports.eprint = exports.println = exports.print = exports.Printer = void 0;
 const node_process_1 = __importDefault(require("node:process"));
 const format_1 = require("./format");
-function Printer(outStream = node_process_1.default.stdout, errStream = node_process_1.default.stderr) {
+function Printer(outStream = node_process_1.default.stdout, errStream = node_process_1.default.stderr, options = { debugColors: true }) {
     return {
         /**
          * Print a format string to an output stream (usually process.stdout).
@@ -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.fmt_raw)(format_string, params, { colors: true }));
+            outStream.write((0, format_1.fmt_raw)(format_string, params, { colors: options.debugColors }));
         },
         /**
          * 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.fmt_raw)(format_string, params, { colors: true }) + '\n');
+            outStream.write((0, format_1.fmt_raw)(format_string, params, { colors: options.debugColors }) + '\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.fmt_raw)(format_string, params, { colors: true }));
+            errStream.write((0, format_1.fmt_raw)(format_string, params, { colors: options.debugColors }));
         },
         /**
          * 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.fmt_raw)(format_string, params, { colors: true }) + '\n');
+            errStream.write((0, format_1.fmt_raw)(format_string, params, { colors: options.debugColors }) + '\n');
         },
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rsformat",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "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",
@@ -36,5 +32,8 @@
   "devDependencies": {
     "@types/node": "^22.8.6"
   },
-  "packageManager": "pnpm@9.14.2+sha512.6e2baf77d06b9362294152c851c4f278ede37ab1eba3a55fda317a4a17b209f4dbb973fb250a77abc463a341fcb1f17f17cfa24091c4eb319cda0d9b84278387"
+  "scripts": {
+    "build": "tsc",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  }
 }