A JavaScript library for mutilate strings.

Most of the code from this project was created during a personal codegolf competition to distort the appearance of strings as much as possible but without actually destroying their contents.

So the name mutilator come into my mind.

mutilator (plural mutilators)

1. Agent noun of mutilate; one who mutilates.

This sounds unnecessarily brutal for now, but I assure you that no strings will be harmed permanently, as long as the functions are used correctly. 😏

So I decided to combine these "strange" functions into one library. More or less just for fun.

1. Modules
2. Functions
3. Involutory functions
4. Using the CLI

stringMutilator/charCase

Functions for manipulating the letter case of strings.

stringMutilator/compressor

Functions for compressing (pack/unpack etc.) strings.

stringMutilator

Functions for mutilating strings.

flipBits(string) ⇒ string

Flip the character bits of a string. The 16 character bits of 'A' are 00000000 01000001 - if we flip the bits (so every 0 becomes 1 and vice versa) they look like this 11111111 10111110. This means that 'A' (0x41) becomes 'ﾾ' (0xFFBE).

jumble(string, [runs]) ⇒ string

Jumble the letters of all words in a string, except the first and last one, to keep it readable.

reverseBits(string) ⇒ string

Reverse the character bits of a string. The 16 character bits of 'A' are 00000000 01000001 - if we reverse the bits they look like this 10000010 00000000. This means that 'A' (0x41) becomes '舀' (0x8200).

reverse(string) ⇒ string

Reverse a string.

rockdotize(string, [regexp]) ⇒ string

Create a heavy metal like rockdot string.

rot13(string) ⇒ string

Rotate the character indexes of a string by 13 digits.

scramble(string) ⇒ string

Randomize the order of the characters in a string.

shiftBits(string, [n]) ⇒ string

Rotate the character bits of a string. The 16 character bits of 'A' are 00000000 01000001 - if we shift the bits by -4 n digits they look like this 00010000 00000100. This means that 'A' (0x41) becomes 'င' (0x1004).

shift(string, [n]) ⇒ string

Shift the characters of a string by n digits.

toMANS(string, [type]) ⇒ string

Convert A-Z to Mathematical Alphanumeric Symbols.

List of type values:

type	Unicode name
0	Mathematical Bold *
1	Mathematical Italic *
2	Mathematical Bold Italic *
3	Mathematical Script Capital *
4	Mathematical Bold Script *
5	Mathematical Fraktur *
6	Mathematical Double-Struck *
7	Mathematical Bold Fraktur *
8	Mathematical Sans-Serif *
9	Mathematical Sans-Serif Bold *
10	Mathematical Sans-Serif Italic *
11	Mathematical Sans-Serif Bold Italic *
12	Mathematical Monospace *

Functions for manipulating the letter case of strings.

Invert the case of letters in a string.

Kind: inner method of stringMutilator/charCase

Example

stringMutilator.charCase.invert('Hello World!'); // > 'hELLO wORLD!'

Functions for compressing (pack/unpack etc.) strings.

• stringMutilator/compressor
  • ~pack(string) ⇒ string
  • ~unpack(string) ⇒ string
  • ~signature(string, [withEval]) ⇒ string

Pack all characters of a 8-bit string.

Kind: inner method of stringMutilator/compressor

Example

stringMutilator.compressor.pack('Hello World!'); // > '䡥汬漠坯牬搡'

Unpack a packed string.

Kind: inner method of stringMutilator/compressor

Example

stringMutilator.compressor.unpack('䡥汬漠坯牬搡'); // > 'Hello World!'

Return the given, packed string with the unpack signature.

Kind: inner method of stringMutilator/compressor

Example

stringMutilator.compressor.signature('䡥汬漠坯牬搡'); // > 'unescape(escape("䡥汬漠坯牬搡").replace(/u(..)/g, "$1%");'

Functions for mutilating strings.

Flip the character bits of a string. The 16 character bits of 'A' are 00000000 01000001 - if we flip the bits (so every 0 becomes 1 and vice versa) they look like this 11111111 10111110. This means that 'A' (0x41) becomes 'ﾾ' (0xFFBE).

Kind: global function

Example

stringMutilator.flipBits('Hello World!'); // > 'ﾷﾚﾓﾓﾐ￟ﾨﾐﾍﾓﾛ￞'

Jumble the letters of all words in a string, except the first and last one, to keep it readable.

Kind: global function
See: https://www.mnn.com/lifestyle/arts-culture/stories/why-your-brain-can-read-jumbled-letters

Example

stringMutilator.jumble('Hello World!'); // > 'Hlelo Wrlod!'

Reverse the character bits of a string. The 16 character bits of 'A' are 00000000 01000001 - if we reverse the bits they look like this 10000010 00000000. This means that 'A' (0x41) becomes '舀' (0x8200).

Kind: global function

Example

stringMutilator.reverseBits('Hello World!'); // > 'ሀꘀ㘀㘀Ѐ一㘀☀萀'

Reverse a string.

Kind: global function

Example

stringMutilator.reverse('Hello World!'); // > '!dlroW olleH'

Create a heavy metal like rockdot string.

Kind: global function
See

• https://en.wikipedia.org/wiki/Metal_umlaut
• https://github.com/bullgit/rockdotizer

Example

stringMutilator.rockdotize('Hello World!'); // > 'Ḧël̈l̈ö Ẅör̈l̈d̈!'

Rotate the character indexes of a string by 13 digits.

Kind: global function
See: https://en.wikipedia.org/wiki/ROT13

Example

stringMutilator.rot13('Hello World!'); // > 'Uryyb Jbeyq!'

Randomize the order of the characters in a string.

Kind: global function

Example

stringMutilator.scramble('Hello World!'); // > 'WorH!llo led'

Rotate the character bits of a string. The 16 character bits of 'A' are 00000000 01000001 - if we shift the bits by -4 n digits they look like this 00010000 00000100. This means that 'A' (0x41) becomes 'င' (0x1004).

Kind: global function

Shift the characters of a string by n digits.

Kind: global function

Example

stringMutilator.shift('Hello World!', 3); // > 'lo World!Hel'

Convert A-Z to Mathematical Alphanumeric Symbols.

List of type values:

Kind: global function
See: https://unicode-table.com/en/blocks/mathematical-alphanumeric-symbols

Example

stringMutilator.toMANS('Hello World!', 1); // > '𝐻𝑒𝑙𝑙𝑜 𝑊𝑜𝑟𝑙𝑑.'

An involutory function, is a function f that is its own inverse.

Example

import { rot13 } from 'string-mutilator'; rot13(rot13('Hello World!')) === 'Hello World!'; // > true

• charCase.invert
• flipBits
• reverse
• reverseBits
• rot13

Example

import { shift } from 'string-mutilator'; shift(shift('Hello World!', 5), -5) === 'Hello World!'; // > true 

• shift
• shiftBits

To use it in your project

npm install --save string-mutilator

To use it globally

npm install --global string-mutilator

$ string-mutilator --help Functions for mutilating strings. Usage $ string-mutilator <function> <string> [argument]... Functions charCase.invert compressor.pack compressor.unpack compressor.signature flipBits jumble reverse reverseBits rockdotize rot13 scramble shift shiftBits toMANS Examples $ string-mutilator shift "Hello World!" 6 $ string-mutilator charCase.invert "Hello World!" $ string-mutilator toMANS "Hello World!" 4 

© 2019 by Oliver Kühn. Released under the MIT license.