rsformat 0.2.3 → 0.2.5

package/lib/format.d.ts

@@ -10,8 +10,7 @@ export declare function format(str: string, ...params: any[]): string;
  *
  * @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
+ * @param options Options passed into formatting (Whether to use colors in debug formatting - false by default)
  */
 export declare function fmt_raw(str: string, params: any[], options?: {
     colors: boolean;

package/lib/format.js

@@ -35,8 +35,7 @@ exports.format = format;
  *
  * @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
+ * @param options Options passed into formatting (Whether to use colors in debug formatting - false by default)
  */
 function fmt_raw(str, params, options = { colors: false }) {
     // Counter used for insertion of unnumbered values
@@ -105,8 +104,9 @@ function fmt_raw(str, params, options = { colors: false }) {
                 }
                 break;
             case '?':
-                // Do not force sign or align to precision when using inspect
+                // Do not force sign, pad with zeroes or align to precision when using debug formatting
                 $sign = undefined;
+                $pad_zeroes = undefined;
                 $precision = undefined;
                 true_length = (0, node_util_1.inspect)(param, {
                     depth: Infinity,
@@ -130,18 +130,16 @@ function fmt_raw(str, params, options = { colors: false }) {
         // Compute radix-point precision on numbers
         if (param_type == 'number' && $precision) {
             let [pre, post] = param.split('.');
-            if (post === undefined) {
-                post = '';
-            }
             let precision = +$precision.substring(1, $precision.length);
-            if (post.length > precision) {
-                post = post.substring(0, precision);
+            if (!precision) { // precision = 0, do not include radix point
+                param = pre;
+            }
+            else {
+                post = ((post || '') + '0'.repeat(precision)).slice(0, precision);
+                param = pre + '.' + post;
+                // Update true length for fill/align
+                true_length = param.length;
             }
-            else
-                while (post.length < precision) {
-                    post = post + '0';
-                }
-            param = pre + '.' + post;
         }
         let width;
         if ($width === undefined) {
@@ -185,8 +183,10 @@ function fmt_raw(str, params, options = { colors: false }) {
                 filled = true;
                 while (param.length < width - maybe_sign.length) {
                     param = '0' + param;
+                    true_length++;
                 }
             }
+            true_length += maybe_sign.length;
             param = maybe_sign + param;
         }
         if (!filled && width > true_length) {

package/lib/print.d.ts

@@ -1,5 +1,14 @@
 /// <reference types="node" />
 import { Writable } from 'node:stream';
+/**
+ * Create format printer functions with custom output/error streams.
+ *
+ * @param outStream Output stream (used by print and println - process.stdout by default)
+ * @param errStream Error stream (used by eprint and eprintln - process.stderr by default)
+ * @param options Options for the printer functions (Whether to color the debug formatting in the output - true by default)
+ *
+ * @returns an object with print, println, eprint and eprintln functions that print to the specified streams
+ */
 export declare function Printer(outStream?: Writable, errStream?: Writable, options?: {
     debugColors: boolean;
 }): {
@@ -34,4 +43,33 @@ export declare function Printer(outStream?: Writable, errStream?: Writable, opti
      */
     eprintln: (format_string: string, ...params: any[]) => void;
 };
-export declare const print: (format_string: string, ...params: any[]) => void, println: (format_string: string, ...params: any[]) => void, eprint: (format_string: string, ...params: any[]) => void, eprintln: (format_string: string, ...params: any[]) => void;
+/**
+ * Print a format string to process.stdout.
+ *
+ * @param format_string String used for formatting
+ * @param params Parameters to be inserted into the format string
+ */
+export declare const print: (format_string: string, ...params: any[]) => void;
+/**
+ * Print a format string to process.stdout
+ * and append a newline.
+ *
+ * @param format_string String used for formatting
+ * @param params Parameters to be inserted into the format string
+ */
+export declare const println: (format_string: string, ...params: any[]) => void;
+/**
+ * Print a format string to process.stderr.
+ *
+ * @param format_string String used for formatting
+ * @param params Parameters to be inserted into the format string
+ */
+export declare const eprint: (format_string: string, ...params: any[]) => void;
+/**
+ * Print a format string to process.stderr
+ * and append a newline.
+ *
+ * @param format_string String used for formatting
+ * @param params Parameters to be inserted into the format string
+ */
+export declare const eprintln: (format_string: string, ...params: any[]) => void;

package/lib/print.js

@@ -2,11 +2,19 @@
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-var _a;
 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");
+/**
+ * Create format printer functions with custom output/error streams.
+ *
+ * @param outStream Output stream (used by print and println - process.stdout by default)
+ * @param errStream Error stream (used by eprint and eprintln - process.stderr by default)
+ * @param options Options for the printer functions (Whether to color the debug formatting in the output - true by default)
+ *
+ * @returns an object with print, println, eprint and eprintln functions that print to the specified streams
+ */
 function Printer(outStream = node_process_1.default.stdout, errStream = node_process_1.default.stderr, options = { debugColors: true }) {
     return {
         /**
@@ -50,4 +58,34 @@ function Printer(outStream = node_process_1.default.stdout, errStream = node_pro
     };
 }
 exports.Printer = Printer;
-_a = Printer(), exports.print = _a.print, exports.println = _a.println, exports.eprint = _a.eprint, exports.eprintln = _a.eprintln;
+const default_printer = Printer();
+/**
+ * Print a format string to process.stdout.
+ *
+ * @param format_string String used for formatting
+ * @param params Parameters to be inserted into the format string
+ */
+exports.print = default_printer.print;
+/**
+ * Print a format string to process.stdout
+ * and append a newline.
+ *
+ * @param format_string String used for formatting
+ * @param params Parameters to be inserted into the format string
+ */
+exports.println = default_printer.println;
+/**
+ * Print a format string to process.stderr.
+ *
+ * @param format_string String used for formatting
+ * @param params Parameters to be inserted into the format string
+ */
+exports.eprint = default_printer.eprint;
+/**
+ * Print a format string to process.stderr
+ * and append a newline.
+ *
+ * @param format_string String used for formatting
+ * @param params Parameters to be inserted into the format string
+ */
+exports.eprintln = default_printer.eprintln;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rsformat",
-  "version": "0.2.3",
+  "version": "0.2.5",
   "description": "Formatting/printing library for JavaScript that takes after rust's string formatting ",
   "files": [
     "lib",