Morpeu NPM | npm.io

Morpeu

Format strings like you're the boss

Python has format(), C languages have printf(), Go has fmt.Printf(), and it's time for JavaScript to join in too.

Morpeu aims to bring exceptional string formatting to JavaScript. It is inspired by Python's format(), but with additional tweaks and features to make it powerful and customizable.

Installation

$ npm install --save morpeu

Then require it in your module:

const morph = require("morpeu");

Or using ES6 modules:

import morph from "morpeu";

Format Rules Language

"{" [arg_index] ( "[" bracket_prop "]" | "." dot_prop )* "|" [[padfill]align] [sign] [padding] ["." precision] [morphism] "}"

Where:

arg_index: A number specifying the index of the argument in the argument list.
bracket_prop: A string of characters not including "]" to specify a property of the argument.
dot_prop: A string of a valid JavaScript identifier to specify a property of the argument.
padfill: A character to insert when padding is being added. align must follow immediately to recognize it. Defaults to a space.
align: Controls the alignment of the output when padding is applied.
- >: Right aligns the output. Default for most types.
- <: Left aligns the output. Default for numbers (integers and floats).
- ^: Center aligns the output. If specified padding is odd, the extra space is applied to the left.
sign: Controls the placement of signs in numbers. Only valid for integer and float type morphisms.
- +: Prepend a plus sign before positive numbers and a minus sign before negative numbers.
- -: Don't prepend anything on positive numbers but prepend a minus sign before negative numbers. The default behavior.
- : Prepend a space before positive numbers and a minus sign before negative numbers.
padding: A positive number for specifying the number of padfill characters to apply.
precision: A positive number for specifying the precision amount to be applied.
morphism: See Morphisms.

The delimiter pipe (|) is similar to to the colon (:) of Python's. Using pipe can semantically give the look of the argument (left of the pipe) being piped to the morphism.

Morphisms

Morphisms have three types according to the argument they accept and morph.

String type

String types additionally support null and undefined values, and objects with toString method. Precision indicates the number of the characters from the argument to include.

Morphism	Description
`s`	Morphs strings as is. The default when no morphism is specified and the argument is of string type.

Example Usage

morph("{|.4s}", "fooooo");
// => "foo"

const account = { name: "Foo", addr: "Bar St." };
morph("Name: {.name}, Address: {.addr}", account);
// => "Name: Foo, Address: Bar St."

Integer type

A specified precision results in an error.

Morphism	Description
`i`	Morphs argument as is. The default when no morphism is specified and the argument is of integer type.
`c`	Interprets the argument as a UTF-16 code unit, and morphs it to the corresponding character.
`b`	Morphs argument to binary.
`o`	Morphs argument to octal.
`x`	Morphs argument to hexadecimal. Outputs letters in lowercase.
`X`	Same as `x`, but output letters as uppercase.

Example Usage

morph("2 ** 3 = {}", Math.pow(2, 3));
// => "2 ** 3 = 8"
morph("Binary of 37: {|b}", 37);
// => "Binary of 37: 100101"
morph("Hex of 165: {|x}", 165);
// => "Hex of 165: A5"

Float type

Float types support both floats and integers (which are transformed into floats). Precision indicates the number of decimal digits after the dot. Default precision is 6.

Morphism	Description
`f`	Morphs float to fixed-point form.
`g`	Morphs float by a series of steps: the argument is transformed to scientific notation with precision "p" to get "exp", the exponent of the value. If `-4 <= exp < p`, format the original argument like with morphism `f` with precision "p". Else, format the argument like with morphism `e` with precision "p". In either case, the result is stripped off of insignificant trailing zeroes, and the decimal point if no digits follow it. The default when no morphism is specified and the argument is of float type.
`e`	Morphs float to scientific notation using e as exponent indicator.
`E`	Same as `e` but use E as exponent indicator.
`%`	Morphs float by multiplying by 100, transforming to fixed-point form, and appending a %.

Example Usage

morph("Pi: {|.4}", Math.PI);
// => "Pi: 3.1416"
morph("1kg = {}μg", 1 / 1000000);
// => "1kg = 1e-6μg"
morph("{|.2%} of 20 is 7", 7 / 20);
// => "35.00% of 20 is 7"

More In-depth Examples

Specifying order of arguments

morph("{}{}{}", "a", "b", "c");
// => "abc"
morph("{2}{1}{3}", "a", "b", "c");
// => "bac"

Specifying properties of objects

const account = { name: "Foo", addr: "Bar St." };
morph("Name: {.name}, Address: {.addr}", account);
// => "Name: Foo, Address: Bar St."

// Use brackets for property names that have special characters
const info = { "full-name": "John Dave" };
morph("Fullname: {[full-name]}", info);
// => "Fullname: John Dave"

Aligning

morph("{|6>}", "left");
// => "      left"
morph("{|6<}", "right");
// => "right      "
morph("{|*16^}", "center");
// => "********center********"

Using own objects

class A {
   constructor(name) {
     this.name = name;
   }
   toString() {
     return "Name: " + this.name
   }
}
const inst = new A("baz");
morph("{}", inst);
// => "Name: baz"

Disclaimer

NodeJS already has a format function format() from module util, and if your aim is simple debugging, then util.format (used internally by console.log) can satisfy you in these circumstances. But when you want easy padding and the likes, then Morpeu is for you.