Emojify
Emojify is a useless tool that replaces boring variable names with their fun emoji counterparts.
Install
This package is no longer hosted on npm
Another developer requested the use of the package name emojify
, which I happily granted because this is package is useless and will be better suited when attached to a real project. I've decided not to republish it under a new name.
If you still to want to install it for some reason, you can do so by installing directly from this repository.
For command line use:
npm install -g danthareja/emojify
For programmatic use:
npm install danthareja/emojify
Usage
Emojify is a drop-in replacement for UglifyJS2 with one major difference - it minifies your variables by default and replaces them with hilarious emojis.
From the command line, run:
emojify input1.js [input2.js ...] [options]
Anything you can do with UglifyJS2 you can do with Emojify, with a few notable exceptions:
--mangle
and--beautify
are turned on by default- You can minify your code a little with
--compress
(-c
) or a lot with--uglify
(-u
)
Examples
Let's run @mathias's String.fromCodePoint polyfill through some emojification
Our source file: String-fromCodePoint.js
/*! https://mths.be/fromcodepoint v0.2.1 by @mathias */
if (!String.fromCodePoint) {
(function() {
var defineProperty = (function() {
// IE 8 only supports `Object.defineProperty` on DOM elements
try {
var object = {};
var $defineProperty = Object.defineProperty;
var result = $defineProperty(object, object, object) && $defineProperty;
} catch(error) {}
return result;
}());
var stringFromCharCode = String.fromCharCode;
var floor = Math.floor;
var fromCodePoint = function(_) {
var MAX_SIZE = 0x4000;
var codeUnits = [];
var highSurrogate;
var lowSurrogate;
var index = -1;
var length = arguments.length;
if (!length) {
return '';
}
var result = '';
while (++index < length) {
var codePoint = Number(arguments[index]);
if (
!isFinite(codePoint) || // `NaN`, `+Infinity`, or `-Infinity`
codePoint < 0 || // not a valid Unicode code point
codePoint > 0x10FFFF || // not a valid Unicode code point
floor(codePoint) != codePoint // not an integer
) {
throw RangeError('Invalid code point: ' + codePoint);
}
if (codePoint <= 0xFFFF) { // BMP code point
codeUnits.push(codePoint);
} else { // Astral code point; split in surrogate halves
// https://mathiasbynens.be/notes/javascript-encoding#surrogate-formulae
codePoint -= 0x10000;
highSurrogate = (codePoint >> 10) + 0xD800;
lowSurrogate = (codePoint % 0x400) + 0xDC00;
codeUnits.push(highSurrogate, lowSurrogate);
}
if (index + 1 == length || codeUnits.length > MAX_SIZE) {
result += stringFromCharCode.apply(null, codeUnits);
codeUnits.length = 0;
}
}
return result;
};
if (defineProperty) {
defineProperty(String, 'fromCodePoint', {
'value': fromCodePoint,
'configurable': true,
'writable': true
});
} else {
String.fromCodePoint = fromCodePoint;
}
}());
}
Default behavior
Running emojify /path/to/String-fromCodePoint.js
outputs:
if (!String.fromCodePoint) {
(function() {
var ๐ = function() {
try {
var ๐ = {};
var ๐ฉ = Object.defineProperty;
var ๐ฅ = ๐ฉ(๐, ๐, ๐) && ๐ฉ;
} catch (๐) {}
return ๐ฅ;
}();
var ๐ฉ = String.fromCharCode;
var ๐ฅ = Math.floor;
var ๐ = function(๐) {
var ๐ = 16384;
var ๐ = [];
var ๐;
var ๐บ;
var ๐ป = -1;
var ๐ = arguments.length;
if (!๐) {
return "";
}
var ๐ถ = "";
while (++๐ป < ๐) {
var ๐ฑ = Number(arguments[๐ป]);
if (!isFinite(๐ฑ) || ๐ฑ < 0 || ๐ฑ > 1114111 || ๐ฅ(๐ฑ) != ๐ฑ) {
throw RangeError("Invalid code point: " + ๐ฑ);
}
if (๐ฑ <= 65535) {
๐.push(๐ฑ);
} else {
๐ฑ -= 65536;
๐ = (๐ฑ >> 10) + 55296;
๐บ = ๐ฑ % 1024 + 56320;
๐.push(๐, ๐บ);
}
if (๐ป + 1 == ๐ || ๐.length > ๐) {
๐ถ += ๐ฉ.apply(null, ๐);
๐.length = 0;
}
}
return ๐ถ;
};
if (๐) {
๐(String, "fromCodePoint", {
value: ๐,
configurable: true,
writable: true
});
} else {
String.fromCodePoint = ๐;
}
})();
}
More minification
Running emojify /path/to/String-fromCodePoint.js -o /path/to/String-fromCodePoint.min.js -u
outputs:
if(!String.fromCodePoint){(function(){var๐=function(){try{var๐={};var๐ฉ=Object.defineProperty;var๐ฅ=๐ฉ(๐,๐,๐)&&๐ฉ}catch(๐){}return๐ฅ}();var๐ฉ=String.fromCharCode;var๐ฅ=Math.floor;var๐=function(๐){var๐=16384;var๐=[];var๐;var๐บ;var๐ป=-1;var๐=arguments.length;if(!๐){return""}var๐ถ="";while(++๐ป<๐){var๐ฑ=Number(arguments[๐ป]);if(!isFinite(๐ฑ)||๐ฑ<0||๐ฑ>1114111||๐ฅ(๐ฑ)!=๐ฑ){throw RangeError("Invalid code point: "+๐ฑ)}if(๐ฑ<=65535){๐.push(๐ฑ)}else{๐ฑ-=65536;๐=(๐ฑ>>10)+55296;๐บ=๐ฑ%1024+56320;๐.push(๐,๐บ)}if(๐ป+1==๐||๐.length>๐){๐ถ+=๐ฉ.apply(null,๐);๐.length=0}}return๐ถ};if(๐){๐(String,"fromCodePoint",{value:๐,configurable:true,writable:true})}else{String.fromCodePoint=๐}})()}
to a new file located at /path/to/String-fromCodePoint.min.js
Less minification but more emojis
You can go even harder by passing in --mangle-props
. This not only replaces top-level variable names but also hunts down properties on objects.
Running emojify /path/to/String-fromCodePoint.js --compress --mangle-props
outputs:
String.๐ || !function() {
var ๐ = function() {
try {
var ๐ = {}, ๐ฉ = Object.defineProperty, ๐ฅ = ๐ฉ(๐, ๐, ๐) && ๐ฉ;
} catch (๐) {}
return ๐ฅ;
}(), ๐ฉ = String.fromCharCode, ๐ฅ = Math.floor, ๐ = function(๐) {
var ๐, ๐, ๐ = 16384, ๐บ = [], ๐ป = -1, ๐ = arguments.length;
if (!๐) return "";
for (var ๐ถ = ""; ++๐ป < ๐; ) {
var ๐ฑ = Number(arguments[๐ป]);
if (!isFinite(๐ฑ) || 0 > ๐ฑ || ๐ฑ > 1114111 || ๐ฅ(๐ฑ) != ๐ฑ) throw RangeError("Invalid code point: " + ๐ฑ);
65535 >= ๐ฑ ? ๐บ.push(๐ฑ) : (๐ฑ -= 65536, ๐ = (๐ฑ >> 10) + 55296, ๐ = ๐ฑ % 1024 + 56320,
๐บ.push(๐, ๐)), (๐ป + 1 == ๐ || ๐บ.length > ๐) && (๐ถ += ๐ฉ.apply(null, ๐บ),
๐บ.length = 0);
}
return ๐ถ;
};
๐ ? ๐(String, "fromCodePoint", {
"๐ฉ": ๐,
"๐ฅ": !0,
"๐": !0
}) : String.๐ = ๐;
}();
More usage
Read up on the rest of the commands here
API Reference
Assuming installation via NPM, you can load Emojify in your application like this:
var Emojify = require("emojify");
There's a single top-level function which combines all the steps.
If you don't need additional customization, you might want to go with minify
.
Example:
var result = Emojify.minify("/path/to/file.js");
console.log(result.code); // minified output
// if you need to pass code instead of file name
var result = Emojify.minify("var b = function () {};", {fromString: true});
You can also compress multiple files:
var result = Emojify.minify([ "file1.js", "file2.js", "file3.js" ]);
console.log(result.code);
Read up on the rest of the programmatic API here
FAQs
Can I run Emojified code?
Nope
While ES6 brings stronger Unicode support to our beloved language, not all symbols can be used as valid identifiers. We can use things like var เฒ _เฒ = 42
, but not var ๐ฉ = 43
.
@mathias has a great post explaining the details of valid identifiers in ES6
So what's the point?
Maybe one day ESXX will support emoji identifiers. Until then it's just for the lulz
I want my own emojis, the ones you picked suck
You can do that
I've exposed the array of characters that Emojify uses to replace your variable names. Simply edit the array in lib/manglers.js
with your emojis of choice.
You can include any number of emojis in this array, but I recommend at least 40 different entires for enough combinations to cover a decent sized file. Here's a good site to copy emojis from.
You could grab some of the (more boring) supported characters and produce actualy working code!
Acknowledgements
This project would not exist without UglifyJS. Also, @mathiasbynens is a Unicode beast. I learned so much from his wonderful resources.