Logging with a smile 😃 | Creative-Scripts.com

The ability to see snapshots of a script progress throughout it's execution is crucial for the writing and debugging of complex scripts. There are scripters who are dependent on using the ESTK for developing scripts for the most of Adobe's well know products like InDesign, Illustrator, Photoshop, Premier Pro and After Effects to name but a few. What they do not appreciate is the degree of handicap they are inflicting on themselves because of their dependency. I'll probably discus this topic in the future, don't get me wrong I'm not saying that there is no place for using the ESTK just that it should be used cautiously as an exception. I want to show that the use of the ESTK for the purpose of writing to the console is a bad idea.

OK for your little 20 line snippet it's not necessarily exactly the end of the world, but one has to know that writing to the ESTK console is really incredibly slow, it's comes out pretty illegible, trying to find one entry amongst a multitude of other is no pleasure to put it mildly. There's no keeping of the output from session to session and there's no built in search and find for the console. The use of the alert function has obvious problems, again I'm not saying there's no place for it just that it's very lacking.

An effective well known and well practiced solution is logging. There are many logging API's, I wrote this one to for Adobe JSX scripts to suit my needs. It's very quick, easy to use, produces easy to read and informative logs and has an extensive API. A minor feature of the API is the use of emojis for emphasizing individual log entries so they can be found and categorized quickly, perhaps the implementation here is a bit of an overkill and it would be better to remove a lot of the available emojis.

💾 The Squished Script:

// LogFactory.jsx Ver 1 By Trevor 6rd Mar 2017 http://www.creative-scripts.com/logging-with-a-smile/ Provided 'as is', with no warranty whatsoever. This line may not be removed.
var LogFactory=function(file,write,store,level,defaultStatus,continuing){if(file&&(file.constructor===String||file.constructor===File)){file={file:file};}else if(!file)file={file:{}};write=(file.write!==undefined)?file.write:write;if(write===undefined){write=true;}store=(file.store!==undefined)?file.store||false:store||false;level=(file.level!==undefined)?file.level:level;defaultStatus=(file.defaultStatus!==undefined)?file.defaultStatus:defaultStatus;if(defaultStatus===undefined){defaultStatus='LOG';}continuing=(file.continuing!==undefined)?file.continuing:continuing||false;file=file.file||{};var stack,times,logTime,logPoint,icons,statuses,LOG_LEVEL,LOG_STATUS;stack=[];times=[];logTime=new Date();logPoint='Log Factory Start';icons={"1":"\ud83d\udd50","130":"\ud83d\udd5c","2":"\ud83d\udd51","230":"\ud83d\udd5d","3":"\ud83d\udd52","330":"\ud83d\udd5e","4":"\ud83d\udd53","430":"\ud83d\udd5f","5":"\ud83d\udd54","530":"\ud83d\udd60","6":"\ud83d\udd55","630":"\ud83d\udd61","7":"\ud83d\udd56","730":"\ud83d\udd62","8":"\ud83d\udd57","830":"\ud83d\udd63","9":"\ud83d\udd58","930":"\ud83d\udd64","10":"\ud83d\udd59","1030":"\ud83d\udd65","11":"\ud83d\udd5a","1130":"\ud83d\udd66","12":"\ud83d\udd5b","1230":"\ud83d\udd67","AIRPLANE":"\ud83d\udee9","ALARM":"\u23f0","AMBULANCE":"\ud83d\ude91","ANCHOR":"\u2693","ANGRY":"\ud83d\ude20","ANGUISHED":"\ud83d\ude27","ANT":"\ud83d\udc1c","ANTENNA":"\ud83d\udce1","APPLE":"\ud83c\udf4f","APPLE2":"\ud83c\udf4e","ATM":"\ud83c\udfe7","ATOM":"\u269b","BABYBOTTLE":"\ud83c\udf7c","BAD:":"\ud83d\udc4e","BANANA":"\ud83c\udf4c","BANDAGE":"\ud83e\udd15","BANK":"\ud83c\udfe6","BATTERY":"\ud83d\udd0b","BED":"\ud83d\udecf","BEE":"\ud83d\udc1d","BEER":"\ud83c\udf7a","BELL":"\ud83d\udd14","BELLOFF":"\ud83d\udd15","BIRD":"\ud83d\udc26","BLACKFLAG":"\ud83c\udff4","BLUSH":"\ud83d\ude0a","BOMB":"\ud83d\udca3","BOOK":"\ud83d\udcd5","BOOKMARK":"\ud83d\udd16","BOOKS":"\ud83d\udcda","BOW":"\ud83c\udff9","BOWLING":"\ud83c\udfb3","BRIEFCASE":"\ud83d\udcbc","BROKEN":"\ud83d\udc94","BUG":"\ud83d\udc1b","BUILDING":"\ud83c\udfdb","BUILDINGS":"\ud83c\udfd8","BULB":"\ud83d\udca1","BUS":"\ud83d\ude8c","CACTUS":"\ud83c\udf35","CALENDAR":"\ud83d\udcc5","CAMEL":"\ud83d\udc2a","CAMERA":"\ud83d\udcf7","CANDLE":"\ud83d\udd6f","CAR":"\ud83d\ude98","CAROUSEL":"\ud83c\udfa0","CASTLE":"\ud83c\udff0","CATEYES":"\ud83d\ude3b","CATJOY":"\ud83d\ude39","CATMOUTH":"\ud83d\ude3a","CATSMILE":"\ud83d\ude3c","CD":"\ud83d\udcbf","CHECK":"\u2714","CHEQFLAG":"\ud83c\udfc1","CHICK":"\ud83d\udc25","CHICKEN":"\ud83d\udc14","CHICKHEAD":"\ud83d\udc24","CIRCLEBLACK":"\u26ab","CIRCLEBLUE":"\ud83d\udd35","CIRCLERED":"\ud83d\udd34","CIRCLEWHITE":"\u26aa","CIRCUS":"\ud83c\udfaa","CLAPPER":"\ud83c\udfac","CLAPPING":"\ud83d\udc4f","CLIP":"\ud83d\udcce","CLIPBOARD":"\ud83d\udccb","CLOUD":"\ud83c\udf28","CLOVER":"\ud83c\udf40","CLOWN":"\ud83e\udd21","COLDSWEAT":"\ud83d\ude13","COLDSWEAT2":"\ud83d\ude30","COMPRESS":"\ud83d\udddc","CONFOUNDED":"\ud83d\ude16","CONFUSED":"\ud83d\ude15","CONSTRUCTION":"\ud83d\udea7","CONTROL":"\ud83c\udf9b","COOKIE":"\ud83c\udf6a","COOKING":"\ud83c\udf73","COOL":"\ud83d\ude0e","COOLBOX":"\ud83c\udd92","COPYRIGHT":"\u00a9","CRANE":"\ud83c\udfd7","CRAYON":"\ud83d\udd8d","CREDITCARD":"\ud83d\udcb3","CROSS":"\u2716","CROSSBOX:":"\u274e","CRY":"\ud83d\ude22","CRYCAT":"\ud83d\ude3f","CRYSTALBALL":"\ud83d\udd2e","CUSTOMS":"\ud83d\udec3","DELICIOUS":"\ud83d\ude0b","DERELICT":"\ud83c\udfda","DESKTOP":"\ud83d\udda5","DIAMONDLB":"\ud83d\udd37","DIAMONDLO":"\ud83d\udd36","DIAMONDSB":"\ud83d\udd39","DIAMONDSO":"\ud83d\udd38","DICE":"\ud83c\udfb2","DISAPPOINTED":"\ud83d\ude1e","CRY2":"\ud83d\ude25","DIVISION":"\u2797","DIZZY":"\ud83d\ude35","DOLLAR":"\ud83d\udcb5","DOLLAR2":"\ud83d\udcb2","DOWNARROW":"\u2b07","DVD":"\ud83d\udcc0","EJECT":"\u23cf","ELEPHANT":"\ud83d\udc18","EMAIL":"\ud83d\udce7","ENVELOPE":"\ud83d\udce8","ENVELOPE2":"\u2709","ENVELOPE_DOWN":"\ud83d\udce9","EURO":"\ud83d\udcb6","EVIL":"\ud83d\ude08","EXPRESSIONLESS":"\ud83d\ude11","EYES":"\ud83d\udc40","FACTORY":"\ud83c\udfed","FAX":"\ud83d\udce0","FEARFUL":"\ud83d\ude28","FILEBOX":"\ud83d\uddc3","FILECABINET":"\ud83d\uddc4","FIRE":"\ud83d\udd25","FIREENGINE":"\ud83d\ude92","FIST":"\ud83d\udc4a","FLOWER":"\ud83c\udf37","FLOWER2":"\ud83c\udf38","FLUSHED":"\ud83d\ude33","FOLDER":"\ud83d\udcc1","FOLDER2":"\ud83d\udcc2","FREE":"\ud83c\udd93","FROG":"\ud83d\udc38","FROWN":"\ud83d\ude41","GEAR":"\u2699","GLOBE":"\ud83c\udf0d","GLOWINGSTAR":"\ud83c\udf1f","GOOD:":"\ud83d\udc4d","GRIMACING":"\ud83d\ude2c","GRIN":"\ud83d\ude00","GRINNINGCAT":"\ud83d\ude38","HALO":"\ud83d\ude07","HAMMER":"\ud83d\udd28","HAMSTER":"\ud83d\udc39","HAND":"\u270b","HANDDOWN":"\ud83d\udc47","HANDLEFT":"\ud83d\udc48","HANDRIGHT":"\ud83d\udc49","HANDUP":"\ud83d\udc46","HATCHING":"\ud83d\udc23","HAZARD":"\u2623","HEADPHONE":"\ud83c\udfa7","HEARNOEVIL":"\ud83d\ude49","HEARTBLUE":"\ud83d\udc99","HEARTEYES":"\ud83d\ude0d","HEARTGREEN":"\ud83d\udc9a","HEARTYELLOW":"\ud83d\udc9b","HELICOPTER":"\ud83d\ude81","HERB":"\ud83c\udf3f","HIGH_BRIGHTNESS":"\ud83d\udd06","HIGHVOLTAGE":"\u26a1","HIT":"\ud83c\udfaf","HONEY":"\ud83c\udf6f","HOT":"\ud83c\udf36","HOURGLASS":"\u23f3","HOUSE":"\ud83c\udfe0","HUGGINGFACE":"\ud83e\udd17","HUNDRED":"\ud83d\udcaf","HUSHED":"\ud83d\ude2f","ID":"\ud83c\udd94","INBOX":"\ud83d\udce5","INDEX":"\ud83d\uddc2","JOY":"\ud83d\ude02","KEY":"\ud83d\udd11","KISS":"\ud83d\ude18","KISS2":"\ud83d\ude17","KISS3":"\ud83d\ude19","KISS4":"\ud83d\ude1a","KISSINGCAT":"\ud83d\ude3d","KNIFE":"\ud83d\udd2a","LABEL":"\ud83c\udff7","LADYBIRD":"\ud83d\udc1e","LANDING":"\ud83d\udeec","LAPTOP":"\ud83d\udcbb","LEFTARROW":"\u2b05","LEMON":"\ud83c\udf4b","LIGHTNINGCLOUD":"\ud83c\udf29","LINK":"\ud83d\udd17","LITTER":"\ud83d\udeae","LOCK":"\ud83d\udd12","LOLLIPOP":"\ud83c\udf6d","LOUDSPEAKER":"\ud83d\udce2","LOW_BRIGHTNESS":"\ud83d\udd05","MAD":"\ud83d\ude1c","MAGNIFYING_GLASS":"\ud83d\udd0d","MASK":"\ud83d\ude37","MEDAL":"\ud83c\udf96","MEMO":"\ud83d\udcdd","MIC":"\ud83c\udfa4","MICROSCOPE":"\ud83d\udd2c","MINUS":"\u2796","MOBILE":"\ud83d\udcf1","MONEY":"\ud83d\udcb0","MONEYMOUTH":"\ud83e\udd11","MONKEY":"\ud83d\udc35","MOUSE":"\ud83d\udc2d","MOUSE2":"\ud83d\udc01","MOUTHLESS":"\ud83d\ude36","MOVIE":"\ud83c\udfa5","MUGS":"\ud83c\udf7b","NERD":"\ud83e\udd13","NEUTRAL":"\ud83d\ude10","NEW":"\ud83c\udd95","NOENTRY":"\ud83d\udeab","NOTEBOOK":"\ud83d\udcd4","NOTEPAD":"\ud83d\uddd2","NUTANDBOLT":"\ud83d\udd29","O":"\u2b55","OFFICE":"\ud83c\udfe2","OK":"\ud83c\udd97","OKHAND":"\ud83d\udc4c","OLDKEY":"\ud83d\udddd","OPENLOCK":"\ud83d\udd13","OPENMOUTH":"\ud83d\ude2e","OUTBOX":"\ud83d\udce4","PACKAGE":"\ud83d\udce6","PAGE":"\ud83d\udcc4","PAINTBRUSH":"\ud83d\udd8c","PALETTE":"\ud83c\udfa8","PANDA":"\ud83d\udc3c","PASSPORT":"\ud83d\udec2","PAWS":"\ud83d\udc3e","PEN":"\ud83d\udd8a","PEN2":"\ud83d\udd8b","PENSIVE":"\ud83d\ude14","PERFORMING":"\ud83c\udfad","PHONE":"\ud83d\udcde","PILL":"\ud83d\udc8a","PING":"\u2757","PLATE":"\ud83c\udf7d","PLUG":"\ud83d\udd0c","PLUS":"\u2795","POLICE":"\ud83d\ude93","POLICELIGHT":"\ud83d\udea8","POSTOFFICE":"\ud83c\udfe4","POUND":"\ud83d\udcb7","POUTING":"\ud83d\ude21","POUTINGCAT":"\ud83d\ude3e","PRESENT":"\ud83c\udf81","PRINTER":"\ud83d\udda8","PROJECTOR":"\ud83d\udcfd","PUSHPIN":"\ud83d\udccc","QUESTION":"\u2753","RABBIT":"\ud83d\udc30","RADIOACTIVE":"\u2622","RADIOBUTTON":"\ud83d\udd18","RAINCLOUD":"\ud83c\udf27","RAT":"\ud83d\udc00","RECYCLE":"\u267b","REGISTERED":"\u00ae","RELIEVED":"\ud83d\ude0c","ROBOT":"\ud83e\udd16","ROCKET":"\ud83d\ude80","ROLLING":"\ud83d\ude44","ROOSTER":"\ud83d\udc13","RULER":"\ud83d\udccf","SATELLITE":"\ud83d\udef0","SAVE":"\ud83d\udcbe","SCHOOL":"\ud83c\udfeb","SCISSORS":"\u2702","SCREAMING":"\ud83d\ude31","SCROLL":"\ud83d\udcdc","SEAT":"\ud83d\udcba","SEEDLING":"\ud83c\udf31","SEENOEVIL":"\ud83d\ude48","SHIELD":"\ud83d\udee1","SHIP":"\ud83d\udea2","SHOCKED":"\ud83d\ude32","SHOWER":"\ud83d\udebf","SLEEPING":"\ud83d\ude34","SLEEPY":"\ud83d\ude2a","SLIDER":"\ud83c\udf9a","SLOT":"\ud83c\udfb0","SMILE":"\ud83d\ude42","SMILING":"\ud83d\ude03","SMILINGCLOSEDEYES":"\ud83d\ude06","SMILINGEYES":"\ud83d\ude04","SMILINGSWEAT":"\ud83d\ude05","SMIRK":"\ud83d\ude0f","SNAIL":"\ud83d\udc0c","SNAKE":"\ud83d\udc0d","SOCCER":"\u26bd","SOS":"\ud83c\udd98","SPEAKER":"\ud83d\udd08","SPEAKEROFF":"\ud83d\udd07","SPEAKNOEVIL":"\ud83d\ude4a","SPIDER":"\ud83d\udd77","SPIDERWEB":"\ud83d\udd78","STAR":"\u2b50","STOP":"\u26d4","STOPWATCH":"\u23f1","SULK":"\ud83d\ude26","SUNFLOWER":"\ud83c\udf3b","SUNGLASSES":"\ud83d\udd76","SYRINGE":"\ud83d\udc89","TAKEOFF":"\ud83d\udeeb","TAXI":"\ud83d\ude95","TELESCOPE":"\ud83d\udd2d","TEMPORATURE":"\ud83e\udd12","TENNIS":"\ud83c\udfbe","THERMOMETER":"\ud83c\udf21","THINKING":"\ud83e\udd14","THUNDERCLOUD":"\u26c8","TICKBOX":"\u2705","TICKET":"\ud83c\udf9f","TIRED":"\ud83d\ude2b","TOILET":"\ud83d\udebd","TOMATO":"\ud83c\udf45","TONGUE":"\ud83d\ude1b","TOOLS":"\ud83d\udee0","TORCH":"\ud83d\udd26","TORNADO":"\ud83c\udf2a","TOUNG2":"\ud83d\ude1d","TRADEMARK":"\u2122","TRAFFICLIGHT":"\ud83d\udea6","TRASH":"\ud83d\uddd1","TREE":"\ud83c\udf32","TRIANGLE_LEFT":"\u25c0","TRIANGLE_RIGHT":"\u25b6","TRIANGLEDOWN":"\ud83d\udd3b","TRIANGLEUP":"\ud83d\udd3a","TRIANGULARFLAG":"\ud83d\udea9","TROPHY":"\ud83c\udfc6","TRUCK":"\ud83d\ude9a","TRUMPET":"\ud83c\udfba","TURKEY":"\ud83e\udd83","TURTLE":"\ud83d\udc22","UMBRELLA":"\u26f1","UNAMUSED":"\ud83d\ude12","UPARROW":"\u2b06","UPSIDEDOWN":"\ud83d\ude43","WARNING":"\u26a0","WATCH":"\u231a","WAVING":"\ud83d\udc4b","WEARY":"\ud83d\ude29","WEARYCAT":"\ud83d\ude40","WHITEFLAG":"\ud83c\udff3","WINEGLASS":"\ud83c\udf77","WINK":"\ud83d\ude09","WORRIED":"\ud83d\ude1f","WRENCH":"\ud83d\udd27","X":"\u274c","YEN":"\ud83d\udcb4","ZIPPERFACE":"\ud83e\udd10","UNDEFINED":"","":""};statuses={F:'FATAL',B:'BUG',C:'CRITICAL',E:'ERROR',W:'WARNING',I:'INFO',IM:'IMPORTANT',D:'DEBUG',L:'LOG',CO:'CONSTANT',FU:'FUNCTION',R:'RETURN',V:'VARIABLE',S:'STACK',RE:'RESULT',ST:'STOPPER',TI:'TIMER',T:'TRACE'};LOG_LEVEL={NONE:7,OFF:7,FATAL:6,ERROR:5,WARN:4,INFO:3,UNDEFINED:2,'':2,DEFAULT:2,DEBUG:2,TRACE:1,ON:0,ALL:0,};LOG_STATUS={OFF:LOG_LEVEL.OFF,NONE:LOG_LEVEL.OFF,NO:LOG_LEVEL.OFF,NOPE:LOG_LEVEL.OFF,FALSE:LOG_LEVEL.OFF,FATAL:LOG_LEVEL.FATAL,BUG:LOG_LEVEL.ERROR,CRITICAL:LOG_LEVEL.ERROR,ERROR:LOG_LEVEL.ERROR,WARNING:LOG_LEVEL.WARN,INFO:LOG_LEVEL.INFO,IMPORTANT:LOG_LEVEL.INFO,DEBUG:LOG_LEVEL.DEBUG,LOG:LOG_LEVEL.DEBUG,STACK:LOG_LEVEL.DEBUG,CONSTANT:LOG_LEVEL.DEBUG,FUNCTION:LOG_LEVEL.DEBUG,VARIABLE:LOG_LEVEL.DEBUG,RETURN:LOG_LEVEL.DEBUG,RESULT:LOG_LEVEL.TRACE,STOPPER:LOG_LEVEL.TRACE,TIMER:LOG_LEVEL.TRACE,TRACE:LOG_LEVEL.TRACE,ALL:LOG_LEVEL.ALL,YES:LOG_LEVEL.ALL,YEP:LOG_LEVEL.ALL,TRUE:LOG_LEVEL.ALL};var logFile,logFolder;var LOG=function(message,status,icon){if(LOG.level!==LOG_LEVEL.OFF&&(LOG.write||LOG.store)&&LOG.arguments.length)return LOG.addMessage(message,status,icon);};LOG.logDecodeLevel=function(level){if(level==~~level)return Math.abs(level);var lev;level+='';level=level.toUpperCase();if(level in statuses){level=statuses[level];}lev=LOG_LEVEL[level];if(lev!==undefined)return lev;lev=LOG_STATUS[level];if(lev!==undefined)return lev;return LOG_LEVEL.DEFAULT;};LOG.write=write;LOG.store=store;LOG.level=LOG.logDecodeLevel(level);LOG.status=defaultStatus;LOG.addMessage=function(message,status,icon){var date=new Date(),count,bool,logStatus;if(status&&status.constructor.name==='String'){status=status.toUpperCase();status=statuses[status]||status;}else status=LOG.status;logStatus=LOG_STATUS[status]||LOG_STATUS.ALL;if(logStatus<LOG.level)return;date=' \t['+date+' '+date.getMilliseconds()+'ms]';status='['+status+'] ';if(status.length<11)status=(status+'           ').substr(0,11);if(icon){icon=(''+icon).toUpperCase();icon=(icon in icons&&icons[icon])||'';}else{icon='';}if(LOG.count!==~~LOG.count){LOG.count=1;}count=(LOG.count>999)?'['+LOG.count+'] ':('   ['+LOG.count+'] ').slice(-7);message=count+status+icon+(message instanceof Object?message.toSource():message)+date;if(LOG.store){stack.push(message);}if(LOG.write){bool=file&&file.writable&&logFile.writeln(message);if(!bool){file.writable=true;LOG.setFile(logFile);logFile.writeln(message);}}LOG.count++;return true;};var logNewFile=function(file,isCookie,overwrite){file.encoding='UTF-8';file.lineFeed=($.os[0]=='M')?'Macintosh':' Windows';if(isCookie)return file.open(overwrite?'w':'e')&&file;file.writable=LOG.write;logFile=file;logFolder=file.parent;if(continuing){LOG.count=LOG.setCount(file);}return(!LOG.write&&file||(file.open('a')&&file));};LOG.setFile=function(file,isCookie,overwrite){var bool,folder,fileName,suffix,newFileName,f,d,safeFileName;d=new Date();f=$.stack.split("\n")[0].replace(/^\[\(?/,'').replace(/\)?\]$/,'');if(f==~~f){f=$.fileName.replace(/[^\/]+\//g,'');}safeFileName=File.encode((isCookie?'/COOKIE_':'/LOG_')+f.replace(/^\//,'')+'_'+(1900+d.getYear())+(''+d).replace(/...(...)(..).+/,'_$1_$2')+(isCookie?'.txt':'.log'));if(file&&file.constructor.name=='String'){file=(file.match('/'))?new File(file):new File((logFolder||Folder.temp)+'/'+file);}if(file instanceof File){folder=file.parent;bool=folder.exists||folder.create();if(!bool)folder=Folder.temp;fileName=File.decode(file.name);suffix=fileName.match(/\.[^.]+$/);suffix=suffix?suffix[0]:'';fileName='/'+fileName;newFileName=fileName.replace(/\.[^.]+$/,'')+'_'+(+(new Date())+suffix);f=logNewFile(file,isCookie,overwrite);if(f)return f;f=logNewFile(new File(folder+newFileName),isCookie,overwrite);if(f)return f;f=logNewFile(new File(folder+safeFileName),isCookie,overwrite);if(f)return f;if(folder!=Folder.temp){f=logNewFile(new File(Folder.temp+fileName),isCookie,overwrite);if(f)return f;f=logNewFile(new File(Folder.temp+safeFileName),isCookie,overwrite);return f||new File(Folder.temp+safeFileName);}}return LOG.setFile(((logFile&&!isCookie)?new File(logFile):new File(Folder.temp+safeFileName)),isCookie,overwrite );};LOG.setCount=function(file){if(~~file===file){LOG.count=file;return LOG.count;}if(file===undefined){file=logFile;}if(file&&file.constructor===String){file=new File(file);}var logNumbers,contents;if(!file.length||!file.exists){LOG.count=1;return 1;}file.open('r');file.encoding='utf-8';file.seek(10000,2);contents='\n'+file.read();logNumbers=contents.match(/\n{0,3}\[\d+\] \[\w+\]+/g);if(logNumbers){logNumbers=+logNumbers[logNumbers.length-1].match(/\d+/)+1;file.close();LOG.count=logNumbers;return logNumbers;}if(file.length<10001){file.close();LOG.count=1;return 1;}file.seek(10000000,2);contents='\n'+file.read();logNumbers=contents.match(/\n{0,3}\[\d+\] \[\w+\]+/g);if(logNumbers){logNumbers=+logNumbers[logNumbers.length-1].match(/\d+/)+1;file.close();LOG.count=logNumbers;return logNumbers;}file.close();LOG.count=1;return 1;};LOG.setLevel=function(level){LOG.level=LOG.logDecodeLevel(level);return LOG.level;};LOG.setStatus=function(status){status=(''+status).toUpperCase();LOG.status=statuses[status]||status;return LOG.status;};LOG.cookie=function(file,level,overwrite,setLevel){var log,cookie;if(!file){file={file:file};}if(file&&(file.constructor===String||file.constructor===File)){file={file:file};}log=file;if(log.level===undefined){log.level=(level!==undefined)?level:'NONE';}if(log.overwrite===undefined){log.overwrite=(overwrite!==undefined)?overwrite:false;}if(log.setLevel===undefined){log.setLevel=(setLevel!==undefined)?setLevel:true;}setLevel=log.setLevel;overwrite=log.overwrite;level=log.level;file=log.file;file=LOG.setFile(file,true,overwrite);if(overwrite){file.write(level);}else{cookie=file.read();if(cookie.length){level=cookie;}else{file.write(level);}}file.close();if(setLevel){LOG.setLevel(level);}return{path:file,level:level};};LOG.args=function(args,funct,line){if(LOG.level>LOG_STATUS.FUNCTION)return;if(!(args&&(''+args.constructor).replace(/\s+/g,'')==='functionObject(){[nativecode]}'))return;if(!LOG.args.STRIP_COMMENTS){LOG.args.STRIP_COMMENTS=/((\/.*$)|(\/\*[\s\S]*?\*\/))/mg;}if(!LOG.args.ARGUMENT_NAMES){LOG.args.ARGUMENT_NAMES=/([^\s,]+)/g;}if(!LOG.args.OUTER_BRACKETS){LOG.args.OUTER_BRACKETS=/^\((.+)?\)$/;}if(!LOG.args.NEW_SOMETHING){LOG.args.NEW_SOMETHING=/^new \w+\((.+)?\)$/;}var functionString,argumentNames,stackInfo,report,functionName,arg,argsL,n,argName,argValue,argsTotal;if(funct===~~funct){line=funct;}if(!(funct instanceof Function)){funct=args.callee;}if(!(funct instanceof Function))return;functionName=funct.name;functionString=(''+funct).replace(LOG.args.STRIP_COMMENTS,'');argumentNames=functionString.slice(functionString.indexOf('(')+1,functionString.indexOf(')')).match(LOG.args.ARGUMENT_NAMES);argumentNames=argumentNames||[];report=[];report.push('--------------');report.push('Function Data:');report.push('--------------');report.push('Function Name:'+functionName);argsL=args.length;stackInfo=$.stack.split(/[\n\r]/);stackInfo.pop();stackInfo=stackInfo.join('\n                              ');report.push('Call stack:'+stackInfo);if(line){report.push('Function Line around:'+line);}report.push('Arguments Provided:'+argsL);report.push('Named Arguments:'+argumentNames.length);if(argumentNames.length){report.push('Arguments Names:'+argumentNames.join(','));}if(argsL){report.push('----------------');report.push('Argument Values:');report.push('----------------');}argsTotal=Math.max(argsL,argumentNames.length);for(n=0;n<argsTotal;n++){argName=argumentNames[n];arg=args[n];if(n>=argsL){argValue='NO VALUE PROVIDED';}else if(arg===undefined){argValue='undefined';}else if(arg===null){argValue='null';}else{argValue=arg.toSource().replace(LOG.args.OUTER_BRACKETS,'$1').replace(LOG.args.NEW_SOMETHING,'$1');}report.push((argName?argName:'arguments['+n+']')+':'+argValue);}report.push('');report=report.join('\n                  ');LOG(report,'f');return report;};LOG.stack=function(reverse){var st=$.stack.split('\n');st.pop();st.pop();if(reverse){st.reverse();}return LOG(st.join('\n                  '),'s');};LOG.values=function(values){var n,value,map=[];if(!(values instanceof Object||values instanceof Array)){return;}if(!LOG.values.OUTER_BRACKETS){LOG.values.OUTER_BRACKETS=/^\((.+)?\)$/;}if(!LOG.values.NEW_SOMETHING){LOG.values.NEW_SOMETHING=/^new \w+\((.+)?\)$/;}for(n in values){try{value=values[n];if(value===undefined){value='undefined';}else if(value===null){value='null';}else{value=value.toSource().replace(LOG.values.OUTER_BRACKETS,'$1').replace(LOG.values.NEW_SOMETHING,'$1');}}catch(e){value='\uD83D\uDEAB '+e;}map.push(n+':'+value);}if(map.length){map=map.join('\n                  ')+'\n                  ';return LOG(map,'v');}};LOG.reset=function(all){stack.length=0;LOG.count=1;if(all!==false){if(logFile instanceof File){logFile.close();}logFile=LOG.store=LOG.writeToFile=undefined;LOG.write=true;logFolder=Folder.temp;logTime=new Date();logPoint='After Log Reset';}};LOG.stopper=function(message){var newLogTime,t,m,newLogPoint;newLogTime=new Date();newLogPoint=(LOG.count!==undefined)?'LOG#'+LOG.count:'BEFORE LOG#1';LOG.time=t=newLogTime-logTime;if(message===false){return;}message=message||'Stopper start point';t=LOG.prettyTime(t);m=message+'\n                  '+'From '+logPoint+' to '+newLogPoint+' took '+t+' Starting '+logTime+' '+logTime.getMilliseconds()+'ms'+' Ending '+newLogTime+' '+newLogTime.getMilliseconds()+'ms';LOG(m,'st');logPoint=newLogPoint;logTime=newLogTime;return m;};LOG.start=function(message){var t=new Date();times.push([t,(message!==undefined)?message+'':'']);};LOG.stop=function(message){if(!times.length)return;message=(message)?message+' ':'';var nt,startLog,ot,om,td,m;nt=new Date();startLog=times.pop();ot=startLog[0];om=startLog[1];td=nt-ot;if(om.length){om+=' ';}m=om+'STARTED ['+ot+' '+ot.getMilliseconds()+'ms]\n                  '+message+'FINISHED ['+nt+' '+nt.getMilliseconds()+'ms]\n                  TOTAL TIME ['+LOG.prettyTime(td)+']';LOG(m,'ti');return m;};LOG.prettyTime=function(t){var h,m,s,ms;h=Math.floor(t / 3600000);m=Math.floor((t % 3600000)/ 60000);s=Math.floor((t % 60000)/ 1000);ms=t % 1000;t=(!t)?'<1ms':((h)?h+' hours ':'')+((m)?m+' minutes ':'')+((s)?s+' seconds ':'')+((ms&&(h||m||s))?'&':'')+((ms)?ms+'ms':'');return t;};LOG.get=function(){if(!stack.length)return 'THE LOG IS NOT SET TO STORE';var a=fetchLogLines(arguments);return a?'\n'+a.join('\n'):'NO LOGS AVAILABLE';};var fetchLogLines=function(){var args=arguments[0];if(!args.length)return stack;var c,n,l,a=[],ln,start,end,j,sl;l=args.length;sl=stack.length-1;n=0;for(c=0;c<l;c++){ln=args[c];if(~~ln===ln){ln=(0>ln)?sl+ln+1:ln-1;if(ln>=0&&ln<=sl)a[n++]=stack[ln];}else if(ln instanceof Array&&ln.length===2){start=ln[0];end=ln[1];if(!(~~start===start&&~~end===end))continue;start=(0>start)?sl+start+1:start-1;end=(0>end)?sl+end+1:end-1;start=Math.max(Math.min(sl,start),0);end=Math.min(Math.max(end,0),sl);if(start<=end)for(j=start;j<=end;j++)a[n++]=stack[j];else for(j=start;j>=end;j--)a[n++]=stack[j];}}return(n)?a:false;};LOG.file=function(){return logFile;};LOG.openFolder=function(){if(logFolder)return logFolder.execute();};LOG.show=LOG.execute=function(){if(logFile)return logFile.execute();};LOG.close=function(){if(logFile)return logFile.close();};LOG.setFile(file);if(!$.summary.difference){$.summary.difference=function(){return $.summary().replace(/ *([0-9]+)([^ ]+)(\n?)/g,$.summary.updateSnapshot );};}if(!$.summary.updateSnapshot){$.summary.updateSnapshot=function(full,count,name,lf){var snapshot=$.summary.snapshot;count=Number(count);var prev=snapshot[name]?snapshot[name]:0;snapshot[name]=count;var diff=count-prev;if(diff===0)return "";return "     ".substring(String(diff).length)+diff+" "+name+lf;};}if(!$.summary.snapshot){$.summary.snapshot=[];$.summary.difference();}$.gc();$.gc();$.summary.difference();LOG.sumDiff=function(message){$.gc();$.gc();var diff=$.summary.difference();if(diff.length<8){diff=' - NONE -';}if(message===undefined){message='';}message+=diff;return LOG('$.summary.difference():'+message,'v');};return LOG;};

// LogFactory.jsx Ver 1 By Trevor 6rd Mar 2017 http://www.creative-scripts.com/logging-with-a-smile/ Provided 'as is', with no warranty whatsoever. This line may not be removed.

NOTE: For all the snippets below and for general usage of the API either paste the above 2 lines or the verbose 949 line version to the beginning of your code or include it by using the #include directive.
The full API is explained below and the full readable LogFactory.jsx script can be found at the end of the post.

Included Features:
Leveled logging (See below for the meaning of this if you don't know) 👀
Writing and reading level cookies so the log level can be changed without changing the script 👀
Multiple instances of log files 👀
Writing the log to the computers memory and extracting entry ranges of the log 👀
Methods for logging all the arguments of a function and values of variables 👀
A method for logging new objects created as per the $.summary() result 👀
A method for showing the call stack 👀
Different timing methods 👀
🐥 Most importantly easily and quickly produces clear numbered logs with their status and time stamp 👀
And last and least emoji's 🤓

Note:
🤐 The script is made for use on almost all of Adobe's scriptable applications (Acrobat being a noticeable exception) which run extended script. It will not function as is from the js side of an extension, changing the file functions here to work in an extension and or NodeJS environment should be a very simple task. If there's enough demand, maybe I'll do it.
🤐 The script could have been written more efficiently if it was written on a ProtoType bases, I did not do this as I wanted to just be able to add logs using the simple command log('foo'); and not something like console.log('foo');. O.k. I know I could have got around that easily using other methods like function log(){return console.log(arguments);} but the method as it is handles thousands of logs per second and is not going to blow the systems memory so there you have it. I have a simple NodeJS version that can easily vomit 100,000 logs per second, but 10,000 / second should cover most needs.

Snippet

var log = new LogFactory('myLog.log'); // =>; creates the new log factory
                            // as no Folder has been specified in the path the temp folder will be used
log('Hello', 'i', 'happy'); //=> [1] [INFO]     😃Hello [Sun Mar 05 2017 09:57:23 GMT+0200 332ms]
log('Drat', 'e');           //=> [2] [ERROR]    Drafter the shorter loot [Sun Mar 05 2017 09:57:23 GMT+0200 332ms]
log('42', 'I', 'hand');     //=> [3] [IMPORTANT] 👉42 [Sun Mar 05 2017 09:57:23 GMT+0200 332ms]
log('Bye');                 //=> [4] [LOG]      bye [Sun Mar 05 2017 09:57:23 GMT+0200 332ms]
log.show();                 //=> Opens the log file with the default application

var log = new LogFactory('myLog.log'); // =>; creates the new log factory

// as no Folder has been specified in the path the temp folder will be used

log('Hello', 'i', 'happy'); //=> [1] [INFO] 😃Hello [Sun Mar 05 2017 09:57:23 GMT+0200 332ms]

log('Drat', 'e'); //=> [2] [ERROR] Drafter the shorter loot [Sun Mar 05 2017 09:57:23 GMT+0200 332ms]

log('42', 'I', 'hand'); //=> [3] [IMPORTANT] 👉42 [Sun Mar 05 2017 09:57:23 GMT+0200 332ms]

log('Bye'); //=> [4] [LOG] bye [Sun Mar 05 2017 09:57:23 GMT+0200 332ms]

log.show(); //=> Opens the log file with the default application

Log Produced

 [1] [INFO]     😃Hello     [Sun Mar 05 2017 09:57:23 GMT+0200 332ms]
 [2] [ERROR]    Drat     [Sun Mar 05 2017 09:57:23 GMT+0200 332ms]
 [3] [IMPORTANT] 👉42     [Sun Mar 05 2017 09:57:23 GMT+0200 332ms]
 [4] [LOG]      bye     [Sun Mar 05 2017 09:57:23 GMT+0200 332ms]

[1] [INFO] 😃Hello [Sun Mar 05 2017 09:57:23 GMT+0200 332ms]

[2] [ERROR] Drat [Sun Mar 05 2017 09:57:23 GMT+0200 332ms]

[3] [IMPORTANT] 👉42 [Sun Mar 05 2017 09:57:23 GMT+0200 332ms]

[4] [LOG] bye [Sun Mar 05 2017 09:57:23 GMT+0200 332ms]

Quick Links
LogFactory.jsx, 💾 DOWNLOAD, 🗜Download Squished Version, LOG, Log Methods, Log Properties, args(), close(), cookie(), execute(), file(), get(), openFolder(), reset(), setCount(), setFile(), setLevel(), setStatus(), show(), stack(), start(), stop(), stopper(), sumDiff(), values()

LogFactory.jsx API For easy creation of leveled logs

LogFactory(file, write, store, level, status, continuing) The LogFactory function is used for the creation of the log factory. It returns the LOG function, the LOG function has different arguments than the LogFactory function they are explained below.
PARAMETER	TYPE	DESCRIPTION
file	String or File Object	Accepts either the File Object or a String of the full path to the log or just the file name of the log in which case it will be place in the systems temporary folder. [Optional – default: If a path was previously set then that path will be used otherwise the log file will be created in the temporary folder and called LOG_Script Name_Year_Month_Date.log for example LOG_Script2_2017_Feb_21.log]. See the note to the log.setFile() method.
write	Boolean	If to write the logs to disk [Optional – default: true]. See the note to the log.setFile() method.
store	Boolean	If to store the logs in the computers memory [Optional – default: false]. See the note to the log.get() method.
level	String or Integer	The level from which to record the log [Optional – default: 2]. See the log.setLevel() method.
status	String	The default log status [Optional – default: LOG]. See the log.setLevel() and log.setStatus() methods.
continuing	Boolean	If the log count should continue from the last count in an existing file [Optional – default: false]. See the note to the log.setCount() method.
RETURNS	Function	The created LOG factory function
NOTES	The LogFactory function should always be preceded with the `new` word i.e. `var log = new LogFactory();`

/////////////////////////////////////////////////////////
// Multiple log files can be simultaneously maintained //
//                                                     //
// Best to feed multiple arguments with an object.     //
// argument that are not set will get a default value  //
/////////////////////////////////////////////////////////

var log = new LogFactory({
    file: '~/Desktop/myLog.log',
    write: 1,
    store: 1,
    level: 'all',
    status: 'INFO',
    continuing: true
});

// Often you might only want to set 2 values or 3 values
var fatalLog = new LogFactory({ file: 'fatal.log', level: 'fatal', status: 'FATAL' });

//////////////////////////////////////////////////////////////////////////////////
// You can feed arguments directly, BUT this is  VERY not recommended           //
// Use the object method above instead unless you're just setting the file path //
//////////////////////////////////////////////////////////////////////////////////

var criticalLog = new LogFactory('~/Desktop/criticalLog.log', true, false, 'CRITICAL', 'CRITICAL', true);

/////////////////////////////////////////////////////////////////////
// If your just setting the file name then can just use, that's OK //
/////////////////////////////////////////////////////////////////////

var myLog = new LogFactory('myLog.log');

///////////////////////////////////////////////////////////////////////////////////////////////////
// Or you can use all the defaults                                                               //
// The file path will be set to /temp/1485092385033.log where 1485092385033 is the JS Date       //
// The log will write to the file                                                                //
// The log will not be stored in memory                                                          //
// Any status of 'DEBUG' and higher will be recorded lower statuses will not                     //
// The default status will be set to 'LOG'                                                       //
// The log count start at 1                                                                      //
///////////////////////////////////////////////////////////////////////////////////////////////////
var log2 = new LogFactory();

/////////////////////////////////////////////////////////

// Multiple log files can be simultaneously maintained //

// //

// Best to feed multiple arguments with an object. //

// argument that are not set will get a default value //

/////////////////////////////////////////////////////////

var log = new LogFactory({

file: '~/Desktop/myLog.log',

write: 1,

store: 1,

level: 'all',

status: 'INFO',

continuing: true

});

// Often you might only want to set 2 values or 3 values

var fatalLog = new LogFactory({ file: 'fatal.log', level: 'fatal', status: 'FATAL' });

//////////////////////////////////////////////////////////////////////////////////

// You can feed arguments directly, BUT this is VERY not recommended //

// Use the object method above instead unless you're just setting the file path //

//////////////////////////////////////////////////////////////////////////////////

var criticalLog = new LogFactory('~/Desktop/criticalLog.log', true, false, 'CRITICAL', 'CRITICAL', true);

/////////////////////////////////////////////////////////////////////

// If your just setting the file name then can just use, that's OK //

/////////////////////////////////////////////////////////////////////

var myLog = new LogFactory('myLog.log');

///////////////////////////////////////////////////////////////////////////////////////////////////

// Or you can use all the defaults //

// The file path will be set to /temp/1485092385033.log where 1485092385033 is the JS Date //

// The log will write to the file //

// The log will not be stored in memory //

// Any status of 'DEBUG' and higher will be recorded lower statuses will not //

// The default status will be set to 'LOG' //

// The log count start at 1 //

///////////////////////////////////////////////////////////////////////////////////////////////////

var log2 = new LogFactory();

LOG(message, status, icon) After instantiating the log factory one has access to the LOG function. All methods and properties used in managing the log output after its creation are via the LOG function.
PARAMETER	TYPE	DESCRIPTION
message	All Types	The message to be sent to the log. If no argument is placed in the log function then no logging will occur, however if `undefined` is passed then the string undefined will be logged. Any type of value can be passed, see the examples below.
status	String	The status to give the entry. Different statuses are assigned different log levels, this point is explained in the log level section below. Any string may be use, recognized statuses may be referred to with the abbreviations listed below. The statuses and their abbreviations are not case sensitive and will always be outputted in uppercase. Only entries matching or greater than the logging level will be added. Level 0 – Custom statuses Level 1 – RE: 'RESULT', ST: 'STOPPER', TI: 'TIMER', T: 'TRACE' Level 2 – D: 'DEBUG', L: 'LOG', CO: 'CONSTANT', F: 'FUNCTION', R: 'RETURN', V: 'VARIABLE', S: 'STACK' Level 3 – I: 'INFO', IM: 'IMPORTANT' Level 4 – W: 'WARNING' Level 5 – B: 'BUG', C: 'CRITICAL', E: 'ERROR' Level 6 – FA: 'FATAL' [Optional – default: the set default status – "LOG" if default status was not set]
icon	String	The icon to precede the message [Optional – default: no icon] Recognized icons: 1: 🕐, 130: 🕜, 2: 🕑, 230: 🕝, 3: 🕒, 330: 🕞, 4: 🕓, 430: 🕟, 5: 🕔, 530: 🕠, 6: 🕕, 630: 🕡, 7: 🕖, 730: 🕢, 8: 🕗, 830: 🕣, 9: 🕘, 930: 🕤, 10: 🕙, 1030: 🕥, 11: 🕚, 1130: 🕦, 12: 🕛, 1230: 🕧, AIRPLANE: 🛩, ALARM: ⏰, AMBULANCE: 🚑, ANCHOR: ⚓, ANGRY: 😠, ANGUISHED: 😧, ANT: 🐜, ANTENNA: 📡, APPLE: 🍏, APPLE2: 🍎, ATM: 🏧, ATOM: ⚛, BABYBOTTLE: 🍼, BAD: 👎, BANANA: 🍌, BANDAGE: 🤕, BANK: 🏦, BATTERY: 🔋, BED: 🛏, BEE: 🐝, BEER: 🍺, BELL: 🔔, BELLOFF: 🔕, BIRD: 🐦, BLACKFLAG: 🏴, BLUSH: 😊, BOMB: 💣, BOOK: 📕, BOOKMARK: 🔖, BOOKS: 📚, BOW: 🏹, BOWLING: 🎳, BRIEFCASE: 💼, BROKEN: 💔, BUG: 🐛, BUILDING: 🏛, BUILDINGS: 🏘, BULB: 💡, BUS: 🚌, CACTUS: 🌵, CALENDAR: 📅, CAMEL: 🐪, CAMERA: 📷, CANDLE: 🕯, CAR: 🚘, CAROUSEL: 🎠, CASTLE: 🏰, CATEYES: 😻, CATJOY: 😹, CATMOUTH: 😺, CATSMILE: 😼, CD: 💿, CHECK: ✔, CHEQFLAG: 🏁, CHICK: 🐥, CHICKEN: 🐔, CHICKHEAD: 🐤, CIRCLEBLACK: ⚫, CIRCLEBLUE: 🔵, CIRCLERED: 🔴, CIRCLEWHITE: ⚪, CIRCUS: 🎪, CLAPPER: 🎬, CLAPPING: 👏, CLIP: 📎, CLIPBOARD: 📋, CLOUD: 🌨, CLOVER: 🍀, CLOWN: 🤡, COLDSWEAT: 😓, COLDSWEAT2: 😰, COMPRESS: 🗜, CONFOUNDED: 😖, CONFUSED: 😕, CONSTRUCTION: 🚧, CONTROL: 🎛, COOKIE: 🍪, COOKING: 🍳, COOL: 😎, COOLBOX: 🆒, COPYRIGHT: ©, CRANE: 🏗, CRAYON: 🖍, CREDITCARD: 💳, CROSS: ✖, CROSSBOX: ❎, CRY: 😢, CRY2: 😥, CRYCAT: 😿, CRYSTALBALL: 🔮, CUSTOMS: 🛃, DELICIOUS: 😋, DERELICT: 🏚, DESKTOP: 🖥, DIAMONDLB: 🔷, DIAMONDLO: 🔶, DIAMONDSB: 🔹, DIAMONDSO: 🔸, DICE: 🎲, DISAPPOINTED: 😞, DIVISION: ➗, DIZZY: 😵, DOLLAR: 💵, DOLLAR2: 💲, DOWNARROW: ⬇, DVD: 📀, EJECT: ⏏, ELEPHANT: 🐘, EMAIL: 📧, ENVELOPE: 📨, ENVELOPE2: ✉, ENVELOPE_DOWN: 📩, EURO: 💶, EVIL: 😈, EXPRESSIONLESS: 😑, EYES: 👀, FACTORY: 🏭, FAX: 📠, FEARFUL: 😨, FILEBOX: 🗃, FILECABINET: 🗄, FIRE: 🔥, FIREENGINE: 🚒, FIST: 👊, FLOWER: 🌷, FLOWER2: 🌸, FLUSHED: 😳, FOLDER: 📁, FOLDER2: 📂, FREE: 🆓, FROG: 🐸, FROWN: 🙁, GEAR: ⚙, GLOBE: 🌍, GLOWINGSTAR: 🌟, GOOD: 👍, GRIMACING: 😬, GRIN: 😀, GRINNINGCAT: 😸, HALO: 😇, HAMMER: 🔨, HAMSTER: 🐹, HAND: ✋, HANDDOWN: 👇, HANDLEFT: 👈, HANDRIGHT: 👉, HANDUP: 👆, HATCHING: 🐣, HAZARD: ☣, HEADPHONE: 🎧, HEARNOEVIL: 🙉, HEARTBLUE: 💙, HEARTEYES: 😍, HEARTGREEN: 💚, HEARTYELLOW: 💛, HELICOPTER: 🚁, HERB: 🌿, HIGH_BRIGHTNESS: 🔆, HIGHVOLTAGE: ⚡, HIT: 🎯, HONEY: 🍯, HOT: 🌶, HOURGLASS: ⏳, HOUSE: 🏠, HUGGINGFACE: 🤗, HUNDRED: 💯, HUSHED: 😯, ID: 🆔, INBOX: 📥, INDEX: 🗂, JOY: 😂, KEY: 🔑, KISS: 😘, KISS2: 😗, KISS3: 😙, KISS4: 😚, KISSINGCAT: 😽, KNIFE: 🔪, LABEL: 🏷, LADYBIRD: 🐞, LANDING: 🛬, LAPTOP: 💻, LEFTARROW: ⬅, LEMON: 🍋, LIGHTNINGCLOUD: 🌩, LINK: 🔗, LITTER: 🚮, LOCK: 🔒, LOLLIPOP: 🍭, LOUDSPEAKER: 📢, LOW_BRIGHTNESS: 🔅, MAD: 😜, MAGNIFYING_GLASS: 🔍, MASK: 😷, MEDAL: 🎖, MEMO: 📝, MIC: 🎤, MICROSCOPE: 🔬, MINUS: ➖, MOBILE: 📱, MONEY: 💰, MONEYMOUTH: 🤑, MONKEY: 🐵, MOUSE: 🐭, MOUSE2: 🐁, MOUTHLESS: 😶, MOVIE: 🎥, MUGS: 🍻, NERD: 🤓, NEUTRAL: 😐, NEW: 🆕, NOENTRY: 🚫, NOTEBOOK: 📔, NOTEPAD: 🗒, NUTANDBOLT: 🔩, O: ⭕, OFFICE: 🏢, OK: 🆗, OKHAND: 👌, OLDKEY: 🗝, OPENLOCK: 🔓, OPENMOUTH: 😮, OUTBOX: 📤, PACKAGE: 📦, PAGE: 📄, PAINTBRUSH: 🖌, PALETTE: 🎨, PANDA: 🐼, PASSPORT: 🛂, PAWS: 🐾, PEN: 🖊, PEN2: 🖋, PENSIVE: 😔, PERFORMING: 🎭, PILL: 💊, PING: ❗, PLATE: 🍽, PLUG: 🔌, PLUS: ➕, POLICE: 🚓, POLICELIGHT: 🚨, POSTOFFICE: 🏤, POUND: 💷, POUTING: 😡, POUTINGCAT: 😾, PRESENT: 🎁, PRINTER: 🖨, PROJECTOR: 📽, PUSHPIN: 📌, QUESTION: ❓, RABBIT: 🐰, RADIOACTIVE: ☢, RADIOBUTTON: 🔘, RAINCLOUD: 🌧, RAT: 🐀, RECYCLE: ♻, REGISTERED: ®, RELIEVED: 😌, ROBOT: 🤖, ROCKET: 🚀, ROLLING: 🙄, ROOSTER: 🐓, RULER: 📏, SATELLITE: 🛰, SAVE: 💾, SCHOOL: 🏫, SCISSORS: ✂, SCREAMING: 😱, SCROLL: 📜, SEAT: 💺, SEEDLING: 🌱, SEENOEVIL: 🙈, SHIELD: 🛡, SHIP: 🚢, SHOCKED: 😲, SHOWER: 🚿, SLEEPING: 😴, SLEEPY: 😪, SLIDER: 🎚, SLOT: 🎰, SMILE: 🙂, SMILING: 😃, SMILINGCLOSEDEYES: 😆, SMILINGEYES: 😄, SMILINGSWEAT: 😅, SMIRK: 😏, SNAIL: 🐌, SNAKE: 🐍, SOCCER: ⚽, SOS: 🆘, SPEAKER: 🔈, SPEAKEROFF: 🔇, SPEAKNOEVIL: 🙊, SPIDER: 🕷, SPIDERWEB: 🕸, STAR: ⭐, STOP: ⛔, STOPWATCH: ⏱, SULK: 😦, SUNFLOWER: 🌻, SUNGLASSES: 🕶, SYRINGE: 💉, TAKEOFF: 🛫, TAXI: 🚕, PHONE: 📞, TELESCOPE: 🔭, TEMPORATURE: 🤒, TENNIS: 🎾, THERMOMETER: 🌡, THINKING: 🤔, THUNDERCLOUD: ⛈, TICKBOX: ✅, TICKET: 🎟, TIRED: 😫, TOILET: 🚽, TOMATO: 🍅, TONGUE: 😛, TOOLS: 🛠, TORCH: 🔦, TORNADO: 🌪, TOUNG2: 😝, TRADEMARK: ™, TRAFFICLIGHT: 🚦, TRASH: 🗑, TREE: 🌲, TRIANGLE_LEFT: ◀, TRIANGLE_RIGHT: ▶, TRIANGLEDOWN: 🔻, TRIANGLEUP: 🔺, TRIANGULARFLAG: 🚩, TROPHY: 🏆, TRUCK: 🚚, TRUMPET: 🎺, TURKEY: 🦃, TURTLE: 🐢, UMBRELLA: ⛱, UNAMUSED: 😒, UPARROW: ⬆, UPSIDEDOWN: 🙃, WARNING: ⚠, WATCH: ⌚, WAVING: 👋, WEARY: 😩, WEARYCAT: 🙀, WHITEFLAG: 🏳, WINEGLASS: 🍷, WINK: 😉, WORRIED: 😟, WRENCH: 🔧, X: ❌, YEN: 💴, ZIPPERFACE: 🤐
RETURNS	String	The created log entry
NOTES	The LogFactory function will only be used once at the creation of the factory. After it's creation only the LOG function is used. The reference to the LOG method will be the name of variable used for the creation of the new log factory. Our examples are based on `var log = new LogFactory();` The log output will be in the form of. `[1] [INFO] 💰Payment received [Sun Mar 05 2017 10:05:02 GMT+0200 562ms]` `[Line number] [Status] (icon)message [Day Month Date Year Hours:Minutes:Seconds Time zone ms]`

Examples

var log = new LogFactory('myLog.log');
log(); 	              // => Won't do anything
log(undefined);       // => Will log the word "undefined" with the default "LOG" status
log('Hello');
log('Death', 'fa');   // => Will log the word "Death" with the default "FATAL" status
log('Payment received', 'i', 'money'); // => Will add an Icon

var log = new LogFactory('myLog.log');

log(); // => Won't do anything

log(undefined); // => Will log the word "undefined" with the default "LOG" status

log('Hello');

log('Death', 'fa'); // => Will log the word "Death" with the default "FATAL" status

log('Payment received', 'i', 'money'); // => Will add an Icon

Log Produced

   [1] [LOG]      undefined 	[Fri Feb 24 2017 00:19:29 GMT+0200 162ms]
   [2] [LOG]      Hello 	[Fri Feb 24 2017 00:19:29 GMT+0200 163ms]
   [3] [FATAL]    Death 	[Fri Feb 24 2017 00:19:29 GMT+0200 164ms]
   [4] [INFO]     💰Payment received 	[Fri Feb 24 2017 00:19:29 GMT+0200 165ms]

[1] [LOG] undefined [Fri Feb 24 2017 00:19:29 GMT+0200 162ms]

[2] [LOG] Hello [Fri Feb 24 2017 00:19:29 GMT+0200 163ms]

[3] [FATAL] Death [Fri Feb 24 2017 00:19:29 GMT+0200 164ms]

[4] [INFO] 💰Payment received [Fri Feb 24 2017 00:19:29 GMT+0200 165ms]

LOG METHODS

METHOD	DESCRIPTION
setLevel	Sets the level from which the logs should be logged. This can also be set at the creation of the log factory using the level parameter of the LogFactory function.
cookie	For reading and writing log level cookies for for the setting of the log level.
setStatus	For setting the default log status. This can also be set at the creation of the log factory using the status parameter of the LogFactory function.
setFile	For setting file were the log will be written to. This can also be set at the creation of the log factory using the file parameter of the LogFactory function.
get	For retrieving individual or ranges of log entries. This will only work if the store parameter of the LogFactory function or the `log.store` argument are set to true
args	Logs information about a function and it's augments. This is a nice method and worth looking at even if the rest of the post doesn't interest you
values	Logs the values of an object or array.
sumDiff	Shows the difference between $.summary() calls. Cheers Dirk 🍺
stack	Logs the call stack.
file	Returns the log file object (if there is one).
execute	Opens the log file with the systems default application for opening the files with the suffix you have allocated to the log.
show	This method is exactly the same as the show execute.
openFolder	Opens the log folder containing the log file with Finder or Windows Explorer.
close	Closes the log file.
setCount	Sets the log count for the next log entry.
reset	Resets the log factory to more or less it's default settings.
stopper	For timing between 2 points.
start	Registers a start point that will be matched by a pairing log.stop() call for timing purposes.
stop	Logs timing information from a matching start point created using log.start().
NOTES	Click the method to jump to it.

LOG PROPERTIES

PROPERTY	TYPE	DESCRIPTION
count	Integer	The count of the next log entry. See also the log.setCount() method.
level	Integer	Sets the minimum log level from which logs are processed It is normally recommended to set the value either on creating the new LogFactory using `log = new LogFactory({level: 'DEBUG'});` or the log.setLevel() and log.cookie() methods all of which accept Strings and not just Integers which are the only valid type that the log.level accepts. See below "Log Levels and Statuses"
status	String	The default log status. Can be set on creating the new LogFactory using `log = new LogFactory({status: 'ERROR'});` or by using the log.setStatus() methods.
store	Boolean	If to store the logs in the computers memory Can be set on creating the new LogFactory using `log = new LogFactory({store: true});` See the log.get() method for the purpose of doing this.
write	Boolean	If to write the logs to disk Can be set on creating the new LogFactory using `log = new LogFactory({write: false});`

Log Levels and Statuses
Each status has an associated log level assigned to it, these are listed below, by changing the log level one can filter out which log entries will be processed. You might while developing a script want to set the log level to log all debug logs and when done with debugging change the log level to error of fatal so only those levels will be logged.
The logging level can either be set on the creation of the log factory or by using the log.setLevel() method or by directly setting the log.level value.

//////////////////////////////////////////////////////////////////////////////
// Setting the log level with an object argument at the LogFactory creation //
//////////////////////////////////////////////////////////////////////////////
var log = new LogFactory({file: 'myLog.log', level: 'error'});

///////////////////////////////////////////////////////////////////////
// Setting (or changing) the log level after the LogFactory creation //
// Using the setLevel() Method                                       //
///////////////////////////////////////////////////////////////////////
log.setLevel('I'); // I is short for INFO 

///////////////////////////////////////////////////////////////
// Setting the log level directly at the LogFactory creation //
// NOT RECOMMENDED                                           //
///////////////////////////////////////////////////////////////
var log = new LogFactory('myLog.log', undefined, undefined, 'trace');

///////////////////////////////////////////////////////////////////////
// Setting (or changing) the log level after the LogFactory creation //
// Using the level property                                          //
///////////////////////////////////////////////////////////////////////
log.level = 2;

//////////////////////////////////////////////////////////////////////////////

// Setting the log level with an object argument at the LogFactory creation //

//////////////////////////////////////////////////////////////////////////////

var log = new LogFactory({file: 'myLog.log', level: 'error'});

///////////////////////////////////////////////////////////////////////

// Setting (or changing) the log level after the LogFactory creation //

// Using the setLevel() Method //

///////////////////////////////////////////////////////////////////////

log.setLevel('I'); // I is short for INFO

///////////////////////////////////////////////////////////////

// Setting the log level directly at the LogFactory creation //

// NOT RECOMMENDED //

///////////////////////////////////////////////////////////////

var log = new LogFactory('myLog.log', undefined, undefined, 'trace');

///////////////////////////////////////////////////////////////////////

// Setting (or changing) the log level after the LogFactory creation //

// Using the level property //

///////////////////////////////////////////////////////////////////////

log.level = 2;

log.setLevel(level) Sets the level from which the logs should be logged.
PARAMETER	TYPE	DESCRIPTION
level	String or Integer	The level from which the logs should be logged. Any of the below values may be used, they are not case-sensitive. Each row of levels 0, ALL, YES, YEP, TRUE 1, TRACE, RESULT, STOPPER, TIMER, tr, re, st, ti, t 2, DEBUG, LOG, STACK, CONSTANT, FUNCTION, VARIABLE, RETURN, d, l, co, f, r, v, s 3, INFO, IMPORTANT, ON, i, im 4, WARN, WARNING, w 5, ERROR, BUG, CRITICAL, e, b, c 6, FATAL, FA 7, NONE, OFF, NONE, NOPE, FALSE [Optional – default: 2]
RETURNS	Integer	The level from which the logs should be logged
NOTES	Log entries whose status is equal or higher than the set level will be logged. The log level can be also set at the creation of the log factory `var log = new LogFactory({level: 'info'})` or by setting the level directly `log.level = 3;` if the level is set directly only integer values are valid.

log.setLevel('e');                 // => set's the log level to 'error' which is level [5]
log("System's getting hot", 'w');  // => diddly-squat the WARNING statuses level [4] doesn't meet our minimum error [5] level
log("System's over heating", 'c'); // => This will log the CRITICAL statuses level [5] meets our minimum error [5] level
log("System's caught fire", 'f','fire');  // => This will log the FATAL statuses level [6] meets our minimum error [5] level

log.setLevel('e'); // => set's the log level to 'error' which is level [5]

log("System's getting hot", 'w'); // => diddly-squat the WARNING statuses level [4] doesn't meet our minimum error [5] level

log("System's over heating", 'c'); // => This will log the CRITICAL statuses level [5] meets our minimum error [5] level

log("System's caught fire", 'f','fire'); // => This will log the FATAL statuses level [6] meets our minimum error [5] level

[1] [CRITICAL]   System's over heating [Sun Mar 05 2017 10:05:02 GMT+0200 562ms]
[2] [FATAL]      🔥System's caught fire [Sun Mar 05 2017 10:05:02 GMT+0200 562ms]

1 2	[1] [CRITICAL] System's over heating [Sun Mar 05 2017 10:05:02 GMT+0200 562ms] [2] [FATAL] 🔥System's caught fire [Sun Mar 05 2017 10:05:02 GMT+0200 562ms]

log.cookie(file, level, overwrite, setLevel) For reading and writing log level cookies for for the setting of the log level.
PARAMETER	TYPE	DESCRIPTION
file	String or File Object	The file path of the log cookie. The same rules apply for the file cookie file name as in the log.setFile() method, as such the file name and path might not be the expected one. The actual cookie file path can be extracted from the object returned by the method. [Optional – default: A cookie file will be created in the temporary folder and called COOKIE_Script Name_Year_Month_Date.txt for example COOKIE_Script2_2017_Feb_21.txt effectively leaving out the file name creates a temporary cookie that will be valid until midnight]
level	String or Integer	The level from which the logs should be logged. [Optional – default: NONE] The level object accepts any of the values listed by the setLevel() method.
overwrite	Boolean	If the cookie should be overwritten if it already exists [Optional – default: false]
setLevel	Boolean	If the log level should be set to the cookies level value [Optional – default: true]
RETURNS	Object	{path: The actual path of the file cookie, level: the integer value of the level}
NOTES	A typical usage of the log.cookie method would be in a distributed production script. Normally one wouldn't want the log to be automatically created, instead one would want a method for the user to activate the logging by either manually changing the contents of the log cookie or by using a provided UI option. This method also accepts use an object in the form of `var myCookie = log.cookie({file: 'myCookie.txt', level: 'error', overwrite: true, setLevel: true});`

var log = new LogFactory('myDebugLog.log');

////////////////////////////////////////////////////////////////////////////////////////////////////////
// The log cookie will only be written to if the cookies empty because the overwrite default is false //
// If the log cookie cookie does not already exist then the cookie 'myLogCookie.cookie'               //
// with the value 'NONE' will be written to the to the temporary folder                               //
// The log level will be set to NONE because the setLevel default is NONE                             //
// If the file does exist then the log value will be set according to the cookies value               //
////////////////////////////////////////////////////////////////////////////////////////////////////////
log.cookie('myLogCookie.cookie');

/////////////////////////////////////////////////////////////////////////////////////////////////////
// This would normally not do anything and the log would not be created                            //
// If needed (PANIC) then we instruct the user to go to the log cookie location and type in "all"  //
// Or we tell the user to type in some secret magic word in a UI edit box or some other UI option  //
// The automated options would set the overwrite parameter to true                                 //
// log.cookie('myLogCookie.cookie', 'all', true); // turn off even if the cookie exist and says on //
// log.cookie('myLogCookie.cookie', 'off', true); // turn on even if the cookie exist and says off //
// After the users saved the cookie with the all value and the scripts rerun                       //
// then the log file will be created and logging will occur until the cookies set back to 'off'    //
/////////////////////////////////////////////////////////////////////////////////////////////////////
log('Normally diddly-squat'); // => diddly-squat, nothing, zilch. (Unless somebody played with the cookie)

var log = new LogFactory('myDebugLog.log');

////////////////////////////////////////////////////////////////////////////////////////////////////////

// The log cookie will only be written to if the cookies empty because the overwrite default is false //

// If the log cookie cookie does not already exist then the cookie 'myLogCookie.cookie' //

// with the value 'NONE' will be written to the to the temporary folder //

// The log level will be set to NONE because the setLevel default is NONE //

// If the file does exist then the log value will be set according to the cookies value //

////////////////////////////////////////////////////////////////////////////////////////////////////////

log.cookie('myLogCookie.cookie');

/////////////////////////////////////////////////////////////////////////////////////////////////////

// This would normally not do anything and the log would not be created //

// If needed (PANIC) then we instruct the user to go to the log cookie location and type in "all" //

// Or we tell the user to type in some secret magic word in a UI edit box or some other UI option //

// The automated options would set the overwrite parameter to true //

// log.cookie('myLogCookie.cookie', 'all', true); // turn off even if the cookie exist and says on //

// log.cookie('myLogCookie.cookie', 'off', true); // turn on even if the cookie exist and says off //

// After the users saved the cookie with the all value and the scripts rerun //

// then the log file will be created and logging will occur until the cookies set back to 'off' //

/////////////////////////////////////////////////////////////////////////////////////////////////////

log('Normally diddly-squat'); // => diddly-squat, nothing, zilch. (Unless somebody played with the cookie)

log.setStatus(status) For setting default log status
PARAMETER	TYPE	DESCRIPTION
status	String	Sets the default log status. Accepts the following non case sensitive strings and their abbreviations. RE: 'RESULT', ST: 'STOPPER', TI: 'TIMER', T: 'TRACE' D: 'DEBUG', L: 'LOG', CO: 'CONSTANT', F: 'FUNCTION', R: 'RETURN', V: 'VARIABLE', S: 'STACK' I: 'INFO', IM: 'IMPORTANT' W: 'WARNING' B: 'BUG', C: 'CRITICAL', E: 'ERROR' FA: 'FATAL' Custom statuses can also be used.
RETURNS	String	The full unabbreviated status
NOTES	The level associated with each status is listed by the log.setLevel() method

var log = new LogFactory();
log('blah');           // =>  [1] [LOG]      blah 	[Thu Mar 02 2017 07:44:26 GMT+0200 618ms]
log.setStatus('im');
log('blah');           // =>  [2] [IMPORTANT] blah 	[Thu Mar 02 2017 07:44:26 GMT+0200 619ms]
log.setStatus('custom');
log('Zilch');          // => Nothing, the 'CUSTOM' status(es) are allocate a level of 0
                       // => The default login level is 3 so Zilch
log.setLevel('all');   // => Set's the log.level to 0 so we can see the all logs
log('blah');           // =>  [3] [CUSTOM]   blah 	[Thu Mar 02 2017 07:44:26 GMT+0200 619ms]

var log = new LogFactory();

log('blah'); // => [1] [LOG] blah [Thu Mar 02 2017 07:44:26 GMT+0200 618ms]

log.setStatus('im');

log('blah'); // => [2] [IMPORTANT] blah [Thu Mar 02 2017 07:44:26 GMT+0200 619ms]

log.setStatus('custom');

log('Zilch'); // => Nothing, the 'CUSTOM' status(es) are allocate a level of 0

// => The default login level is 3 so Zilch

log.setLevel('all'); // => Set's the log.level to 0 so we can see the all logs

log('blah'); // => [3] [CUSTOM] blah [Thu Mar 02 2017 07:44:26 GMT+0200 619ms]

   [1] [LOG]      blah 	[Thu Mar 02 2017 07:44:26 GMT+0200 618ms]
   [2] [IMPORTANT] blah 	[Thu Mar 02 2017 07:44:26 GMT+0200 619ms]
   [3] [CUSTOM]   blah 	[Thu Mar 02 2017 07:44:26 GMT+0200 619ms]

[1] [LOG] blah [Thu Mar 02 2017 07:44:26 GMT+0200 618ms]

[2] [IMPORTANT] blah [Thu Mar 02 2017 07:44:26 GMT+0200 619ms]

[3] [CUSTOM] blah [Thu Mar 02 2017 07:44:26 GMT+0200 619ms]

log.setFile(file) For setting file were the log will be written to.
PARAMETER	TYPE	DESCRIPTION
file	String of File Object	Accepts either the File Object or a String of the full path to the log or just the file name of the log in which case it will be place in the systems temporary folder. [Optional – default: If a path was previously set then that path will be used otherwise the log file will be created in the temporary folder and called LOG_Script Name_Year_Month_Date.log for example LOG_Script2_2017_Feb_21.log]
RETURNS	File Object	The File Object (which may or may not yet exist)
NOTES	The log will only be written to (and created) if the log.write value is true (which is it's default value). If it's not the file will be ready to be created as soon as a log is entered after setting the log.write value value to true. The log entries also have to be of a status equal or higher than the log level (the default log level is 2). The setFile method uses a systematic fail back file naming process in the event that the log file cannot be written to. If the given path can not be used (for example the files for some reason set to readonly) then a date integer will be added to the name. i.e. if the path '~/Documents/myLog.log' couldn't be written to then '~/Documents/myLog_1485181571090.log' will be tired. If that doesn't work then try the original name in the temp directory path/to/temp/directory/myLog.log. If that's no good then try a safe name in the temp folder path/to/temp/directory/LOG_1485181571090.log.

var log = new LogFactory({write: false});
log.setFile('~/Documents/myLog.log'); // => No log created yet
log('Howdey');    // => diddly-squat
log.write = true; // now the next log will do something
log('Hi again');  // => Now the file '~/Documents/myLog.log' will be created (if it didn't already exist)
                  // The entry 'Hi again' will be logged.

var log = new LogFactory({write: false});

log.setFile('~/Documents/myLog.log'); // => No log created yet

log('Howdey'); // => diddly-squat

log.write = true; // now the next log will do something

log('Hi again'); // => Now the file '~/Documents/myLog.log' will be created (if it didn't already exist)

// The entry 'Hi again' will be logged.

  [1] [LOG]       Hi again [Sun Mar 05 2017 10:05:02 GMT+0200 562ms]

1	[1] [LOG] Hi again [Sun Mar 05 2017 10:05:02 GMT+0200 562ms]

log.get() For retrieving individual or ranges of log entries.
PARAMETER	TYPE	DESCRIPTION
	Integer or Array of 2 Integers	The log line or log range to be returned. If an Integer n is given then log entry n will be returned. If an array [start, end] is given then the range of log entries from start to end with be returned. Negative integers can be given -1 is the last entry -2 is the second last entry 1 is the first entry [Optional – default: [1, -1] i.e. the entire log store]
	Integer or Array	Same as above. The more argument you use the more log lines or ranges will be returned
RETURNS	String	The strings of the selected log entries
NOTES	The log entires can only be fetched if the logs are stored in the computers memory. By default the log.store value is set to false the logs are NOT stored in the computers memory. To store the logs in the computers memory either at the creation of the log factory set the store value to true `var log = new LogFactory({store: true});` or directly set `log.store = true`. When on earth would you want to do this? With small production scripts which are not overly logging and you generally don't need the logs, you can store the logs just in the memory by setting the log.write value to false and the log.store value to true. You can then access the log if needed in a try catch error report. Normally you might use something like `alert('The last 20 log entries were\n' + log.get([-20, -1]));`

var r, n, log = new LogFactory({
    file: 'mySillyLog.log',
    store: true, // CRUCIAL!!!!
    write: false
});
try {
    for (n = 1; n < 1000; n++) {
        log('Log entry [' + n + '] ([' + (n - 1000) + '] from the end)');
    }
    BUG
} catch (e) {
    log.write = true;
    r = log.get([1, 3], 10, [-10, -8], -3, -1);
    log('Silly fake error report.' + r, 'i');
    log(e + ' at line: ' + e.line, 'e', 'bug');
}

var r, n, log = new LogFactory({

file: 'mySillyLog.log',

store: true, // CRUCIAL!!!!

write: false

});

try {

for (n = 1; n < 1000; n++) {

log('Log entry [' + n + '] ([' + (n - 1000) + '] from the end)');

}

BUG

} catch (e) {

log.write = true;

r = log.get([1, 3], 10, [-10, -8], -3, -1);

log('Silly fake error report.' + r, 'i');

log(e + ' at line: ' + e.line, 'e', 'bug');

}

[1000] [INFO]     Silly fake error report.
   [1] [LOG]      Log entry [1] ([-999] from the end) 	[Thu Mar 02 2017 09:07:09 GMT+0200 737ms]
   [2] [LOG]      Log entry [2] ([-998] from the end) 	[Thu Mar 02 2017 09:07:09 GMT+0200 737ms]
   [3] [LOG]      Log entry [3] ([-997] from the end) 	[Thu Mar 02 2017 09:07:09 GMT+0200 737ms]
  [10] [LOG]      Log entry [10] ([-990] from the end) 	[Thu Mar 02 2017 09:07:09 GMT+0200 737ms]
 [990] [LOG]      Log entry [990] ([-10] from the end) 	[Thu Mar 02 2017 09:07:09 GMT+0200 784ms]
 [991] [LOG]      Log entry [991] ([-9] from the end) 	[Thu Mar 02 2017 09:07:09 GMT+0200 784ms]
 [992] [LOG]      Log entry [992] ([-8] from the end) 	[Thu Mar 02 2017 09:07:09 GMT+0200 784ms]
 [997] [LOG]      Log entry [997] ([-3] from the end) 	[Thu Mar 02 2017 09:07:09 GMT+0200 784ms]
 [999] [LOG]      Log entry [999] ([-1] from the end) 	[Thu Mar 02 2017 09:07:09 GMT+0200 784ms] 	[Thu Mar 02 2017 09:07:09 GMT+0200 785ms]
[1001] [ERROR]    🐛ReferenceError: BUG is undefined at line: 13 	[Thu Mar 02 2017 09:07:09 GMT+0200 786ms]

[1000] [INFO] Silly fake error report.

[1] [LOG] Log entry [1] ([-999] from the end) [Thu Mar 02 2017 09:07:09 GMT+0200 737ms]

[2] [LOG] Log entry [2] ([-998] from the end) [Thu Mar 02 2017 09:07:09 GMT+0200 737ms]

[3] [LOG] Log entry [3] ([-997] from the end) [Thu Mar 02 2017 09:07:09 GMT+0200 737ms]

[10] [LOG] Log entry [10] ([-990] from the end) [Thu Mar 02 2017 09:07:09 GMT+0200 737ms]

[990] [LOG] Log entry [990] ([-10] from the end) [Thu Mar 02 2017 09:07:09 GMT+0200 784ms]

[991] [LOG] Log entry [991] ([-9] from the end) [Thu Mar 02 2017 09:07:09 GMT+0200 784ms]

[992] [LOG] Log entry [992] ([-8] from the end) [Thu Mar 02 2017 09:07:09 GMT+0200 784ms]

[997] [LOG] Log entry [997] ([-3] from the end) [Thu Mar 02 2017 09:07:09 GMT+0200 784ms]

[999] [LOG] Log entry [999] ([-1] from the end) [Thu Mar 02 2017 09:07:09 GMT+0200 784ms] [Thu Mar 02 2017 09:07:09 GMT+0200 785ms]

[1001] [ERROR] 🐛ReferenceError: BUG is undefined at line: 13 [Thu Mar 02 2017 09:07:09 GMT+0200 786ms]

log.args(args, funct, line) Logs information about a function and it's augments.
PARAMETER	TYPE	DESCRIPTION
args	Function Augments	The arguments of the function. Normally this would be the arguments of the function that calls the log.args() method, in which case one would use `log.args(augments);` the word `augments` should not be placed in quotes.
funct	Function	The function whose arguments are being parsed. Currently (2017) Adobe's extended script is based on ECMA version 3 (Published December 1999), the rest of the world is using version 7 (Published June 2016), hey not much changes in 4 versions and 16½+ of a highly developing language! As such the function can be retrieved from it's arguments using arguments.callee, from version 5 this is not allowed in strict mode. As such this argument is included as a prayer that Adobe will update their JavaScript version. [Optional – currently not needed]
line	Integer	You can include the line number that the method was called from by using `log.args(augments, $.line)`. If the funct parameter is not passed then the second parameter will be the line parameter. [Optional – none]
RETURNS	String	The string of log entry produced
NOTES	The log entry is allocated a "Function" status. If no value is provided for the functions named arguments then the value shown will be "NO VALUE PROVIDED". If a value is provided for the functions non-named arguments then the argument name shown will be arguments[n] where n is the index of the argument.

var F1, log = new LogFactory({ file: 'mySillyLog2.log' });
F1 = function(a, b, c) {
    log.args(arguments, $.line);
};
F1(1, { a: 3, b: { q: 'sg', e: [23, 7, 234, 7, 4, 'wt', [3, 6, 7, { r: 4 }]] } });

var F1, log = new LogFactory({ file: 'mySillyLog2.log' });

F1 = function(a, b, c) {

log.args(arguments, $.line);

};

F1(1, { a: 3, b: { q: 'sg', e: [23, 7, 234, 7, 4, 'wt', [3, 6, 7, { r: 4 }]] } });

   [1] [FUNCTION] --------------
                  Function Data:
                  --------------
                  Function Name: anonymous
                  Call stack: [(Script3)]
                              F1(1,[Object:[object Object]])
                  Function Line around: 3
                  Arguments Provided: 2
                  Named Arguments: 3
                  Arguments Names: a, b, c
                  ----------------
                  Argument Values:
                  ----------------
                  a: 1
                  b: {a:3, b:{q:"sg", e:[23, 7, 234, 7, 4, "wt", [3, 6, 7, ({r:4})]]}}
                  c: NO VALUE PROVIDED
                   	[Fri Feb 24 2017 12:17:08 GMT+0200 349ms]

[1] [FUNCTION] --------------

Function Data:

--------------

Function Name: anonymous

Call stack: [(Script3)]

F1(1,[Object:[object Object]])

Function Line around: 3

Arguments Provided: 2

Named Arguments: 3

Arguments Names: a, b, c

----------------

Argument Values:

----------------

a: 1

b: {a:3, b:{q:"sg", e:[23, 7, 234, 7, 4, "wt", [3, 6, 7, ({r:4})]]}}

c: NO VALUE PROVIDED

[Fri Feb 24 2017 12:17:08 GMT+0200 349ms]

log.values(values) Logs the values of an object or array.
PARAMETER	TYPE	DESCRIPTION
values	Object or Array	The Object or Array whose values one wants mapped. This function is a useful way of capturing information on multiple variables. In a case where one wants to get a snapshot of the values a, b, c one can use `log.values({a:a , b:b, c:c});`
RETURNS	String	The string of log entry produced

var obj, arr, log = new LogFactory('myLog.log');
obj = (1, { a: 3, b: { q: 'sg', e: [23, 7, 234, 7, 4, 'wt', [3, 6, 7, { r: 4 }]] } });
arr = [4,5,3,'sdf', /dsfgsdg/, 4, {w:425}]
arr.foo = 'bar';
log.values(obj);
log.values(arr);

var obj, arr, log = new LogFactory('myLog.log');

obj = (1, { a: 3, b: { q: 'sg', e: [23, 7, 234, 7, 4, 'wt', [3, 6, 7, { r: 4 }]] } });

arr = [4,5,3,'sdf', /dsfgsdg/, 4, {w:425}]

arr.foo = 'bar';

log.values(obj);

log.values(arr);

   [1] [VARIABLE] a: 3
                  b: {q:"sg", e:[23, 7, 234, 7, 4, "wt", [3, 6, 7, ({r:4})]]}
                   	[Wed Feb 22 2017 15:55:35 GMT+0200 738ms]
   [2] [VARIABLE] 0: 4
                  1: 5
                  2: 3
                  3: "sdf"
                  4: /dsfgsdg/
                  5: 4
                  6: {w:425}
                  foo: "bar"
                   	[Wed Feb 22 2017 15:55:35 GMT+0200 742ms]

[1] [VARIABLE] a: 3

b: {q:"sg", e:[23, 7, 234, 7, 4, "wt", [3, 6, 7, ({r:4})]]}

[Wed Feb 22 2017 15:55:35 GMT+0200 738ms]

[2] [VARIABLE] 0: 4

1: 5

2: 3

3: "sdf"

4: /dsfgsdg/

5: 4

6: {w:425}

foo: "bar"

[Wed Feb 22 2017 15:55:35 GMT+0200 742ms]

log.stack() Logs the call stack
RETURNS	String	The string of log entry produced
NOTES	The log entry is allocated a "STACK" status. The stack order is as per the order of the $.stack property i.e. each listing is the caller of the listing below.

var log = new LogFactory('myLog.log');
function F1(a, b, c) {
    F2(a + 2, b - 2, c);
}
function F2(d, e, f, g) {
    log.stack();
}
F1(1, 2);

var log = new LogFactory('myLog.log');

function F1(a, b, c) {

F2(a + 2, b - 2, c);

}

function F2(d, e, f, g) {

log.stack();

}

F1(1, 2);

   [1] [STACK]    [(Script4)]
                  F1(1,2)
                  F2(3,0,undefined) 	[Wed Feb 22 2017 16:42:19 GMT+0200 829ms]

[1] [STACK] [(Script4)]

F1(1,2)

F2(3,0,undefined) [Wed Feb 22 2017 16:42:19 GMT+0200 829ms]

log.sumDiff(message) Shows the difference between $.summary() calls.
PARAMETER	TYPE	DESCRIPTION
message	String	Message to be added to the log entry.
RETURNS	String	The string of log entry produced.
NOTES	This method is for seeing how many wanted or unwanted variables you have created. Are you a tidy sort of guy or a dirty slob? Thanks to Dirk Becker for permission to use his $.summary.difference() function, Cheers Dirk 🍺. The implementation here automatically calls garbage collection before execution.

Note: If you try the snippet on a persistent engine for example Illustrator then the results will differ from those shown here.

var log = new LogFactory('myLog.log');
var a, b, c, e;
a = /234235/; // 1 RegExp
b = {32: 4, r: [453, 23, { 4: 'GSFG' }] }; // 2 Object, 1 Array
c = "afgafdsg"; // Strings don't seem to get picked up that well
d = 'fred'; // Strings don't seem to get picked up that well
e = ['fsdgs', 34]; // 1 Array
log('log.sumDiff() Demo');
log('Note that "Functions" will be added each 1st time a new log method is called', 'i');
log.sumDiff();
var f, g, h;
a = /234235/; // 0 RegExp it was already declared above
f = /234235/; // 1 RegExp f is a new value
// If we would have done f = a; then a new RegExp would not have been created.
g = { 32: 4, r: [453, 23, { 4: 'GSFG' }] }; // 2 Object, 1 Array
c = /fgsg/; // 1 RegExp
d = 'fred3'; // Strings don't seem to get picked up that well
h = ['fsdgs', 34]; // 1 Array
log.sumDiff();
log('Nothing new here', 'i', 'happy');
log.sumDiff('Zilch');
log.show();

var log = new LogFactory('myLog.log');

var a, b, c, e;

a = /234235/; // 1 RegExp

b = {32: 4, r: [453, 23, { 4: 'GSFG' }] }; // 2 Object, 1 Array

c = "afgafdsg"; // Strings don't seem to get picked up that well

d = 'fred'; // Strings don't seem to get picked up that well

e = ['fsdgs', 34]; // 1 Array

log('log.sumDiff() Demo');

log('Note that "Functions" will be added each 1st time a new log method is called', 'i');

log.sumDiff();

var f, g, h;

a = /234235/; // 0 RegExp it was already declared above

f = /234235/; // 1 RegExp f is a new value

// If we would have done f = a; then a new RegExp would not have been created.

g = { 32: 4, r: [453, 23, { 4: 'GSFG' }] }; // 2 Object, 1 Array

c = /fgsg/; // 1 RegExp

d = 'fred3'; // Strings don't seem to get picked up that well

h = ['fsdgs', 34]; // 1 Array

log.sumDiff();

log('Nothing new here', 'i', 'happy');

log.sumDiff('Zilch');

log.show();

   [1] [LOG]      log.sumDiff() Demo 	[Fri Feb 24 2017 14:13:21 GMT+0200 707ms]
   [2] [INFO]     Note that "Functions" will be added each 1st time a new log method is called 	[Fri Feb 24 2017 14:13:21 GMT+0200 707ms]
   [3] [VARIABLE] $.summary.difference(): 
    2 Array
    1 RegExp
    6 Function
    1 (workspace)
    1 Object
 	[Fri Feb 24 2017 14:13:21 GMT+0200 708ms]
   [4] [VARIABLE] $.summary.difference(): 
    2 Array
    2 RegExp
    2 Object
 	[Fri Feb 24 2017 14:13:21 GMT+0200 709ms]
   [5] [INFO]     😃Nothing new here 	[Fri Feb 24 2017 14:13:21 GMT+0200 709ms]
   [6] [VARIABLE] $.summary.difference(): Zilch - NONE - 	[Fri Feb 24 2017 14:13:21 GMT+0200 710ms]

[1] [LOG] log.sumDiff() Demo [Fri Feb 24 2017 14:13:21 GMT+0200 707ms]

[2] [INFO] Note that "Functions" will be added each 1st time a new log method is called [Fri Feb 24 2017 14:13:21 GMT+0200 707ms]

[3] [VARIABLE] $.summary.difference():

2 Array

1 RegExp

6 Function

1 (workspace)

1 Object

[Fri Feb 24 2017 14:13:21 GMT+0200 708ms]

[4] [VARIABLE] $.summary.difference():

2 Array

2 RegExp

2 Object

[Fri Feb 24 2017 14:13:21 GMT+0200 709ms]

[5] [INFO] 😃Nothing new here [Fri Feb 24 2017 14:13:21 GMT+0200 709ms]

[6] [VARIABLE] $.summary.difference(): Zilch - NONE - [Fri Feb 24 2017 14:13:21 GMT+0200 710ms]

log.file() For access to the log file.
RETURNS	File Object	The log file object if one was defined. (undefined if not)

var log = new LogFactory();
log(log.file());

1 2	var log = new LogFactory(); log(log.file());

 [1] [LOG]      new File ("/private/var/folders/dp/kswbf4qd03d108xy4wdr_8240000gn/T/TemporaryItemsLOG_1488320198504.log") 	[Wed Mar 01 2017 00:16:38 GMT+0200 523ms]

1	[1] [LOG] new File ("/private/var/folders/dp/kswbf4qd03d108xy4wdr_8240000gn/T/TemporaryItemsLOG_1488320198504.log") [Wed Mar 01 2017 00:16:38 GMT+0200 523ms]

log.execute() & log.show() Opens the log file with the systems default application for opening the files with the suffix you have allocated to the log.
RETURNS	Boolean	If the file was opened.
NOTES	With log save with a .log suffix the Mac will normally open the log with the Mac Console program. This in my opinion is pretty satisfactory. On Windows you will need to designate a program as the default program for opening .log files. I use Sublime Text. If you can call your log whatever your want (within reason), .txt, .html, .etc. and have a different default program open the log.

log.openFolder() Opens the log folder containing the log file with Finder or Windows Explorer
RETURNS	Boolean	If the folder was opened.

log.close() Closes the log file.
RETURNS	Boolean	If the file was closed.
NOTES	This is for tidy people who don't like to leave files open

log.setCount(file) Sets the log count for the next log entry.
PARAMETER	TYPE	DESCRIPTION
file	Integer or File Object or String	Accepts an integer to set the count to a specified number or the File Object of a log file or a String of the full path of the log file. [Optional – default: The current log file]. If the count is retrieved from a log file then the next log count will continue from the last entry of that file.
RETURNS	Integer	The log count for the next log entry.
NOTES	This method is could be used if one is controlling multiple log files with a single log factory. The count property can be set directly using `log.count = n;` where n is an integer.

var log = new LogFactory('myLog1.log');
log('Something in log 1');
log('Something else in log 1');
log.setFile('myLog2.log');
log.setCount();
log('Something in log 2');
log.setFile('myLog1.log');
log.setCount();
log('Yet another thing in log 1');
log.setFile('myLog2.log');
log.setCount(-10);
log('Bored?');
log.setFile('myLog1.log');

var log = new LogFactory('myLog1.log');

log('Something in log 1');

log('Something else in log 1');

log.setFile('myLog2.log');

log.setCount();

log('Something in log 2');

log.setFile('myLog1.log');

log.setCount();

log('Yet another thing in log 1');

log.setFile('myLog2.log');

log.setCount(-10);

log('Bored?');

log.setFile('myLog1.log');

myLog1.log

   [1] [LOG]      Something in log 1 	[Thu Feb 23 2017 15:00:22 GMT+0200 489ms]
   [2] [LOG]      Something else in log 1 	[Thu Feb 23 2017 15:00:22 GMT+0200 490ms]
   [3] [LOG]      Yet another thing in log 1 	[Thu Feb 23 2017 15:00:22 GMT+0200 495ms]

[1] [LOG] Something in log 1 [Thu Feb 23 2017 15:00:22 GMT+0200 489ms]

[2] [LOG] Something else in log 1 [Thu Feb 23 2017 15:00:22 GMT+0200 490ms]

[3] [LOG] Yet another thing in log 1 [Thu Feb 23 2017 15:00:22 GMT+0200 495ms]

myLog2.log

   [1] [LOG]      Something in log 2 	[Thu Feb 23 2017 15:00:22 GMT+0200 492ms]
 [-10] [LOG]      Bored? 	[Thu Feb 23 2017 15:00:22 GMT+0200 497ms]

1 2	[1] [LOG] Something in log 2 [Thu Feb 23 2017 15:00:22 GMT+0200 492ms] [-10] [LOG] Bored? [Thu Feb 23 2017 15:00:22 GMT+0200 497ms]

log.reset(all) Resets the log factory to more or less it's default settings
PARAMETER	TYPE	DESCRIPTION
all	Boolean	If just the log store (i.e. the logs stored in the computers memory in the event that the factory was set up to remember them) and count should be reset or all the setting should be reset (like a factory reset on a phone). [Optional – default: true]

Timing Methods
These timing methods are to give a rough time of the execution of parts of the script.
For a more accurate method of timing function times I've posted my thoughts and a snippet on the Adobe InDesign scripting forum.

log.stopper(message) For timing between 2 points.
message	String	The message that should be displayed before the log timing information [Optional – default: none].
RETURNS	String	The log produced.
NOTES	This method is records the time lapsed between one stopper call and the next, automatically including the log counts of the points. I differs from the `log.start()` and `log.stop()` timing methods which interact with each other as pairs in the way that brackets do see the snippet by those methods.

var log = new LogFactory({
	file:'myLog.log',
	level:'trace' // CRUCIAL needs to be set to level 1 or 0
	});
log.stopper();
var a, b, c;
for (a = 0; a < 10000; a++) {
    b = 2 * a;
    c = 3 * b;
}
log.stopper('1st loop');
for (a = 0; a < 100; a++) {
    b = 2 * a;
    c = 3 * b;
}
log.stopper('2nd loop');

var log = new LogFactory({

file:'myLog.log',

level:'trace' // CRUCIAL needs to be set to level 1 or 0

});

log.stopper();

var a, b, c;

for (a = 0; a < 10000; a++) {

b = 2 * a;

c = 3 * b;

}

log.stopper('1st loop');

for (a = 0; a < 100; a++) {

b = 2 * a;

c = 3 * b;

}

log.stopper('2nd loop');

   [1] [STOPPER]  Stopper start point
                  From Log Factory Start to BEFORE LOG#1 took 3ms Starting Thu Feb 23 2017 17:16:51 GMT+0200 538ms Ending Thu Feb 23 2017 17:16:51 GMT+0200 541ms 	[Thu Feb 23 2017 17:16:51 GMT+0200 541ms]
   [2] [STOPPER]  1st loop
                  From BEFORE LOG#1 to LOG#2 took 5ms Starting Thu Feb 23 2017 17:16:51 GMT+0200 541ms Ending Thu Feb 23 2017 17:16:51 GMT+0200 546ms 	[Thu Feb 23 2017 17:16:51 GMT+0200 546ms]
   [3] [STOPPER]  2nd loop
                  From LOG#2 to LOG#3 took 3ms Starting Thu Feb 23 2017 17:16:51 GMT+0200 546ms Ending Thu Feb 23 2017 17:16:51 GMT+0200 549ms 	[Thu Feb 23 2017 17:16:51 GMT+0200 549ms]

[1] [STOPPER] Stopper start point

From Log Factory Start to BEFORE LOG#1 took 3ms Starting Thu Feb 23 2017 17:16:51 GMT+0200 538ms Ending Thu Feb 23 2017 17:16:51 GMT+0200 541ms [Thu Feb 23 2017 17:16:51 GMT+0200 541ms]

[2] [STOPPER] 1st loop

From BEFORE LOG#1 to LOG#2 took 5ms Starting Thu Feb 23 2017 17:16:51 GMT+0200 541ms Ending Thu Feb 23 2017 17:16:51 GMT+0200 546ms [Thu Feb 23 2017 17:16:51 GMT+0200 546ms]

[3] [STOPPER] 2nd loop

From LOG#2 to LOG#3 took 3ms Starting Thu Feb 23 2017 17:16:51 GMT+0200 546ms Ending Thu Feb 23 2017 17:16:51 GMT+0200 549ms [Thu Feb 23 2017 17:16:51 GMT+0200 549ms]

log.start(message) Registers a start point that will be matched by a pairing log.stop() call for timing purposes.
message	String	The message that goes before the start timing information. [Optional – default: none].
NOTES	This method is used to provide a starting point from which the `log.end()` method times. See that method for when these methods would be used. The logs produced by this method are assigned a "TIMER" level 1 status as such by default they will NOT be recorded. To enable this method set the log level to 1 or 0

log.stop(message) Logs timing information from a matching start point created using log.start().
message	String	The message that goes before the stop timing information. [Optional – default: none].
RETURNS	String	The log produced.
NOTES	This method with it's matching `log.start()` method is useful for when both an outer and inner timing is required, for example, the time it takes for the execution of an entire script (of set of scripts) and sections of that script and of individual functions within those sections of the script. Each `log.stop()` method must have a matching `log.start()` method to which it is paired in the manner that brackets are, i.e. inner to inner, outer to outer. The logs produced by this method are assigned a "TIMER" level 1 status as such by default they will NOT be recorded. To enable this method set the log level to 1 or 0

var log = new LogFactory({
	file:'myLog.log',
	level:'trace' // CRUCIAL needs to be set to level 1 or 0
	});
log.start();
log.start('Before the longer loop ****');
var a, b, c;
for (a = 0; a < 100000; a++) {
    b = 2 * a;
    c = 3 * b;
}
log.start('After the longer loop @@@');
for (a = 0; a < 100; a++) {
    b = 2 * a;
    c = 3 * b;
}
log.stop('After the shorter loop @@@');
log.stop('After the shorter and longer loop ****');
$.sleep(500);
log.stop('After Zzz');
log.start();
log.stop();

var log = new LogFactory({

file:'myLog.log',

level:'trace' // CRUCIAL needs to be set to level 1 or 0

});

log.start();

log.start('Before the longer loop ****');

var a, b, c;

for (a = 0; a < 100000; a++) {

b = 2 * a;

c = 3 * b;

}

log.start('After the longer loop @@@');

for (a = 0; a < 100; a++) {

b = 2 * a;

c = 3 * b;

}

log.stop('After the shorter loop @@@');

log.stop('After the shorter and longer loop ****');

$.sleep(500);

log.stop('After Zzz');

log.start();

log.stop();

   [1] [TIMER]    After the longer loop @@@ STARTED [Thu Feb 23 2017 18:25:11 GMT+0200 540ms]
                  After the shorter loop @@@ FINISHED [Thu Feb 23 2017 18:25:11 GMT+0200 540ms]
                  TOTAL TIME [<1ms] 	[Thu Feb 23 2017 18:25:11 GMT+0200 540ms]
   [2] [TIMER]    Before the longer loop **** STARTED [Thu Feb 23 2017 18:25:11 GMT+0200 493ms]
                  After the shorter and longer loop **** FINISHED [Thu Feb 23 2017 18:25:11 GMT+0200 542ms]
                  TOTAL TIME [49ms] 	[Thu Feb 23 2017 18:25:11 GMT+0200 542ms]
   [3] [TIMER]    STARTED [Thu Feb 23 2017 18:25:11 GMT+0200 493ms]
                  After Zzz FINISHED [Thu Feb 23 2017 18:25:12 GMT+0200 47ms]
                  TOTAL TIME [554ms] 	[Thu Feb 23 2017 18:25:12 GMT+0200 47ms]
   [4] [TIMER]    STARTED [Thu Feb 23 2017 18:25:12 GMT+0200 48ms]
                  FINISHED [Thu Feb 23 2017 18:25:12 GMT+0200 48ms]
                  TOTAL TIME [<1ms] 	[Thu Feb 23 2017 18:25:12 GMT+0200 48ms]

[1] [TIMER] After the longer loop @@@ STARTED [Thu Feb 23 2017 18:25:11 GMT+0200 540ms]

After the shorter loop @@@ FINISHED [Thu Feb 23 2017 18:25:11 GMT+0200 540ms]

TOTAL TIME [<1ms] [Thu Feb 23 2017 18:25:11 GMT+0200 540ms]

[2] [TIMER] Before the longer loop **** STARTED [Thu Feb 23 2017 18:25:11 GMT+0200 493ms]

After the shorter and longer loop **** FINISHED [Thu Feb 23 2017 18:25:11 GMT+0200 542ms]

TOTAL TIME [49ms] [Thu Feb 23 2017 18:25:11 GMT+0200 542ms]

[3] [TIMER] STARTED [Thu Feb 23 2017 18:25:11 GMT+0200 493ms]

After Zzz FINISHED [Thu Feb 23 2017 18:25:12 GMT+0200 47ms]

TOTAL TIME [554ms] [Thu Feb 23 2017 18:25:12 GMT+0200 47ms]

[4] [TIMER] STARTED [Thu Feb 23 2017 18:25:12 GMT+0200 48ms]

FINISHED [Thu Feb 23 2017 18:25:12 GMT+0200 48ms]

TOTAL TIME [<1ms] [Thu Feb 23 2017 18:25:12 GMT+0200 48ms]

The LogFactory script 💾

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// LogFactory.jsx                                                                                                                                     //
// Version 1                                                                                                                                          //
// 1st Published: 6th Mar 2017                                                                                                                        //
// Modified: 6th Mar 2017                                                                                                                             //
// Copyright &copy; 2017 Trevor http://www.creative-scripts.com                                                                                            //
// May be used on condition that this comment block is left in                                                                                        //
// May not be distributed on the Web (A link to http://www.creative-scripts.com/logging-with-a-smile/ is allowed)                                     //
//                                                                                                                                                    //
// DESCRIPTION: A LogFactory with some extras                                                                                                         //
// Provided 'as is', with no warranty whatsoever.                                                                                                     //
// Use and adapted the function freely providing you leave in these comment lines and specify if you have made adaptations                            //
// Redistribution on the Web is not allowed.                                                                                                          //
// The function is wrapped by the LogFactory so that multiple logs can be maintained simultaneously                                                   //
// THANKS OKO see http://stackoverflow.com/questions/31232157/what-is-the-best-way-to-copy-but-not-clone-a-function-in-javascript/31235167#31235167   //
// Minimal Instructions                                                                                                                               //
// 1) Paste or #include the LogFactory.jsx to the start of the script. (One can use either the full version or the squished one)                      //
// 2) Set up the log file                                                                                                                             //
// var log = new LogFactory('pathToLogFile'); // a few other options here can be added                                                                //
// 3) Do some logging                                                                                                                                 //
// log('hello world'); // logs with default status                                                                                                    //
// log('hello world', 'i'); // logs with 'Info' status                                                                                                //
// log('hello world', 't', 'happy'); // logs with 'Trace' status with a smile                                                                         //
// For detailed instructions see http://www.creative-scripts.com/logging-with-a-smile/                                                                //
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

// jshint unused:true, undef: true
/* globals $, Folder, File */

/**
 * [LogFactory description]
 * @param {String or File Object}   file          [Optional] The location of the log file to create or append
 *                                                           @@@ This argument can be an object in the form
 *                                                           @@@ {file: 'pathToFile', write: boolean, store: boolean, level: String or Integer, status: string}
 *                                                           All keys in the object are optional
 *                                                           (Use of the object for is recommended if not using default values for the other arguments)
 *                                                           Default file value is pathToTempFolder/LOG_Script Name_Year_Month_Date.log for example LOG_Script2_2017_Feb_21.log
 *                                                           See LOG.setFile below
 * @param {Boolean}                 write         [Optional] Whether or not to write to the log file
 *                                                           Default true
 *                                                           See LOG.get() below
 * @param {Boolean}                 store         [Optional] Whether or not to store to the log file as an array in memory
 *                                                           Default false
 * @param {String or Integer}       level         [Optional] The level from which the log values should be logged from (Case insensitive)
 *                                                           Default 2 / Debug
 *                                                           See LOG.get() below
 * @param {String}                  defaultStatus [Optional] The log default status (Case insensitive)
 *                                                           Default 'LOG' this has the log level of 2 / Debug
 *                                                           See LOG.setLevel below
 * @param {Boolean}                 continuing [Optional]       Whether or not the log numbering continues from the previous entry recorded in the log
 *                                                           If false the log count will restart each time a new LogFactory is created
 *                                                           If true and the already log exists the next log entry will continue from the last log count
 *                                                           Default false
 *                                                           See LOG.setLevel below
 * @returns {Function} The LOG function                      If one does var log = new LogFactory('myLog.log');
 *                                                           One can then start using log('hello world');
 *                                                           SEE THE FULL INSTRUCTIONS http://www.creative-scripts.com/logging-with-a-smile/  
 */
var LogFactory = function(file, write, store, level, defaultStatus, continuing) { // jshint ignore: line
    /////////////////////////////
    // Allow passing of Object //
    /////////////////////////////
    if (file && (file.constructor === String || file.constructor === File)) {
        file = {
            file: file
        };
    } else if (!file) file = {
        file: {}
    };
    write = (file.write !== undefined) ? file.write : write;
    if (write === undefined) {
        write = true;
    }
    store = (file.store !== undefined) ? file.store || false : store || false;
    level = (file.level !== undefined) ? file.level : level;
    defaultStatus = (file.defaultStatus !== undefined) ? file.defaultStatus : defaultStatus;
    if (defaultStatus === undefined) {
        defaultStatus = 'LOG';
    }
    continuing = (file.continuing !== undefined) ? file.continuing : continuing || false;
    file = file.file || {};

    var stack, times, logTime, logPoint, icons, statuses, LOG_LEVEL, LOG_STATUS;
    stack = [];
    times = [];
    logTime = new Date();
    logPoint = 'Log Factory Start';
    icons = {
        "1": "\ud83d\udd50", "130": "\ud83d\udd5c", "2": "\ud83d\udd51", "230": "\ud83d\udd5d", "3": "\ud83d\udd52", "330": "\ud83d\udd5e", "4": "\ud83d\udd53", "430": "\ud83d\udd5f", "5": "\ud83d\udd54", "530": "\ud83d\udd60", "6": "\ud83d\udd55", "630": "\ud83d\udd61", "7": "\ud83d\udd56", "730": "\ud83d\udd62", "8": "\ud83d\udd57", "830": "\ud83d\udd63", "9": "\ud83d\udd58", "930": "\ud83d\udd64", "10": "\ud83d\udd59", "1030": "\ud83d\udd65", "11": "\ud83d\udd5a", "1130": "\ud83d\udd66", "12": "\ud83d\udd5b", "1230": "\ud83d\udd67", "AIRPLANE": "\ud83d\udee9", "ALARM": "\u23f0", "AMBULANCE": "\ud83d\ude91", "ANCHOR": "\u2693", "ANGRY": "\ud83d\ude20", "ANGUISHED": "\ud83d\ude27", "ANT": "\ud83d\udc1c", "ANTENNA": "\ud83d\udce1", "APPLE": "\ud83c\udf4f", "APPLE2": "\ud83c\udf4e", "ATM": "\ud83c\udfe7", "ATOM": "\u269b", "BABYBOTTLE": "\ud83c\udf7c", "BAD:": "\ud83d\udc4e", "BANANA": "\ud83c\udf4c", "BANDAGE": "\ud83e\udd15", "BANK": "\ud83c\udfe6", "BATTERY": "\ud83d\udd0b", "BED": "\ud83d\udecf", "BEE": "\ud83d\udc1d", "BEER": "\ud83c\udf7a", "BELL": "\ud83d\udd14", "BELLOFF": "\ud83d\udd15", "BIRD": "\ud83d\udc26", "BLACKFLAG": "\ud83c\udff4", "BLUSH": "\ud83d\ude0a", "BOMB": "\ud83d\udca3", "BOOK": "\ud83d\udcd5", "BOOKMARK": "\ud83d\udd16", "BOOKS": "\ud83d\udcda", "BOW": "\ud83c\udff9", "BOWLING": "\ud83c\udfb3", "BRIEFCASE": "\ud83d\udcbc", "BROKEN": "\ud83d\udc94", "BUG": "\ud83d\udc1b", "BUILDING": "\ud83c\udfdb", "BUILDINGS": "\ud83c\udfd8", "BULB": "\ud83d\udca1", "BUS": "\ud83d\ude8c", "CACTUS": "\ud83c\udf35", "CALENDAR": "\ud83d\udcc5", "CAMEL": "\ud83d\udc2a", "CAMERA": "\ud83d\udcf7", "CANDLE": "\ud83d\udd6f", "CAR": "\ud83d\ude98", "CAROUSEL": "\ud83c\udfa0", "CASTLE": "\ud83c\udff0", "CATEYES": "\ud83d\ude3b", "CATJOY": "\ud83d\ude39", "CATMOUTH": "\ud83d\ude3a", "CATSMILE": "\ud83d\ude3c", "CD": "\ud83d\udcbf", "CHECK": "\u2714", "CHEQFLAG": "\ud83c\udfc1", "CHICK": "\ud83d\udc25", "CHICKEN": "\ud83d\udc14", "CHICKHEAD": "\ud83d\udc24", "CIRCLEBLACK": "\u26ab", "CIRCLEBLUE": "\ud83d\udd35", "CIRCLERED": "\ud83d\udd34", "CIRCLEWHITE": "\u26aa", "CIRCUS": "\ud83c\udfaa", "CLAPPER": "\ud83c\udfac", "CLAPPING": "\ud83d\udc4f", "CLIP": "\ud83d\udcce", "CLIPBOARD": "\ud83d\udccb", "CLOUD": "\ud83c\udf28", "CLOVER": "\ud83c\udf40", "CLOWN": "\ud83e\udd21", "COLDSWEAT": "\ud83d\ude13", "COLDSWEAT2": "\ud83d\ude30", "COMPRESS": "\ud83d\udddc", "CONFOUNDED": "\ud83d\ude16", "CONFUSED": "\ud83d\ude15", "CONSTRUCTION": "\ud83d\udea7", "CONTROL": "\ud83c\udf9b", "COOKIE": "\ud83c\udf6a", "COOKING": "\ud83c\udf73", "COOL": "\ud83d\ude0e", "COOLBOX": "\ud83c\udd92", "COPYRIGHT": "\u00a9", "CRANE": "\ud83c\udfd7", "CRAYON": "\ud83d\udd8d", "CREDITCARD": "\ud83d\udcb3", "CROSS": "\u2716", "CROSSBOX:": "\u274e", "CRY": "\ud83d\ude22", "CRYCAT": "\ud83d\ude3f", "CRYSTALBALL": "\ud83d\udd2e", "CUSTOMS": "\ud83d\udec3", "DELICIOUS": "\ud83d\ude0b", "DERELICT": "\ud83c\udfda", "DESKTOP": "\ud83d\udda5", "DIAMONDLB": "\ud83d\udd37", "DIAMONDLO": "\ud83d\udd36", "DIAMONDSB": "\ud83d\udd39", "DIAMONDSO": "\ud83d\udd38", "DICE": "\ud83c\udfb2", "DISAPPOINTED": "\ud83d\ude1e", "CRY2": "\ud83d\ude25", "DIVISION": "\u2797", "DIZZY": "\ud83d\ude35", "DOLLAR": "\ud83d\udcb5", "DOLLAR2": "\ud83d\udcb2", "DOWNARROW": "\u2b07", "DVD": "\ud83d\udcc0", "EJECT": "\u23cf", "ELEPHANT": "\ud83d\udc18", "EMAIL": "\ud83d\udce7", "ENVELOPE": "\ud83d\udce8", "ENVELOPE2": "\u2709", "ENVELOPE_DOWN": "\ud83d\udce9", "EURO": "\ud83d\udcb6", "EVIL": "\ud83d\ude08", "EXPRESSIONLESS": "\ud83d\ude11", "EYES": "\ud83d\udc40", "FACTORY": "\ud83c\udfed", "FAX": "\ud83d\udce0", "FEARFUL": "\ud83d\ude28", "FILEBOX": "\ud83d\uddc3", "FILECABINET": "\ud83d\uddc4", "FIRE": "\ud83d\udd25", "FIREENGINE": "\ud83d\ude92", "FIST": "\ud83d\udc4a", "FLOWER": "\ud83c\udf37", "FLOWER2": "\ud83c\udf38", "FLUSHED": "\ud83d\ude33", "FOLDER": "\ud83d\udcc1", "FOLDER2": "\ud83d\udcc2", "FREE": "\ud83c\udd93", "FROG": "\ud83d\udc38", "FROWN": "\ud83d\ude41", "GEAR": "\u2699", "GLOBE": "\ud83c\udf0d", "GLOWINGSTAR": "\ud83c\udf1f", "GOOD:": "\ud83d\udc4d", "GRIMACING": "\ud83d\ude2c", "GRIN": "\ud83d\ude00", "GRINNINGCAT": "\ud83d\ude38", "HALO": "\ud83d\ude07", "HAMMER": "\ud83d\udd28", "HAMSTER": "\ud83d\udc39", "HAND": "\u270b", "HANDDOWN": "\ud83d\udc47", "HANDLEFT": "\ud83d\udc48", "HANDRIGHT": "\ud83d\udc49", "HANDUP": "\ud83d\udc46", "HATCHING": "\ud83d\udc23", "HAZARD": "\u2623", "HEADPHONE": "\ud83c\udfa7", "HEARNOEVIL": "\ud83d\ude49", "HEARTBLUE": "\ud83d\udc99", "HEARTEYES": "\ud83d\ude0d", "HEARTGREEN": "\ud83d\udc9a", "HEARTYELLOW": "\ud83d\udc9b", "HELICOPTER": "\ud83d\ude81", "HERB": "\ud83c\udf3f", "HIGH_BRIGHTNESS": "\ud83d\udd06", "HIGHVOLTAGE": "\u26a1", "HIT": "\ud83c\udfaf", "HONEY": "\ud83c\udf6f", "HOT": "\ud83c\udf36", "HOURGLASS": "\u23f3", "HOUSE": "\ud83c\udfe0", "HUGGINGFACE": "\ud83e\udd17", "HUNDRED": "\ud83d\udcaf", "HUSHED": "\ud83d\ude2f", "ID": "\ud83c\udd94", "INBOX": "\ud83d\udce5", "INDEX": "\ud83d\uddc2", "JOY": "\ud83d\ude02", "KEY": "\ud83d\udd11", "KISS": "\ud83d\ude18", "KISS2": "\ud83d\ude17", "KISS3": "\ud83d\ude19", "KISS4": "\ud83d\ude1a", "KISSINGCAT": "\ud83d\ude3d", "KNIFE": "\ud83d\udd2a", "LABEL": "\ud83c\udff7", "LADYBIRD": "\ud83d\udc1e", "LANDING": "\ud83d\udeec", "LAPTOP": "\ud83d\udcbb", "LEFTARROW": "\u2b05", "LEMON": "\ud83c\udf4b", "LIGHTNINGCLOUD": "\ud83c\udf29", "LINK": "\ud83d\udd17", "LITTER": "\ud83d\udeae", "LOCK": "\ud83d\udd12", "LOLLIPOP": "\ud83c\udf6d", "LOUDSPEAKER": "\ud83d\udce2", "LOW_BRIGHTNESS": "\ud83d\udd05", "MAD": "\ud83d\ude1c", "MAGNIFYING_GLASS": "\ud83d\udd0d", "MASK": "\ud83d\ude37", "MEDAL": "\ud83c\udf96", "MEMO": "\ud83d\udcdd", "MIC": "\ud83c\udfa4", "MICROSCOPE": "\ud83d\udd2c", "MINUS": "\u2796", "MOBILE": "\ud83d\udcf1", "MONEY": "\ud83d\udcb0", "MONEYMOUTH": "\ud83e\udd11", "MONKEY": "\ud83d\udc35", "MOUSE": "\ud83d\udc2d", "MOUSE2": "\ud83d\udc01", "MOUTHLESS": "\ud83d\ude36", "MOVIE": "\ud83c\udfa5", "MUGS": "\ud83c\udf7b", "NERD": "\ud83e\udd13", "NEUTRAL": "\ud83d\ude10", "NEW": "\ud83c\udd95", "NOENTRY": "\ud83d\udeab", "NOTEBOOK": "\ud83d\udcd4", "NOTEPAD": "\ud83d\uddd2", "NUTANDBOLT": "\ud83d\udd29", "O": "\u2b55", "OFFICE": "\ud83c\udfe2", "OK": "\ud83c\udd97", "OKHAND": "\ud83d\udc4c", "OLDKEY": "\ud83d\udddd", "OPENLOCK": "\ud83d\udd13", "OPENMOUTH": "\ud83d\ude2e", "OUTBOX": "\ud83d\udce4", "PACKAGE": "\ud83d\udce6", "PAGE": "\ud83d\udcc4", "PAINTBRUSH": "\ud83d\udd8c", "PALETTE": "\ud83c\udfa8", "PANDA": "\ud83d\udc3c", "PASSPORT": "\ud83d\udec2", "PAWS": "\ud83d\udc3e", "PEN": "\ud83d\udd8a", "PEN2": "\ud83d\udd8b", "PENSIVE": "\ud83d\ude14", "PERFORMING": "\ud83c\udfad", "PHONE": "\ud83d\udcde", "PILL": "\ud83d\udc8a", "PING": "\u2757", "PLATE": "\ud83c\udf7d", "PLUG": "\ud83d\udd0c", "PLUS": "\u2795", "POLICE": "\ud83d\ude93", "POLICELIGHT": "\ud83d\udea8", "POSTOFFICE": "\ud83c\udfe4", "POUND": "\ud83d\udcb7", "POUTING": "\ud83d\ude21", "POUTINGCAT": "\ud83d\ude3e", "PRESENT": "\ud83c\udf81", "PRINTER": "\ud83d\udda8", "PROJECTOR": "\ud83d\udcfd", "PUSHPIN": "\ud83d\udccc", "QUESTION": "\u2753", "RABBIT": "\ud83d\udc30", "RADIOACTIVE": "\u2622", "RADIOBUTTON": "\ud83d\udd18", "RAINCLOUD": "\ud83c\udf27", "RAT": "\ud83d\udc00", "RECYCLE": "\u267b", "REGISTERED": "\u00ae", "RELIEVED": "\ud83d\ude0c", "ROBOT": "\ud83e\udd16", "ROCKET": "\ud83d\ude80", "ROLLING": "\ud83d\ude44", "ROOSTER": "\ud83d\udc13", "RULER": "\ud83d\udccf", "SATELLITE": "\ud83d\udef0", "SAVE": "\ud83d\udcbe", "SCHOOL": "\ud83c\udfeb", "SCISSORS": "\u2702", "SCREAMING": "\ud83d\ude31", "SCROLL": "\ud83d\udcdc", "SEAT": "\ud83d\udcba", "SEEDLING": "\ud83c\udf31", "SEENOEVIL": "\ud83d\ude48", "SHIELD": "\ud83d\udee1", "SHIP": "\ud83d\udea2", "SHOCKED": "\ud83d\ude32", "SHOWER": "\ud83d\udebf", "SLEEPING": "\ud83d\ude34", "SLEEPY": "\ud83d\ude2a", "SLIDER": "\ud83c\udf9a", "SLOT": "\ud83c\udfb0", "SMILE": "\ud83d\ude42", "SMILING": "\ud83d\ude03", "SMILINGCLOSEDEYES": "\ud83d\ude06", "SMILINGEYES": "\ud83d\ude04", "SMILINGSWEAT": "\ud83d\ude05", "SMIRK": "\ud83d\ude0f", "SNAIL": "\ud83d\udc0c", "SNAKE": "\ud83d\udc0d", "SOCCER": "\u26bd", "SOS": "\ud83c\udd98", "SPEAKER": "\ud83d\udd08", "SPEAKEROFF": "\ud83d\udd07", "SPEAKNOEVIL": "\ud83d\ude4a", "SPIDER": "\ud83d\udd77", "SPIDERWEB": "\ud83d\udd78", "STAR": "\u2b50", "STOP": "\u26d4", "STOPWATCH": "\u23f1", "SULK": "\ud83d\ude26", "SUNFLOWER": "\ud83c\udf3b", "SUNGLASSES": "\ud83d\udd76", "SYRINGE": "\ud83d\udc89", "TAKEOFF": "\ud83d\udeeb", "TAXI": "\ud83d\ude95", "TELESCOPE": "\ud83d\udd2d", "TEMPORATURE": "\ud83e\udd12", "TENNIS": "\ud83c\udfbe", "THERMOMETER": "\ud83c\udf21", "THINKING": "\ud83e\udd14", "THUNDERCLOUD": "\u26c8", "TICKBOX": "\u2705", "TICKET": "\ud83c\udf9f", "TIRED": "\ud83d\ude2b", "TOILET": "\ud83d\udebd", "TOMATO": "\ud83c\udf45", "TONGUE": "\ud83d\ude1b", "TOOLS": "\ud83d\udee0", "TORCH": "\ud83d\udd26", "TORNADO": "\ud83c\udf2a", "TOUNG2": "\ud83d\ude1d", "TRADEMARK": "\u2122", "TRAFFICLIGHT": "\ud83d\udea6", "TRASH": "\ud83d\uddd1", "TREE": "\ud83c\udf32", "TRIANGLE_LEFT": "\u25c0", "TRIANGLE_RIGHT": "\u25b6", "TRIANGLEDOWN": "\ud83d\udd3b", "TRIANGLEUP": "\ud83d\udd3a", "TRIANGULARFLAG": "\ud83d\udea9", "TROPHY": "\ud83c\udfc6", "TRUCK": "\ud83d\ude9a", "TRUMPET": "\ud83c\udfba", "TURKEY": "\ud83e\udd83", "TURTLE": "\ud83d\udc22", "UMBRELLA": "\u26f1", "UNAMUSED": "\ud83d\ude12", "UPARROW": "\u2b06", "UPSIDEDOWN": "\ud83d\ude43", "WARNING": "\u26a0", "WATCH": "\u231a", "WAVING": "\ud83d\udc4b", "WEARY": "\ud83d\ude29", "WEARYCAT": "\ud83d\ude40", "WHITEFLAG": "\ud83c\udff3", "WINEGLASS": "\ud83c\udf77", "WINK": "\ud83d\ude09", "WORRIED": "\ud83d\ude1f", "WRENCH": "\ud83d\udd27", "X": "\u274c", "YEN": "\ud83d\udcb4", "ZIPPERFACE": "\ud83e\udd10", "UNDEFINED": "", "": ""
    };
    statuses = {
        /* OFF */
        /* FATAL */
        F: 'FATAL',
        /* ERROR */
        B: 'BUG',
        C: 'CRITICAL',
        E: 'ERROR',
        /* WARN */
        W: 'WARNING',
        /* INFO */
        I: 'INFO',
        IM: 'IMPORTANT',
        /* DEBUG */
        D: 'DEBUG',
        L: 'LOG',
        CO: 'CONSTANT',
        FU: 'FUNCTION',
        R: 'RETURN',
        V: 'VARIABLE',
        S: 'STACK',
        /* TRACE */
        RE: 'RESULT',
        ST: 'STOPPER',
        TI: 'TIMER',
        T: 'TRACE'
            /* ALL */
    };

    LOG_LEVEL = {
        NONE: 7,
        OFF: 7,
        FATAL: 6,
        ERROR: 5,
        WARN: 4,
        INFO: 3,
        UNDEFINED: 2,
        '': 2,
        DEFAULT: 2, // Should be the same as UNDEFINED and '' so if desired change them all;
        DEBUG: 2,
        TRACE: 1,
        ON: 0,
        ALL: 0,
    };

    LOG_STATUS = {
        OFF: LOG_LEVEL.OFF,
        NONE: LOG_LEVEL.OFF,
        NO: LOG_LEVEL.OFF,
        NOPE: LOG_LEVEL.OFF,
        FALSE: LOG_LEVEL.OFF,

        FATAL: LOG_LEVEL.FATAL,

        BUG: LOG_LEVEL.ERROR,
        CRITICAL: LOG_LEVEL.ERROR,
        ERROR: LOG_LEVEL.ERROR,

        WARNING: LOG_LEVEL.WARN,

        INFO: LOG_LEVEL.INFO,
        IMPORTANT: LOG_LEVEL.INFO,

        DEBUG: LOG_LEVEL.DEBUG,
        LOG: LOG_LEVEL.DEBUG,
        STACK: LOG_LEVEL.DEBUG,
        CONSTANT: LOG_LEVEL.DEBUG,
        FUNCTION: LOG_LEVEL.DEBUG,
        VARIABLE: LOG_LEVEL.DEBUG,
        RETURN: LOG_LEVEL.DEBUG,

        RESULT: LOG_LEVEL.TRACE,
        STOPPER: LOG_LEVEL.TRACE,
        TIMER: LOG_LEVEL.TRACE,
        TRACE: LOG_LEVEL.TRACE,

        ALL: LOG_LEVEL.ALL,
        YES: LOG_LEVEL.ALL,
        YEP: LOG_LEVEL.ALL,
        TRUE: LOG_LEVEL.ALL
    };

    var logFile, logFolder;

    /**
     * [LOG]   This is our main hero function that's created by calling the LogFactory
     *         i.e. var log = new LogFactory();
     *         See the annotations to the LogFactory function for the default values
     *         Once create we use log('Hello'); log('Hello', 'i'); or log('Hello', 'i' ,'happy');
     *         It has many methods and properties.
     *         Methods include :   LOG.setFile(), LOG.setStatus(), LOG.setLevel(), LOG.cookie(), 
     *                             LOG.args(), LOG.stack(), LOG.values(), LOG.sumDiff(),
     *                             LOG.stopper(), LOG.start(), LOG.stop(), log.setCount(),
     *                             LOG.get(), LOG.openFolder(), LOG.execute(), LOG.show(),
     *                             LOG.close(), LOG.file(), LOG.reset(),
     *         Properties include: LOG.write, LOG.store, LOG.level, LOG.status, LOG.count
     * @param {String}   message 'say something here'
     * @param {String}   status  [Optional] (takes abbreviations) (Case insensitive) DEFAULT value LOG.status
     *                           The levels of the statuses are explained by the annotation to the LOG.setLevel() function
     *                           Only logs entries with statuses equal or higher than the LOG.level value will be logged
     * @param {[String]} icon    [Optional] (Adds emojis to the beginning of the message)
     *                           (Case insensitive) Valid values are listed http://www.creative-scripts.com/logging-with-a-smile/#LOG
     *                           See also the object near to the beginning of the LogFactory function 'icons = {''
     *                           
     */
    var LOG = function(message, status, icon) {
        if (LOG.level !== LOG_LEVEL.OFF && (LOG.write || LOG.store) && LOG.arguments.length) return LOG.addMessage(message, status, icon);
    };

    /**
     * [LOG.logDecodeLevel description]
     * @param  {String, Integer, Boole} level (Case insensitive) valid values include:
     *                                         7, NONE, OFF, NONE, NOPE, FALSE,
     *                                         6, FATAL, FA,
     *                                         5, ERROR, BUG, CRITICAL, e, b, c,
     *                                         4, WARN, WARNING, w,
     *                                         3, INFO, IMPORTANT, ON, i, im,
     *                                         2, DEBUG, LOG, STACK, CONSTANT, FUNCTION, VARIABLE, RETURN, d, l, co, f, r, v, s,
     *                                         1, TRACE, RESULT, STOPPER, TIMER, tr, re, st, ti, t,
     *                                         0, ALL,YES, YEP, TRUE
     * @return {Integer}                      The integer value of the level string
     */
    LOG.logDecodeLevel = function(level) {
        // accept integers
        if (level == ~~level) return Math.abs(level);
        var lev;
        level += '';
        level = level.toUpperCase();
        // accept abbreviations
        if (level in statuses) {
            level = statuses[level];
        }
        // accept generic levels like WARN etc. stored in the LOG_LEVEL object
        lev = LOG_LEVEL[level];
        if (lev !== undefined) return lev;
        // accept level by status like CONSTANT stored in LOG_STATUS object
        lev = LOG_STATUS[level];
        if (lev !== undefined) return lev;
        // we did try (and fail) so resort to default level
        return LOG_LEVEL.DEFAULT;
    };
    /////////////////////////////////
    // Set some defaults if needed //
    /////////////////////////////////
    LOG.write = write;
    LOG.store = store;
    LOG.level = LOG.logDecodeLevel(level);
    LOG.status = defaultStatus;


    /**
     * See annotations to main LOG functions
     * Use LOG(message, status, icon) when calling from a created log factory i.e.
     * var log = new LogFactory();
     * use log('Hi'); and not log.addMessage('Hi');
     */
    LOG.addMessage = function(message, status, icon) {
        var date = new Date(),
            count, bool, logStatus;
        if (status && status.constructor.name === 'String') {
            status = status.toUpperCase();
            status = statuses[status] || status;
        } else status = LOG.status;
        /////////////////////////////////////////////////////////////
        // Check the status is above or equal to the set LOG.level //
        /////////////////////////////////////////////////////////////
        logStatus = LOG_STATUS[status] || LOG_STATUS.ALL;
        if (logStatus < LOG.level) return;
        //////////////////////////////////////////////////////
        // If the LOG status is appropriate then log it <span class="wp-font-emots-emo-happy"></span> //
        //////////////////////////////////////////////////////
        date = ' \t[' + date + ' ' + date.getMilliseconds() + 'ms]';
        status = '[' + status + '] ';
        if (status.length < 11) status = (status + '           ').substr(0, 11);
        if (icon) {
            icon = ('' + icon).toUpperCase();
            icon = (icon in icons && icons[icon]) || '';
        } else {
            icon = '';
        }
        if (LOG.count !== ~~LOG.count) {
            LOG.count = 1;
        }
        count = (LOG.count > 999) ? '[' + LOG.count + '] ' : ('   [' + LOG.count + '] ').slice(-7);
        message = count + status + icon + (message instanceof Object ? message.toSource() : message) + date;
        if (LOG.store) {
            stack.push(message);
        }
        if (LOG.write) {
            bool = file && file.writable && logFile.writeln(message);
            // if the file could not be written to try again
            // it could be that it was closed or
            //  was not created because LOG.write was set to false and this is the first write attempt after setting to true.
            if (!bool) {
                file.writable = true;
                LOG.setFile(logFile);
                logFile.writeln(message);
            }
        }
        LOG.count++;
        return true;
    };

    /**
     * [logNewFile description]        Internal function for creating / preparing the log and cookie files
     *                                 When used for the log file it sets the logFile and logFolder properties
     * @param  {File Object}  file     The log or cookie file
     * @param  {Boolean} isCookie      [Optional] Whether or not the file is a cookie file see annotation by the LOG.writeFile() method
     *                                 Default value false;
     * @param  {Boolean}  overwrite    [Optional] Whether or not to overwrite the value stored in the COOKIE file
     *                                 Default value true; has no effect unless isCookie is set to true
     * @return {File (or Boolean)}     The file. if isCookie is set to true and the file could not be opened then false is returned
     */
    var logNewFile = function(file, isCookie, overwrite) {
        file.encoding = 'UTF-8'; // Might be a good idea to add a '\uFEFF' BOM character at the beginning of the file if it's not there
        file.lineFeed = ($.os[0] == 'M') ? 'Macintosh' : ' Windows';
        if (isCookie) return file.open(overwrite ? 'w' : 'e') && file;
        ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
        // Can't use readonly on non existent files, so we made up this.                                                             //
        // The point of using the writable flag is so that the log file can be setup without being created                           //
        // a practical use of this would be if we only want the log file to be created if a certain trigger happens (like and error) //
        // if the stack option is set then the log file can retrospectively save a range of previous logs.                           //
        ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
        file.writable = LOG.write;
        logFile = file;
        logFolder = file.parent;
        /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
        // if LOG.write is set to false then we can return true no matter what                                                             //
        // if the LOG.write is later set to true then the setFile function will be called on the next log call and thus call this function //
        /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
        if (continuing) {
            LOG.count = LOG.setCount(file);
        }
        return (!LOG.write && file || (file.open('a') && file));
    };

    /**
     * [setFile description]                     Used for setting the log file
     *                                           When used for the log file it sets the logFile and logFolder properties
     * @param  {File Object or String} file      The log or cookie file
     * @param  {Boolean}               isCookie  [Optional] Whether or not the file is a cookie file see annotation by the LOG.writeFile() method
     *                                           Default value false;
     * @param  {Boolean}               overwrite [Optional] Whether or not to overwrite the value stored in the COOKIE file
     *                                           Default value true; has no effect unless isCookie is set to true
     * @return {File (or Boolean)}     The file. if isCookie is set to true and the file could not be opened then false is returned
     */
    LOG.setFile = function(file, isCookie, overwrite) {
        // the file can be accessed using log.File
        var bool, folder, fileName, suffix, newFileName, f, d, safeFileName;
        d = new Date();
        // For ESTK Get the file name from the $.stack, this works from non-saved files $.fileName doesn't
        // For external runners (like Sublime Text) use $.fileName in cases that the stack returns a number
        // Such as when the log factory is included using #include
        f = $.stack.split("\n")[0].replace(/^\[\(?/, '').replace(/\)?\]$/, '');
        if (f == ~~f) {
            f = $.fileName.replace(/[^\/]+\//g, '');
        }
        safeFileName = File.encode(
            (isCookie ? '/COOKIE_' : '/LOG_') +
            f.replace(/^\//, '') + '_' + (1900 + d.getYear()) + ('' + d).replace(/... (...) (..).+/, '_$1_$2') +
            (isCookie ? '.txt' : '.log')
        );
        if (file && file.constructor.name == 'String') {
            file = (file.match('/')) ? new File(file) : new File((logFolder || Folder.temp) + '/' + file); // if the file contains a folder path then use that folder path if it just contains a file name then use the logFolder and if the logFolder is undefined then use the temp folder
        }
        if (file instanceof File) {
            // for some reason the file cannot be written so will try write the log using the same folder and different but similar file name.
            folder = file.parent;
            bool = folder.exists || folder.create();
            if (!bool) folder = Folder.temp;
            fileName = File.decode(file.name);
            suffix = fileName.match(/\.[^.]+$/);
            suffix = suffix ? suffix[0] : '';
            fileName = '/' + fileName;
            newFileName = fileName.replace(/\.[^.]+$/, '') + '_' + (+(new Date()) + suffix);
            f = logNewFile(file, isCookie, overwrite);
            if (f) return f; // try open the file as is
            f = logNewFile(new File(folder + newFileName), isCookie, overwrite);
            if (f) return f; // try first to keep the file folder and different but similar file name
            f = logNewFile(new File(folder + safeFileName), isCookie, overwrite);
            if (f) return f; // nope, so try write to the folder with a safe file name.
            if (folder != Folder.temp) {
                f = logNewFile(new File(Folder.temp + fileName), isCookie, overwrite);
                if (f) return f; // nope so try again but use the temp folder
                // LAST ATTEMPT, IF THIS FAILS IT MEANS TROUBLE (but you can't say we didn't try)
                // p.s. It will only fail if you have very major permissions problems or your disk is full
                f = logNewFile(new File(Folder.temp + safeFileName), isCookie, overwrite);
                // NO MATTER WHAT !!
                return f || new File(Folder.temp + safeFileName);
            }
        }
        return LOG.setFile(
            ((logFile && !isCookie) ? new File(logFile) : new File(Folder.temp + safeFileName)),
            isCookie,
            overwrite
        ); // no string or file given so use the file stored in logFile if there is and if not use the temp folder with a safe name.
    };

    /**
     * [setCount]            
     * @param file {File Object, String of full file path, Integer, undefined} [OPTIONAL]
     *             Either the path of the log file to from which to continue the log count.
     *             Default value is the path to the current log file.
     *             Or an integer to set the current log count.
     *             By default the log count resets to 1 each time a new LogFactory is created
     *             If this function is called either on the creation of the LogFactory
     *             var log = new LogFactory({file: 'myLog.log', continuing: true});
     *             or by calling it directly log.setCount(); then if the log file exists
     *             the log count will not automatically reset to 1
     *             rather it will continue from the last entry in the log
     *             The function is not 100% reliable but close enough.
     *             To make it 100% fail proof would cost too much resources than it's value
     */
    LOG.setCount = function(file) {
        if (~~file === file) { // files really an integer and not a file
            LOG.count = file;
            return LOG.count;
        }
        if (file === undefined) {
            file = logFile;
        }
        if (file && file.constructor === String) {
            file = new File(file);
        }
        var logNumbers, contents;
        if (!file.length || !file.exists) {
            LOG.count = 1;
            return 1;
        }
        file.open('r');
        file.encoding = 'utf-8';
        // The log could be very long and we wouldn't want to read it all
        // So we'll just check the last 10000 characters for a line number
        // In theory the last log entry could be really log so if the below test fails we'll increase the range
        file.seek(10000, 2);
        contents = '\n' + file.read();
        // this will match all line number entries
        // it could match non line number entries but it's quite unlikely and will have to do!   
        logNumbers = contents.match(/\n {0,3}\[\d+\] \[\w+\] +/g);
        if (logNumbers) {
            logNumbers = +logNumbers[logNumbers.length - 1].match(/\d+/) + 1;
            file.close();
            LOG.count = logNumbers;
            return logNumbers;
        }
        // if we get here it means we didn't find a line number yet
        // if we checked the whole file already then we know to start at 1
        if (file.length < 10001) {
            file.close();
            LOG.count = 1;
            return 1;
        }
        // if we get here it means we didn't find a line number yet
        // we didn't check the whole file yet so we'll increase the range
        // we'll do up to about 10MB, if the last log entry is longer than that then this will fail
        // in such a case the log count will start again at  1
        // if you don't like that then you can just use file.seek(0); but it's probably not a good idea
        file.seek(10000000, 2);
        contents = '\n' + file.read();
        // this will match all line number entries
        // it could match non line number entries but it's quite unlikely and will have to do!   
        logNumbers = contents.match(/\n {0,3}\[\d+\] \[\w+\] +/g);
        if (logNumbers) {
            logNumbers = +logNumbers[logNumbers.length - 1].match(/\d+/) + 1;
            file.close();
            LOG.count = logNumbers;
            return logNumbers;
        }
        // if we get here it means we didn't find a line number yet
        file.close();
        LOG.count = 1;
        return 1;
    };
    /**
     * [setLevel description] Used for setting the LOG.level
     * @param  {String, Integer, Boole} level Takes any of the values described in the logDecodeLevel function above
     * There are 8 levels for 0 to 7, any of the below values may be used in setting the level by the log.setLevel() and the new LogFactory() methods.
     * 7, NONE, OFF, NONE, NOPE, FALSE
     * 6, FATAL, FA
     * 5, ERROR, BUG, CRITICAL, e, b, c
     * 4, WARN, WARNING, w
     * 3, INFO, IMPORTANT, ON, i, im
     * 2, DEBUG, LOG, STACK, CONSTANT, FUNCTION, VARIABLE, RETURN, d, l, co, f, r, v, s
     * 1, TRACE, RESULT, STOPPER, TIMER, tr, re, st, ti, t
     * 0, ALL,YES, YEP, TRUE
     * Only logs whose statuses are of equal or higher level than the level given here will be logged
     * If the log level was set to 'error':
     * log.setLevel('e');
     * log('Be Careful', 'w'); => diddlysquat the WARNING [4] level doesn't meet our minimum error [5] level
     * log('De2ad', 'fa'); // => [1] [FATAL]   Dead [Sun Mar 05 2017 10:05:02 GMT+0200 562ms]
     * @returns {Integer} the set log level
     */
    LOG.setLevel = function(level) {
        LOG.level = LOG.logDecodeLevel(level);
        return LOG.level;
    };

    /**
     * setStatus  Sets the default status to be assigned then the log function is called without specifying a status
     * @param {Sting} status Accepts the following abbreviations,
        FA: 'FATAL',
        B: 'BUG', C: 'CRITICAL', E: 'ERROR', 
        W: 'WARNING',
        I: 'INFO', IM: 'IMPORTANT',
        D: 'DEBUG', L: 'LOG', CO: 'CONSTANT', F: 'FUNCTION', R: 'RETURN', V: 'VARIABLE', S: 'STACK',
        RE: 'RESULT', ST: 'STOPPER', TI: 'TIMER', T: 'TRACE'
        These recognized statuses are assigned levels as described in the LOG.setLevel method above
        Custom level 0 statuses can be used
     */
    LOG.setStatus = function(status) {
        status = ('' + status).toUpperCase();
        LOG.status = statuses[status] || status;
        return LOG.status;
    };

    /**
     * [cookie description] For getting and setting a level to a cookie file
     *                          A typical usage of the log.cookie method would be in a distributed production script.
     *                          Normally one wouldn't want the log to be automatically created,
     *                          instead one would want a method for the user to activate the logging by either
     *                          manually changing the contents of the log cookie or by using a provided UI option.
     * @param  {File Object or String} file - The file path of the log cookie.
     *                          The same rules apply for the file cookie file name as in the log.setFile() method,
     *                          as such the file name and path might not be the expected one.
     *                          The actual cookie file path can be extracted from the object returned by the method.
     *                          [Optional - default: A cookie file will be created in the temporary folder and called
     *                          COOKIE_Script Name_Year_Month_Date.txt for example COOKIE_Script2_2017_Feb_21.txt
     *                          effectively leaving out the file name creates a temporary cookie that will be valid until midnight] 
     * @param  {String or Integer} level - accepts the values that the setLevel() method does, see there 
     * @param  {Boolean}        overwrite - [Optional - default: false] if true then will overwrite any existing value in the cookie
     * @param  {Boolean}        setLevel - [Optional - default: true] If the log level should be set to the cookies level value
     * @return {Object}         {path: The actual path of the file cookie, level: the integer value of the level}
     * @Note                    This method also accepts use an object in the form of 
     *                          var myCookie = log.cookie({file: 'myCookie.txt', level: 'error', overwrite: true, setLevel: true});
     */

    LOG.cookie = function(file, level, overwrite, setLevel) {
        var log, cookie;
        if (!file) {
            file = {
                file: file
            };
        }
        // allow for objects and argument lists
        if (file && (file.constructor === String || file.constructor === File)) {
            file = {
                file: file
            };
        }
        log = file;
        if (log.level === undefined) {
            log.level = (level !== undefined) ? level : 'NONE';
        }
        if (log.overwrite === undefined) {
            log.overwrite = (overwrite !== undefined) ? overwrite : false;
        }
        if (log.setLevel === undefined) {
            log.setLevel = (setLevel !== undefined) ? setLevel : true;
        }
        setLevel = log.setLevel;
        overwrite = log.overwrite;
        level = log.level;
        file = log.file;
        file = LOG.setFile(file, true, overwrite);
        if (overwrite) {
            file.write(level);
        } else {
            cookie = file.read();
            if (cookie.length) {
                level = cookie;
            } else {
                file.write(level);
            }
        }
        file.close();
        if (setLevel) {
            LOG.setLevel(level);
        }
        return {
            path: file,
            level: level
        };
    };


    /**
     * [args]   Logs a well formatted report of a function with all it arguments values and names if named
     *          also shows the function name (if it has one) and more info
     *          Note: The info is assigned a FUNCTION status which has a level of 2
     *          If the LOG.level is set to 3 or above then the LOG.args() method will not do anything
     * @param  {Function arguments} args   The arguments to be parsed
     *                                     Typically one would place the line log.args(arguments); // no quote around arguments
     *                                     inside a function to get a snapshot of the arguments values
     * @param  {Function} funct [Optional] For es5 strict mode compliance one can pass the function
     *                                     (whose arguments one is processing) to this argument (currently not needed)
     * @param  {Integer} line   [Optional] The line number of the function caller.
     *                                     can use log.args(arguments, $.line);
     * @return {String}                    The report produced
     */
    LOG.args = function(args, funct, line) {
        // IF the debug level is not set to the DEBUG / FUNCTION level then return without waisting resources
        if (LOG.level > LOG_STATUS.FUNCTION) return;
        // The 5th edition of ECMAScript (ES5) forbids use of arguments.callee() in strict mode.
        // So if you want to play safe for that then pass both the arguments and the function
        // If the functions anonymous then you could have difficulty passing the function
        // A non-airtight check if the args being feed are function arguments
        // This function might be quite resource greedy
        if (!(args && ('' + args.constructor).replace(/\s+/g, '') === 'functionObject(){[nativecode]}')) return;
        // The general regex method for getting the arguments names appears several places on the web
        // I can't remember were I saw it and can't give credits for it
        // This particular implementation of it here is made by me Trevor http://www.creative-scripts.com
        if (!LOG.args.STRIP_COMMENTS) {
            LOG.args.STRIP_COMMENTS = /((\/\/.*$)|(\/\*[\s\S]*?\*\/))/mg;
        }
        if (!LOG.args.ARGUMENT_NAMES) {
            LOG.args.ARGUMENT_NAMES = /([^\s,]+)/g;
        }
        if (!LOG.args.OUTER_BRACKETS) {
            LOG.args.OUTER_BRACKETS = /^\((.+)?\)$/;
        }
        if (!LOG.args.NEW_SOMETHING) {
            LOG.args.NEW_SOMETHING = /^new \w+\((.+)?\)$/;
        }
        var functionString, argumentNames, stackInfo, report,
            functionName, arg, argsL, n, argName, argValue, argsTotal;
        // The funct value might actually be the line number as it's an optional value so
        if (funct === ~~funct) {
            line = funct;
        }
        if (!(funct instanceof Function)) {
            funct = args.callee;
        }

        if (!(funct instanceof Function)) return;
        functionName = funct.name;
        functionString = ('' + funct).replace(LOG.args.STRIP_COMMENTS, '');
        argumentNames = functionString.slice(functionString.indexOf('(') + 1, functionString.indexOf(')')).match(LOG.args.ARGUMENT_NAMES);
        // could be there's no matches so
        argumentNames = argumentNames || [];
        report = [];
        report.push('--------------');
        report.push('Function Data:');
        report.push('--------------');
        report.push('Function Name: ' + functionName);
        argsL = args.length;
        // could be there some useful info in the $.stack
        stackInfo = $.stack.split(/[\n\r]/);
        stackInfo.pop();
        stackInfo = stackInfo.join('\n                              ');
        report.push('Call stack: ' + stackInfo);
        if (line) {
            report.push('Function Line around: ' + line);
        }
        report.push('Arguments Provided: ' + argsL);
        report.push('Named Arguments: ' + argumentNames.length);
        if (argumentNames.length) {
            report.push('Arguments Names: ' + argumentNames.join(', '));
        }
        if (argsL) {
            report.push('----------------');
            report.push('Argument Values:');
            report.push('----------------');
        }
        argsTotal = Math.max(argsL, argumentNames.length);
        for (n = 0; n < argsTotal; n++) {
            argName = argumentNames[n];
            arg = args[n];
            if (n >= argsL) {
                argValue = 'NO VALUE PROVIDED';
            } else if (arg === undefined) {
                argValue = 'undefined';
            } else if (arg === null) {
                argValue = 'null';
            } else {
                argValue = arg.toSource().replace(LOG.args.OUTER_BRACKETS, '$1').replace(LOG.args.NEW_SOMETHING, '$1');
            }
            report.push((argName ? argName : 'arguments[' + n + ']') + ': ' + argValue);
        }
        report.push('');
        report = report.join('\n                  ');
        LOG(report, 'f');
        return report;
    };

    /**
     * [stack] Logs the current call stack info formated
     * @param  {Boolean} reverse [Optional] if true the last function called in the call stack is at the top
     *                                      Default false
     * @return {String} The formatted stack (function names and argument values but not names)
     *                  Can use the more detailed log.args(arguments); method for more detailed info
     */
    LOG.stack = function(reverse) {
        var st = $.stack.split('\n');
        st.pop();
        st.pop();
        if (reverse) {
            st.reverse();
        }
        return LOG(st.join('\n                  '), 's');
    };

    /**
     * [values Logs a neatly presented list of values of a array or object]
     * @param  {Array or Object} values [description]
     * @return {String}       The log produced
     */
    LOG.values = function(values) {
        var n, value, map = [];
        if (!(values instanceof Object || values instanceof Array)) {
            return;
        }
        if (!LOG.values.OUTER_BRACKETS) {
            LOG.values.OUTER_BRACKETS = /^\((.+)?\)$/;
        }
        if (!LOG.values.NEW_SOMETHING) {
            LOG.values.NEW_SOMETHING = /^new \w+\((.+)?\)$/;
        }
        for (n in values) {
            try {
                value = values[n];
                if (value === undefined) {
                    value = 'undefined';
                } else if (value === null) {
                    value = 'null';
                } else {
                    value = value.toSource().replace(LOG.values.OUTER_BRACKETS, '$1').replace(LOG.values.NEW_SOMETHING, '$1');
                }
            } catch (e) {
                value = '\uD83D\uDEAB ' + e;
            }
            map.push(n + ': ' + value);
        }
        if (map.length) {
            map = map.join('\n                  ') + '\n                  ';
            return LOG(map, 'v');
        }
    };

    /**
     * reset For reseting the count and log stack or all the log values
     * @param  {Boolean} all [Optional] whether only the stack and count are reset or if also additional properties
     * @return void
     * Probably this function need some playing with to reset missed out properties, enjoy!
     */
    LOG.reset = function(all) {
        stack.length = 0;
        LOG.count = 1;
        if (all !== false) {
            if (logFile instanceof File) {
                logFile.close();
            }
            logFile = LOG.store = LOG.writeToFile = undefined;
            LOG.write = true;
            logFolder = Folder.temp;
            logTime = new Date();
            logPoint = 'After Log Reset';
        }
    };

    /**
     * stopper description log the time elapsed between one log.stopper() call and the next log.stopper call
     * @param  {String or false} message [Optional] if false then just the time will be recored with no logging
     *                                   Otherwise the timing will be logged
     * @return {String}         The log produced
     */
    LOG.stopper = function(message) {
        var newLogTime, t, m, newLogPoint;
        newLogTime = new Date();
        newLogPoint = (LOG.count !== undefined) ? 'LOG#' + LOG.count : 'BEFORE LOG#1';
        LOG.time = t = newLogTime - logTime;
        if (message === false) {
            return;
        }
        message = message || 'Stopper start point';
        t = LOG.prettyTime(t);
        m = message + '\n                  ' +
            'From ' + logPoint + ' to ' + newLogPoint +
            ' took ' + t + ' Starting ' + logTime + ' ' + logTime.getMilliseconds() + 'ms' +
            ' Ending ' + newLogTime + ' ' + newLogTime.getMilliseconds() + 'ms';
        LOG(m, 'st');
        logPoint = newLogPoint;
        logTime = newLogTime;
        return m;
    };

    /**
     * start sets up the start times to be logged when calling the LOG.stop() method.
     * @param  {String} message [Optional]
     * @return {String}         The timing report
     */
    LOG.start = function(message) {
        var t = new Date();
        times.push([t, (message !== undefined) ? message + '' : '']);
    };

    /**
     * stop logs times from the paired LOG.start registered times.
     *         Differs from the stopper method in that the times act as brackets
     *         log.start('point 1');
     *         log.start('point 2');
     *         log.stop('This will give the time from point 2');
     *         log.stop('This will give the time from point 1');
     * @param  {String} message [Optional]
     * @return {String}         The timing report
     */
    LOG.stop = function(message) {
        if (!times.length) return;
        message = (message) ? message + ' ' : '';
        var nt, startLog, ot, om, td, m;
        nt = new Date();
        // startLog = times[0];
        startLog = times.pop();
        // times.splice(0, 1);
        ot = startLog[0];
        om = startLog[1];
        td = nt - ot;
        if (om.length) {
            om += ' ';
        }
        m = om + 'STARTED [' + ot + ' ' + ot.getMilliseconds() + 'ms]\n                  ' + message + 'FINISHED [' + nt + ' ' + nt.getMilliseconds() + 'ms]\n                  TOTAL TIME [' + LOG.prettyTime(td) + ']';
        LOG(m, 'ti');
        return m;
    };

    /**
     * [prettyTime] Represents ms times in the more friendly hours, minutes, seconds, ms format
     * @param  {Integer} t the amount of ms
     * @return {Sting} Formatted time  3 hours 25 minutes 45 seconds  & 678ms is more meaningful than 12345678ms (to me anyway!)
     */
    LOG.prettyTime = function(t) {
        var h, m, s, ms;
        h = Math.floor(t / 3600000);
        m = Math.floor((t % 3600000) / 60000);
        s = Math.floor((t % 60000) / 1000);
        ms = t % 1000;
        t = (!t) ? '<1ms' : ((h) ? h + ' hours ' : '') + ((m) ? m + ' minutes ' : '') + ((s) ? s + ' seconds ' : '') + ((ms && (h || m || s)) ? ' & ' : '') + ((ms) ? ms + 'ms' : '');
        return t;
    };


    /**
     * [get description] alerts the selected lines i.e.
     *                             log.alert(3,6,-1); will alert (1 alert not 3) the 3rd, 6th and last log entry in the stack
     *                             Note: by default the stack is set not to record so unless the stack has been set either
     *                             at the formation of the LogFactory or by using log.store = true;
     *                             Note if the log.store was not set at the same time as the log.write then the numbers won't be in sync
     * @return {undefined}
     */

    LOG.get = function() {
        if (!stack.length) return 'THE LOG IS NOT SET TO STORE';
        var a = fetchLogLines(arguments);
        return a ? '\n' + a.join('\n') : 'NO LOGS AVAILABLE';
    };

    /** [fetchLogLines] interprets the arguments of the LOG.alert, LOG.wl and LOG.range methods */
    var fetchLogLines = function() {
        var args = arguments[0];
        if (!args.length) return stack; // will return the whole log array to be outputted
        var c, n, l, a = [],
            ln, start, end, j, sl;
        l = args.length;
        sl = stack.length - 1;
        n = 0;
        for (c = 0; c < l; c++) {
            ln = args[c];
            if (~~ln === ln) { // the argument is an integer
                ln = (0 > ln) ? sl + ln + 1 : ln - 1;
                if (ln >= 0 && ln <= sl) a[n++] = stack[ln];
            } else if (ln instanceof Array && ln.length === 2) {
                start = ln[0];
                end = ln[1];
                if (!(~~start === start && ~~end === end)) continue; // the arguments are invalid so continue
                // ln = (0 > ln) ? sl + ln + 1 : ln - 1;
                start = (0 > start) ? sl + start + 1 : start - 1;
                end = (0 > end) ? sl + end + 1 : end - 1;
                start = Math.max(Math.min(sl, start), 0);
                end = Math.min(Math.max(end, 0), sl);
                if (start <= end)
                    for (j = start; j <= end; j++) a[n++] = stack[j];
                else
                    for (j = start; j >= end; j--) a[n++] = stack[j]; // go backwards
            }
        }
        return (n) ? a : false;
    };

    // to allow external access to logFile
    LOG.file = function() {
        return logFile;
    };

    /** [openFolder opens the containing folder of the log file if there is one] */
    LOG.openFolder = function() {
        if (logFolder) return logFolder.execute();
    };
    /** [openFolder opens the log file if there is one with the default application for opening the file suffix you picked for the log] */
    LOG.show = LOG.execute = function() {
        if (logFile) return logFile.execute();
    };
    /** [close Closes the log file] */
    LOG.close = function() {
        if (logFile) return logFile.close();
    };

    LOG.setFile(file);

    ////////////////////////////////////////////////////////////////////////////////////////
    // Thanks to Dirk Becker http://www.ixta.com/scripts/utilities/summaryDifference.html //
    // For permission to use his summaryDifference function                               //
    ////////////////////////////////////////////////////////////////////////////////////////
    if (!$.summary.difference) {
        $.summary.difference = function() {
            return $.summary().replace(
                / *([0-9]+) ([^ ]+)(\n?)/g,
                $.summary.updateSnapshot
            );
        };
    }
    if (!$.summary.updateSnapshot) {
        $.summary.updateSnapshot = function(full, count, name, lf) {
            var snapshot = $.summary.snapshot;
            count = Number(count);
            var prev = snapshot[name] ? snapshot[name] : 0;
            snapshot[name] = count;
            var diff = count - prev;
            if (diff === 0) return "";
            return "     ".substring(String(diff).length) + diff + " " + name + lf;
        };
    }

    if (!$.summary.snapshot) {
        $.summary.snapshot = [];
        $.summary.difference();
    }

    $.gc();
    $.gc();
    $.summary.difference();
    /**
     * [sumDiff description]
     * @param  {[type]} message [description]
     * @return {[type]}         [description]
     */
    LOG.sumDiff = function(message) {
        $.gc();
        $.gc();
        var diff = $.summary.difference();
        if (diff.length < <span class="wp-font-emots-emo-sunglasses"></span> {
            diff = ' - NONE -';
        }
        if (message === undefined) {
            message = '';
        }
        message += diff;
        return LOG('$.summary.difference(): ' + message, 'v');
    };
    return LOG;
}; // end of LogFactory

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

// LogFactory.jsx //

// Version 1 //

// 1st Published: 6th Mar 2017 //

// Modified: 6th Mar 2017 //

// May be used on condition that this comment block is left in //

// May not be distributed on the Web (A link to http://www.creative-scripts.com/logging-with-a-smile/ is allowed) //

// //

// DESCRIPTION: A LogFactory with some extras //

// Provided 'as is', with no warranty whatsoever. //

// Use and adapted the function freely providing you leave in these comment lines and specify if you have made adaptations //

// Redistribution on the Web is not allowed. //

// The function is wrapped by the LogFactory so that multiple logs can be maintained simultaneously //

// THANKS OKO see http://stackoverflow.com/questions/31232157/what-is-the-best-way-to-copy-but-not-clone-a-function-in-javascript/31235167#31235167 //

// Minimal Instructions //

// 1) Paste or #include the LogFactory.jsx to the start of the script. (One can use either the full version or the squished one) //

// 2) Set up the log file //

// var log = new LogFactory('pathToLogFile'); // a few other options here can be added //

// 3) Do some logging //

// log('hello world'); // logs with default status //

// log('hello world', 'i'); // logs with 'Info' status //

// log('hello world', 't', 'happy'); // logs with 'Trace' status with a smile //

// For detailed instructions see http://www.creative-scripts.com/logging-with-a-smile/ //

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

// jshint unused:true, undef: true

/* globals $, Folder, File */

/**

* [LogFactory description]

* @param {String or File Object} file [Optional] The location of the log file to create or append

* @@@ This argument can be an object in the form

* @@@ {file: 'pathToFile', write: boolean, store: boolean, level: String or Integer, status: string}

* All keys in the object are optional

* (Use of the object for is recommended if not using default values for the other arguments)

* Default file value is pathToTempFolder/LOG_Script Name_Year_Month_Date.log for example LOG_Script2_2017_Feb_21.log

* See LOG.setFile below

* @param {Boolean} write [Optional] Whether or not to write to the log file

* Default true

* See LOG.get() below

* @param {Boolean} store [Optional] Whether or not to store to the log file as an array in memory

* Default false

* @param {String or Integer} level [Optional] The level from which the log values should be logged from (Case insensitive)

* Default 2 / Debug

* See LOG.get() below

* @param {String} defaultStatus [Optional] The log default status (Case insensitive)

* Default 'LOG' this has the log level of 2 / Debug

* See LOG.setLevel below

* @param {Boolean} continuing [Optional] Whether or not the log numbering continues from the previous entry recorded in the log

* If false the log count will restart each time a new LogFactory is created

* If true and the already log exists the next log entry will continue from the last log count

* Default false

* See LOG.setLevel below

* @returns {Function} The LOG function If one does var log = new LogFactory('myLog.log');

* One can then start using log('hello world');

* SEE THE FULL INSTRUCTIONS http://www.creative-scripts.com/logging-with-a-smile/

var LogFactory = function(file, write, store, level, defaultStatus, continuing) { // jshint ignore: line

/////////////////////////////

// Allow passing of Object //

/////////////////////////////

if (file && (file.constructor === String || file.constructor === File)) {

file = {

file: file

};

} else if (!file) file = {

file: {}

};

write = (file.write !== undefined) ? file.write : write;

if (write === undefined) {

write = true;

}

store = (file.store !== undefined) ? file.store || false : store || false;

level = (file.level !== undefined) ? file.level : level;

defaultStatus = (file.defaultStatus !== undefined) ? file.defaultStatus : defaultStatus;

if (defaultStatus === undefined) {

defaultStatus = 'LOG';

}

continuing = (file.continuing !== undefined) ? file.continuing : continuing || false;

file = file.file || {};

var stack, times, logTime, logPoint, icons, statuses, LOG_LEVEL, LOG_STATUS;

stack = [];

times = [];

logTime = new Date();

logPoint = 'Log Factory Start';

icons = {

"1": "\ud83d\udd50", "130": "\ud83d\udd5c", "2": "\ud83d\udd51", "230": "\ud83d\udd5d", "3": "\ud83d\udd52", "330": "\ud83d\udd5e", "4": "\ud83d\udd53", "430": "\ud83d\udd5f", "5": "\ud83d\udd54", "530": "\ud83d\udd60", "6": "\ud83d\udd55", "630": "\ud83d\udd61", "7": "\ud83d\udd56", "730": "\ud83d\udd62", "8": "\ud83d\udd57", "830": "\ud83d\udd63", "9": "\ud83d\udd58", "930": "\ud83d\udd64", "10": "\ud83d\udd59", "1030": "\ud83d\udd65", "11": "\ud83d\udd5a", "1130": "\ud83d\udd66", "12": "\ud83d\udd5b", "1230": "\ud83d\udd67", "AIRPLANE": "\ud83d\udee9", "ALARM": "\u23f0", "AMBULANCE": "\ud83d\ude91", "ANCHOR": "\u2693", "ANGRY": "\ud83d\ude20", "ANGUISHED": "\ud83d\ude27", "ANT": "\ud83d\udc1c", "ANTENNA": "\ud83d\udce1", "APPLE": "\ud83c\udf4f", "APPLE2": "\ud83c\udf4e", "ATM": "\ud83c\udfe7", "ATOM": "\u269b", "BABYBOTTLE": "\ud83c\udf7c", "BAD:": "\ud83d\udc4e", "BANANA": "\ud83c\udf4c", "BANDAGE": "\ud83e\udd15", "BANK": "\ud83c\udfe6", "BATTERY": "\ud83d\udd0b", "BED": "\ud83d\udecf", "BEE": "\ud83d\udc1d", "BEER": "\ud83c\udf7a", "BELL": "\ud83d\udd14", "BELLOFF": "\ud83d\udd15", "BIRD": "\ud83d\udc26", "BLACKFLAG": "\ud83c\udff4", "BLUSH": "\ud83d\ude0a", "BOMB": "\ud83d\udca3", "BOOK": "\ud83d\udcd5", "BOOKMARK": "\ud83d\udd16", "BOOKS": "\ud83d\udcda", "BOW": "\ud83c\udff9", "BOWLING": "\ud83c\udfb3", "BRIEFCASE": "\ud83d\udcbc", "BROKEN": "\ud83d\udc94", "BUG": "\ud83d\udc1b", "BUILDING": "\ud83c\udfdb", "BUILDINGS": "\ud83c\udfd8", "BULB": "\ud83d\udca1", "BUS": "\ud83d\ude8c", "CACTUS": "\ud83c\udf35", "CALENDAR": "\ud83d\udcc5", "CAMEL": "\ud83d\udc2a", "CAMERA": "\ud83d\udcf7", "CANDLE": "\ud83d\udd6f", "CAR": "\ud83d\ude98", "CAROUSEL": "\ud83c\udfa0", "CASTLE": "\ud83c\udff0", "CATEYES": "\ud83d\ude3b", "CATJOY": "\ud83d\ude39", "CATMOUTH": "\ud83d\ude3a", "CATSMILE": "\ud83d\ude3c", "CD": "\ud83d\udcbf", "CHECK": "\u2714", "CHEQFLAG": "\ud83c\udfc1", "CHICK": "\ud83d\udc25", "CHICKEN": "\ud83d\udc14", "CHICKHEAD": "\ud83d\udc24", "CIRCLEBLACK": "\u26ab", "CIRCLEBLUE": "\ud83d\udd35", "CIRCLERED": "\ud83d\udd34", "CIRCLEWHITE": "\u26aa", "CIRCUS": "\ud83c\udfaa", "CLAPPER": "\ud83c\udfac", "CLAPPING": "\ud83d\udc4f", "CLIP": "\ud83d\udcce", "CLIPBOARD": "\ud83d\udccb", "CLOUD": "\ud83c\udf28", "CLOVER": "\ud83c\udf40", "CLOWN": "\ud83e\udd21", "COLDSWEAT": "\ud83d\ude13", "COLDSWEAT2": "\ud83d\ude30", "COMPRESS": "\ud83d\udddc", "CONFOUNDED": "\ud83d\ude16", "CONFUSED": "\ud83d\ude15", "CONSTRUCTION": "\ud83d\udea7", "CONTROL": "\ud83c\udf9b", "COOKIE": "\ud83c\udf6a", "COOKING": "\ud83c\udf73", "COOL": "\ud83d\ude0e", "COOLBOX": "\ud83c\udd92", "COPYRIGHT": "\u00a9", "CRANE": "\ud83c\udfd7", "CRAYON": "\ud83d\udd8d", "CREDITCARD": "\ud83d\udcb3", "CROSS": "\u2716", "CROSSBOX:": "\u274e", "CRY": "\ud83d\ude22", "CRYCAT": "\ud83d\ude3f", "CRYSTALBALL": "\ud83d\udd2e", "CUSTOMS": "\ud83d\udec3", "DELICIOUS": "\ud83d\ude0b", "DERELICT": "\ud83c\udfda", "DESKTOP": "\ud83d\udda5", "DIAMONDLB": "\ud83d\udd37", "DIAMONDLO": "\ud83d\udd36", "DIAMONDSB": "\ud83d\udd39", "DIAMONDSO": "\ud83d\udd38", "DICE": "\ud83c\udfb2", "DISAPPOINTED": "\ud83d\ude1e", "CRY2": "\ud83d\ude25", "DIVISION": "\u2797", "DIZZY": "\ud83d\ude35", "DOLLAR": "\ud83d\udcb5", "DOLLAR2": "\ud83d\udcb2", "DOWNARROW": "\u2b07", "DVD": "\ud83d\udcc0", "EJECT": "\u23cf", "ELEPHANT": "\ud83d\udc18", "EMAIL": "\ud83d\udce7", "ENVELOPE": "\ud83d\udce8", "ENVELOPE2": "\u2709", "ENVELOPE_DOWN": "\ud83d\udce9", "EURO": "\ud83d\udcb6", "EVIL": "\ud83d\ude08", "EXPRESSIONLESS": "\ud83d\ude11", "EYES": "\ud83d\udc40", "FACTORY": "\ud83c\udfed", "FAX": "\ud83d\udce0", "FEARFUL": "\ud83d\ude28", "FILEBOX": "\ud83d\uddc3", "FILECABINET": "\ud83d\uddc4", "FIRE": "\ud83d\udd25", "FIREENGINE": "\ud83d\ude92", "FIST": "\ud83d\udc4a", "FLOWER": "\ud83c\udf37", "FLOWER2": "\ud83c\udf38", "FLUSHED": "\ud83d\ude33", "FOLDER": "\ud83d\udcc1", "FOLDER2": "\ud83d\udcc2", "FREE": "\ud83c\udd93", "FROG": "\ud83d\udc38", "FROWN": "\ud83d\ude41", "GEAR": "\u2699", "GLOBE": "\ud83c\udf0d", "GLOWINGSTAR": "\ud83c\udf1f", "GOOD:": "\ud83d\udc4d", "GRIMACING": "\ud83d\ude2c", "GRIN": "\ud83d\ude00", "GRINNINGCAT": "\ud83d\ude38", "HALO": "\ud83d\ude07", "HAMMER": "\ud83d\udd28", "HAMSTER": "\ud83d\udc39", "HAND": "\u270b", "HANDDOWN": "\ud83d\udc47", "HANDLEFT": "\ud83d\udc48", "HANDRIGHT": "\ud83d\udc49", "HANDUP": "\ud83d\udc46", "HATCHING": "\ud83d\udc23", "HAZARD": "\u2623", "HEADPHONE": "\ud83c\udfa7", "HEARNOEVIL": "\ud83d\ude49", "HEARTBLUE": "\ud83d\udc99", "HEARTEYES": "\ud83d\ude0d", "HEARTGREEN": "\ud83d\udc9a", "HEARTYELLOW": "\ud83d\udc9b", "HELICOPTER": "\ud83d\ude81", "HERB": "\ud83c\udf3f", "HIGH_BRIGHTNESS": "\ud83d\udd06", "HIGHVOLTAGE": "\u26a1", "HIT": "\ud83c\udfaf", "HONEY": "\ud83c\udf6f", "HOT": "\ud83c\udf36", "HOURGLASS": "\u23f3", "HOUSE": "\ud83c\udfe0", "HUGGINGFACE": "\ud83e\udd17", "HUNDRED": "\ud83d\udcaf", "HUSHED": "\ud83d\ude2f", "ID": "\ud83c\udd94", "INBOX": "\ud83d\udce5", "INDEX": "\ud83d\uddc2", "JOY": "\ud83d\ude02", "KEY": "\ud83d\udd11", "KISS": "\ud83d\ude18", "KISS2": "\ud83d\ude17", "KISS3": "\ud83d\ude19", "KISS4": "\ud83d\ude1a", "KISSINGCAT": "\ud83d\ude3d", "KNIFE": "\ud83d\udd2a", "LABEL": "\ud83c\udff7", "LADYBIRD": "\ud83d\udc1e", "LANDING": "\ud83d\udeec", "LAPTOP": "\ud83d\udcbb", "LEFTARROW": "\u2b05", "LEMON": "\ud83c\udf4b", "LIGHTNINGCLOUD": "\ud83c\udf29", "LINK": "\ud83d\udd17", "LITTER": "\ud83d\udeae", "LOCK": "\ud83d\udd12", "LOLLIPOP": "\ud83c\udf6d", "LOUDSPEAKER": "\ud83d\udce2", "LOW_BRIGHTNESS": "\ud83d\udd05", "MAD": "\ud83d\ude1c", "MAGNIFYING_GLASS": "\ud83d\udd0d", "MASK": "\ud83d\ude37", "MEDAL": "\ud83c\udf96", "MEMO": "\ud83d\udcdd", "MIC": "\ud83c\udfa4", "MICROSCOPE": "\ud83d\udd2c", "MINUS": "\u2796", "MOBILE": "\ud83d\udcf1", "MONEY": "\ud83d\udcb0", "MONEYMOUTH": "\ud83e\udd11", "MONKEY": "\ud83d\udc35", "MOUSE": "\ud83d\udc2d", "MOUSE2": "\ud83d\udc01", "MOUTHLESS": "\ud83d\ude36", "MOVIE": "\ud83c\udfa5", "MUGS": "\ud83c\udf7b", "NERD": "\ud83e\udd13", "NEUTRAL": "\ud83d\ude10", "NEW": "\ud83c\udd95", "NOENTRY": "\ud83d\udeab", "NOTEBOOK": "\ud83d\udcd4", "NOTEPAD": "\ud83d\uddd2", "NUTANDBOLT": "\ud83d\udd29", "O": "\u2b55", "OFFICE": "\ud83c\udfe2", "OK": "\ud83c\udd97", "OKHAND": "\ud83d\udc4c", "OLDKEY": "\ud83d\udddd", "OPENLOCK": "\ud83d\udd13", "OPENMOUTH": "\ud83d\ude2e", "OUTBOX": "\ud83d\udce4", "PACKAGE": "\ud83d\udce6", "PAGE": "\ud83d\udcc4", "PAINTBRUSH": "\ud83d\udd8c", "PALETTE": "\ud83c\udfa8", "PANDA": "\ud83d\udc3c", "PASSPORT": "\ud83d\udec2", "PAWS": "\ud83d\udc3e", "PEN": "\ud83d\udd8a", "PEN2": "\ud83d\udd8b", "PENSIVE": "\ud83d\ude14", "PERFORMING": "\ud83c\udfad", "PHONE": "\ud83d\udcde", "PILL": "\ud83d\udc8a", "PING": "\u2757", "PLATE": "\ud83c\udf7d", "PLUG": "\ud83d\udd0c", "PLUS": "\u2795", "POLICE": "\ud83d\ude93", "POLICELIGHT": "\ud83d\udea8", "POSTOFFICE": "\ud83c\udfe4", "POUND": "\ud83d\udcb7", "POUTING": "\ud83d\ude21", "POUTINGCAT": "\ud83d\ude3e", "PRESENT": "\ud83c\udf81", "PRINTER": "\ud83d\udda8", "PROJECTOR": "\ud83d\udcfd", "PUSHPIN": "\ud83d\udccc", "QUESTION": "\u2753", "RABBIT": "\ud83d\udc30", "RADIOACTIVE": "\u2622", "RADIOBUTTON": "\ud83d\udd18", "RAINCLOUD": "\ud83c\udf27", "RAT": "\ud83d\udc00", "RECYCLE": "\u267b", "REGISTERED": "\u00ae", "RELIEVED": "\ud83d\ude0c", "ROBOT": "\ud83e\udd16", "ROCKET": "\ud83d\ude80", "ROLLING": "\ud83d\ude44", "ROOSTER": "\ud83d\udc13", "RULER": "\ud83d\udccf", "SATELLITE": "\ud83d\udef0", "SAVE": "\ud83d\udcbe", "SCHOOL": "\ud83c\udfeb", "SCISSORS": "\u2702", "SCREAMING": "\ud83d\ude31", "SCROLL": "\ud83d\udcdc", "SEAT": "\ud83d\udcba", "SEEDLING": "\ud83c\udf31", "SEENOEVIL": "\ud83d\ude48", "SHIELD": "\ud83d\udee1", "SHIP": "\ud83d\udea2", "SHOCKED": "\ud83d\ude32", "SHOWER": "\ud83d\udebf", "SLEEPING": "\ud83d\ude34", "SLEEPY": "\ud83d\ude2a", "SLIDER": "\ud83c\udf9a", "SLOT": "\ud83c\udfb0", "SMILE": "\ud83d\ude42", "SMILING": "\ud83d\ude03", "SMILINGCLOSEDEYES": "\ud83d\ude06", "SMILINGEYES": "\ud83d\ude04", "SMILINGSWEAT": "\ud83d\ude05", "SMIRK": "\ud83d\ude0f", "SNAIL": "\ud83d\udc0c", "SNAKE": "\ud83d\udc0d", "SOCCER": "\u26bd", "SOS": "\ud83c\udd98", "SPEAKER": "\ud83d\udd08", "SPEAKEROFF": "\ud83d\udd07", "SPEAKNOEVIL": "\ud83d\ude4a", "SPIDER": "\ud83d\udd77", "SPIDERWEB": "\ud83d\udd78", "STAR": "\u2b50", "STOP": "\u26d4", "STOPWATCH": "\u23f1", "SULK": "\ud83d\ude26", "SUNFLOWER": "\ud83c\udf3b", "SUNGLASSES": "\ud83d\udd76", "SYRINGE": "\ud83d\udc89", "TAKEOFF": "\ud83d\udeeb", "TAXI": "\ud83d\ude95", "TELESCOPE": "\ud83d\udd2d", "TEMPORATURE": "\ud83e\udd12", "TENNIS": "\ud83c\udfbe", "THERMOMETER": "\ud83c\udf21", "THINKING": "\ud83e\udd14", "THUNDERCLOUD": "\u26c8", "TICKBOX": "\u2705", "TICKET": "\ud83c\udf9f", "TIRED": "\ud83d\ude2b", "TOILET": "\ud83d\udebd", "TOMATO": "\ud83c\udf45", "TONGUE": "\ud83d\ude1b", "TOOLS": "\ud83d\udee0", "TORCH": "\ud83d\udd26", "TORNADO": "\ud83c\udf2a", "TOUNG2": "\ud83d\ude1d", "TRADEMARK": "\u2122", "TRAFFICLIGHT": "\ud83d\udea6", "TRASH": "\ud83d\uddd1", "TREE": "\ud83c\udf32", "TRIANGLE_LEFT": "\u25c0", "TRIANGLE_RIGHT": "\u25b6", "TRIANGLEDOWN": "\ud83d\udd3b", "TRIANGLEUP": "\ud83d\udd3a", "TRIANGULARFLAG": "\ud83d\udea9", "TROPHY": "\ud83c\udfc6", "TRUCK": "\ud83d\ude9a", "TRUMPET": "\ud83c\udfba", "TURKEY": "\ud83e\udd83", "TURTLE": "\ud83d\udc22", "UMBRELLA": "\u26f1", "UNAMUSED": "\ud83d\ude12", "UPARROW": "\u2b06", "UPSIDEDOWN": "\ud83d\ude43", "WARNING": "\u26a0", "WATCH": "\u231a", "WAVING": "\ud83d\udc4b", "WEARY": "\ud83d\ude29", "WEARYCAT": "\ud83d\ude40", "WHITEFLAG": "\ud83c\udff3", "WINEGLASS": "\ud83c\udf77", "WINK": "\ud83d\ude09", "WORRIED": "\ud83d\ude1f", "WRENCH": "\ud83d\udd27", "X": "\u274c", "YEN": "\ud83d\udcb4", "ZIPPERFACE": "\ud83e\udd10", "UNDEFINED": "", "": ""

};

statuses = {

/* OFF */

/* FATAL */

F: 'FATAL',

/* ERROR */

B: 'BUG',

C: 'CRITICAL',

E: 'ERROR',

/* WARN */

W: 'WARNING',

/* INFO */

I: 'INFO',

IM: 'IMPORTANT',

/* DEBUG */

D: 'DEBUG',

L: 'LOG',

CO: 'CONSTANT',

FU: 'FUNCTION',

R: 'RETURN',

V: 'VARIABLE',

S: 'STACK',

/* TRACE */

RE: 'RESULT',

ST: 'STOPPER',

TI: 'TIMER',

T: 'TRACE'

/* ALL */

};

LOG_LEVEL = {

NONE: 7,

OFF: 7,

FATAL: 6,

ERROR: 5,

WARN: 4,

INFO: 3,

UNDEFINED: 2,

'': 2,

DEFAULT: 2, // Should be the same as UNDEFINED and '' so if desired change them all;

DEBUG: 2,

TRACE: 1,

ON: 0,

ALL: 0,

};

LOG_STATUS = {

OFF: LOG_LEVEL.OFF,

NONE: LOG_LEVEL.OFF,

NO: LOG_LEVEL.OFF,

NOPE: LOG_LEVEL.OFF,

FALSE: LOG_LEVEL.OFF,

FATAL: LOG_LEVEL.FATAL,

BUG: LOG_LEVEL.ERROR,

CRITICAL: LOG_LEVEL.ERROR,

ERROR: LOG_LEVEL.ERROR,

WARNING: LOG_LEVEL.WARN,

INFO: LOG_LEVEL.INFO,

IMPORTANT: LOG_LEVEL.INFO,

DEBUG: LOG_LEVEL.DEBUG,

LOG: LOG_LEVEL.DEBUG,

STACK: LOG_LEVEL.DEBUG,

CONSTANT: LOG_LEVEL.DEBUG,

FUNCTION: LOG_LEVEL.DEBUG,

VARIABLE: LOG_LEVEL.DEBUG,

RETURN: LOG_LEVEL.DEBUG,

RESULT: LOG_LEVEL.TRACE,

STOPPER: LOG_LEVEL.TRACE,

TIMER: LOG_LEVEL.TRACE,

TRACE: LOG_LEVEL.TRACE,

ALL: LOG_LEVEL.ALL,

YES: LOG_LEVEL.ALL,

YEP: LOG_LEVEL.ALL,

TRUE: LOG_LEVEL.ALL

};

var logFile, logFolder;

/**

* [LOG] This is our main hero function that's created by calling the LogFactory

* i.e. var log = new LogFactory();

* See the annotations to the LogFactory function for the default values

* Once create we use log('Hello'); log('Hello', 'i'); or log('Hello', 'i' ,'happy');

* It has many methods and properties.

* Methods include : LOG.setFile(), LOG.setStatus(), LOG.setLevel(), LOG.cookie(),

* LOG.args(), LOG.stack(), LOG.values(), LOG.sumDiff(),

* LOG.stopper(), LOG.start(), LOG.stop(), log.setCount(),

* LOG.get(), LOG.openFolder(), LOG.execute(), LOG.show(),

* LOG.close(), LOG.file(), LOG.reset(),

* Properties include: LOG.write, LOG.store, LOG.level, LOG.status, LOG.count

* @param {String} message 'say something here'

* @param {String} status [Optional] (takes abbreviations) (Case insensitive) DEFAULT value LOG.status

* The levels of the statuses are explained by the annotation to the LOG.setLevel() function

* Only logs entries with statuses equal or higher than the LOG.level value will be logged

* @param {[String]} icon [Optional] (Adds emojis to the beginning of the message)

* (Case insensitive) Valid values are listed http://www.creative-scripts.com/logging-with-a-smile/#LOG

* See also the object near to the beginning of the LogFactory function 'icons = {''

var LOG = function(message, status, icon) {

if (LOG.level !== LOG_LEVEL.OFF && (LOG.write || LOG.store) && LOG.arguments.length) return LOG.addMessage(message, status, icon);

};

/**

* [LOG.logDecodeLevel description]

* @param {String, Integer, Boole} level (Case insensitive) valid values include:

* 7, NONE, OFF, NONE, NOPE, FALSE,

* 6, FATAL, FA,

* 5, ERROR, BUG, CRITICAL, e, b, c,

* 4, WARN, WARNING, w,

* 3, INFO, IMPORTANT, ON, i, im,

* 2, DEBUG, LOG, STACK, CONSTANT, FUNCTION, VARIABLE, RETURN, d, l, co, f, r, v, s,

* 1, TRACE, RESULT, STOPPER, TIMER, tr, re, st, ti, t,

* 0, ALL,YES, YEP, TRUE

* @return {Integer} The integer value of the level string

LOG.logDecodeLevel = function(level) {

// accept integers

if (level == ~~level) return Math.abs(level);

var lev;

level += '';

level = level.toUpperCase();

// accept abbreviations

if (level in statuses) {

level = statuses[level];

}

// accept generic levels like WARN etc. stored in the LOG_LEVEL object

lev = LOG_LEVEL[level];

if (lev !== undefined) return lev;

// accept level by status like CONSTANT stored in LOG_STATUS object

lev = LOG_STATUS[level];

if (lev !== undefined) return lev;

// we did try (and fail) so resort to default level

return LOG_LEVEL.DEFAULT;

};

/////////////////////////////////

// Set some defaults if needed //

/////////////////////////////////

LOG.write = write;

LOG.store = store;

LOG.level = LOG.logDecodeLevel(level);

LOG.status = defaultStatus;

/**

* See annotations to main LOG functions

* Use LOG(message, status, icon) when calling from a created log factory i.e.

* var log = new LogFactory();

* use log('Hi'); and not log.addMessage('Hi');

LOG.addMessage = function(message, status, icon) {

var date = new Date(),

count, bool, logStatus;

if (status && status.constructor.name === 'String') {

status = status.toUpperCase();

status = statuses[status] || status;

} else status = LOG.status;

/////////////////////////////////////////////////////////////

// Check the status is above or equal to the set LOG.level //

/////////////////////////////////////////////////////////////

logStatus = LOG_STATUS[status] || LOG_STATUS.ALL;

if (logStatus < LOG.level) return;

//////////////////////////////////////////////////////

// If the LOG status is appropriate then log it //

//////////////////////////////////////////////////////

date = ' \t[' + date + ' ' + date.getMilliseconds() + 'ms]';

status = '[' + status + '] ';

if (status.length < 11) status = (status + ' ').substr(0, 11);

if (icon) {

icon = ('' + icon).toUpperCase();

icon = (icon in icons && icons[icon]) || '';

} else {

icon = '';

}

if (LOG.count !== ~~LOG.count) {

LOG.count = 1;

}

count = (LOG.count > 999) ? '[' + LOG.count + '] ' : (' [' + LOG.count + '] ').slice(-7);

message = count + status + icon + (message instanceof Object ? message.toSource() : message) + date;

if (LOG.store) {

stack.push(message);

}

if (LOG.write) {

bool = file && file.writable && logFile.writeln(message);

// if the file could not be written to try again

// it could be that it was closed or

// was not created because LOG.write was set to false and this is the first write attempt after setting to true.

if (!bool) {

file.writable = true;

LOG.setFile(logFile);

logFile.writeln(message);

}

LOG.count++;

return true;

};

/**

* [logNewFile description] Internal function for creating / preparing the log and cookie files

* When used for the log file it sets the logFile and logFolder properties

* @param {File Object} file The log or cookie file

* @param {Boolean} isCookie [Optional] Whether or not the file is a cookie file see annotation by the LOG.writeFile() method

* Default value false;

* @param {Boolean} overwrite [Optional] Whether or not to overwrite the value stored in the COOKIE file

* Default value true; has no effect unless isCookie is set to true

* @return {File (or Boolean)} The file. if isCookie is set to true and the file could not be opened then false is returned

var logNewFile = function(file, isCookie, overwrite) {

file.encoding = 'UTF-8'; // Might be a good idea to add a '\uFEFF' BOM character at the beginning of the file if it's not there

file.lineFeed = ($.os[0] == 'M') ? 'Macintosh' : ' Windows';

if (isCookie) return file.open(overwrite ? 'w' : 'e') && file;

///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

// Can't use readonly on non existent files, so we made up this. //

// The point of using the writable flag is so that the log file can be setup without being created //

// a practical use of this would be if we only want the log file to be created if a certain trigger happens (like and error) //

// if the stack option is set then the log file can retrospectively save a range of previous logs. //

///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

file.writable = LOG.write;

logFile = file;

logFolder = file.parent;

/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

// if LOG.write is set to false then we can return true no matter what //

// if the LOG.write is later set to true then the setFile function will be called on the next log call and thus call this function //

/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

if (continuing) {

LOG.count = LOG.setCount(file);

}

return (!LOG.write && file || (file.open('a') && file));

};

/**

* [setFile description] Used for setting the log file

* When used for the log file it sets the logFile and logFolder properties

* @param {File Object or String} file The log or cookie file

* @param {Boolean} isCookie [Optional] Whether or not the file is a cookie file see annotation by the LOG.writeFile() method

* Default value false;

* @param {Boolean} overwrite [Optional] Whether or not to overwrite the value stored in the COOKIE file

* Default value true; has no effect unless isCookie is set to true

* @return {File (or Boolean)} The file. if isCookie is set to true and the file could not be opened then false is returned

LOG.setFile = function(file, isCookie, overwrite) {

// the file can be accessed using log.File

var bool, folder, fileName, suffix, newFileName, f, d, safeFileName;

d = new Date();

// For ESTK Get the file name from the $.stack, this works from non-saved files $.fileName doesn't

// For external runners (like Sublime Text) use $.fileName in cases that the stack returns a number

// Such as when the log factory is included using #include

f = $.stack.split("\n")[0].replace(/^\[$?/, '').replace(/$?\]$/, '');

if (f == ~~f) {

f = $.fileName.replace(/[^\/]+\//g, '');

}

safeFileName = File.encode(

(isCookie ? '/COOKIE_' : '/LOG_') +

f.replace(/^\//, '') + '_' + (1900 + d.getYear()) + ('' + d).replace(/... (...) (..).+/, '_$1_$2') +

(isCookie ? '.txt' : '.log')

);

if (file && file.constructor.name == 'String') {

file = (file.match('/')) ? new File(file) : new File((logFolder || Folder.temp) + '/' + file); // if the file contains a folder path then use that folder path if it just contains a file name then use the logFolder and if the logFolder is undefined then use the temp folder

}

if (file instanceof File) {

// for some reason the file cannot be written so will try write the log using the same folder and different but similar file name.

folder = file.parent;

bool = folder.exists || folder.create();

if (!bool) folder = Folder.temp;

fileName = File.decode(file.name);

suffix = fileName.match(/\.[^.]+$/);

suffix = suffix ? suffix[0] : '';

fileName = '/' + fileName;

newFileName = fileName.replace(/\.[^.]+$/, '') + '_' + (+(new Date()) + suffix);

f = logNewFile(file, isCookie, overwrite);

if (f) return f; // try open the file as is

f = logNewFile(new File(folder + newFileName), isCookie, overwrite);

if (f) return f; // try first to keep the file folder and different but similar file name

f = logNewFile(new File(folder + safeFileName), isCookie, overwrite);

if (f) return f; // nope, so try write to the folder with a safe file name.

if (folder != Folder.temp) {

f = logNewFile(new File(Folder.temp + fileName), isCookie, overwrite);

if (f) return f; // nope so try again but use the temp folder

// LAST ATTEMPT, IF THIS FAILS IT MEANS TROUBLE (but you can't say we didn't try)

// p.s. It will only fail if you have very major permissions problems or your disk is full

f = logNewFile(new File(Folder.temp + safeFileName), isCookie, overwrite);

// NO MATTER WHAT !!

return f || new File(Folder.temp + safeFileName);

}

return LOG.setFile(

((logFile && !isCookie) ? new File(logFile) : new File(Folder.temp + safeFileName)),

isCookie,

overwrite

); // no string or file given so use the file stored in logFile if there is and if not use the temp folder with a safe name.

};

/**

* [setCount]

* @param file {File Object, String of full file path, Integer, undefined} [OPTIONAL]

* Either the path of the log file to from which to continue the log count.

* Default value is the path to the current log file.

* Or an integer to set the current log count.

* By default the log count resets to 1 each time a new LogFactory is created

* If this function is called either on the creation of the LogFactory

* var log = new LogFactory({file: 'myLog.log', continuing: true});

* or by calling it directly log.setCount(); then if the log file exists

* the log count will not automatically reset to 1

* rather it will continue from the last entry in the log

* The function is not 100% reliable but close enough.

* To make it 100% fail proof would cost too much resources than it's value

LOG.setCount = function(file) {

if (~~file === file) { // files really an integer and not a file

LOG.count = file;

return LOG.count;

}

if (file === undefined) {

file = logFile;

}

if (file && file.constructor === String) {

file = new File(file);

}

var logNumbers, contents;

if (!file.length || !file.exists) {

LOG.count = 1;

return 1;

}

file.open('r');

file.encoding = 'utf-8';

// The log could be very long and we wouldn't want to read it all

// So we'll just check the last 10000 characters for a line number

// In theory the last log entry could be really log so if the below test fails we'll increase the range

file.seek(10000, 2);

contents = '\n' + file.read();

// this will match all line number entries

// it could match non line number entries but it's quite unlikely and will have to do!

logNumbers = contents.match(/\n {0,3}\[\d+\] \[\w+\] +/g);

if (logNumbers) {

logNumbers = +logNumbers[logNumbers.length - 1].match(/\d+/) + 1;

file.close();

LOG.count = logNumbers;

return logNumbers;

}

// if we get here it means we didn't find a line number yet

// if we checked the whole file already then we know to start at 1

if (file.length < 10001) {

file.close();

LOG.count = 1;

return 1;

}

// if we get here it means we didn't find a line number yet

// we didn't check the whole file yet so we'll increase the range

// we'll do up to about 10MB, if the last log entry is longer than that then this will fail

// in such a case the log count will start again at 1

// if you don't like that then you can just use file.seek(0); but it's probably not a good idea

file.seek(10000000, 2);

contents = '\n' + file.read();

// this will match all line number entries

// it could match non line number entries but it's quite unlikely and will have to do!

logNumbers = contents.match(/\n {0,3}\[\d+\] \[\w+\] +/g);

if (logNumbers) {

logNumbers = +logNumbers[logNumbers.length - 1].match(/\d+/) + 1;

file.close();

LOG.count = logNumbers;

return logNumbers;

}

// if we get here it means we didn't find a line number yet

file.close();

LOG.count = 1;

return 1;

};

/**

* [setLevel description] Used for setting the LOG.level

* @param {String, Integer, Boole} level Takes any of the values described in the logDecodeLevel function above

* There are 8 levels for 0 to 7, any of the below values may be used in setting the level by the log.setLevel() and the new LogFactory() methods.

* 7, NONE, OFF, NONE, NOPE, FALSE

* 6, FATAL, FA

* 5, ERROR, BUG, CRITICAL, e, b, c

* 4, WARN, WARNING, w

* 3, INFO, IMPORTANT, ON, i, im

* 2, DEBUG, LOG, STACK, CONSTANT, FUNCTION, VARIABLE, RETURN, d, l, co, f, r, v, s

* 1, TRACE, RESULT, STOPPER, TIMER, tr, re, st, ti, t

* 0, ALL,YES, YEP, TRUE

* Only logs whose statuses are of equal or higher level than the level given here will be logged

* If the log level was set to 'error':

* log.setLevel('e');

* log('Be Careful', 'w'); => diddlysquat the WARNING [4] level doesn't meet our minimum error [5] level

* log('De2ad', 'fa'); // => [1] [FATAL] Dead [Sun Mar 05 2017 10:05:02 GMT+0200 562ms]

* @returns {Integer} the set log level

LOG.setLevel = function(level) {

LOG.level = LOG.logDecodeLevel(level);

return LOG.level;

};

/**

* setStatus Sets the default status to be assigned then the log function is called without specifying a status

* @param {Sting} status Accepts the following abbreviations,

FA: 'FATAL',

B: 'BUG', C: 'CRITICAL', E: 'ERROR',

W: 'WARNING',

I: 'INFO', IM: 'IMPORTANT',

D: 'DEBUG', L: 'LOG', CO: 'CONSTANT', F: 'FUNCTION', R: 'RETURN', V: 'VARIABLE', S: 'STACK',

RE: 'RESULT', ST: 'STOPPER', TI: 'TIMER', T: 'TRACE'

These recognized statuses are assigned levels as described in the LOG.setLevel method above

Custom level 0 statuses can be used

LOG.setStatus = function(status) {

status = ('' + status).toUpperCase();

LOG.status = statuses[status] || status;

return LOG.status;

};

/**

* [cookie description] For getting and setting a level to a cookie file

* A typical usage of the log.cookie method would be in a distributed production script.

* Normally one wouldn't want the log to be automatically created,

* instead one would want a method for the user to activate the logging by either

* manually changing the contents of the log cookie or by using a provided UI option.

* @param {File Object or String} file - The file path of the log cookie.

* The same rules apply for the file cookie file name as in the log.setFile() method,

* as such the file name and path might not be the expected one.

* The actual cookie file path can be extracted from the object returned by the method.

* [Optional - default: A cookie file will be created in the temporary folder and called

* COOKIE_Script Name_Year_Month_Date.txt for example COOKIE_Script2_2017_Feb_21.txt

* effectively leaving out the file name creates a temporary cookie that will be valid until midnight]

* @param {String or Integer} level - accepts the values that the setLevel() method does, see there

* @param {Boolean} overwrite - [Optional - default: false] if true then will overwrite any existing value in the cookie

* @param {Boolean} setLevel - [Optional - default: true] If the log level should be set to the cookies level value

* @return {Object} {path: The actual path of the file cookie, level: the integer value of the level}

* @Note This method also accepts use an object in the form of

* var myCookie = log.cookie({file: 'myCookie.txt', level: 'error', overwrite: true, setLevel: true});

LOG.cookie = function(file, level, overwrite, setLevel) {

var log, cookie;

if (!file) {

file = {

file: file

};

}

// allow for objects and argument lists

if (file && (file.constructor === String || file.constructor === File)) {

file = {

file: file

};

}

log = file;

if (log.level === undefined) {

log.level = (level !== undefined) ? level : 'NONE';

}

if (log.overwrite === undefined) {

log.overwrite = (overwrite !== undefined) ? overwrite : false;

}

if (log.setLevel === undefined) {

log.setLevel = (setLevel !== undefined) ? setLevel : true;

}

setLevel = log.setLevel;

overwrite = log.overwrite;

level = log.level;

file = log.file;

file = LOG.setFile(file, true, overwrite);

if (overwrite) {

file.write(level);

} else {

cookie = file.read();

if (cookie.length) {

level = cookie;

} else {

file.write(level);

}

file.close();

if (setLevel) {

LOG.setLevel(level);

}

return {

path: file,

level: level

};

/**

* [args] Logs a well formatted report of a function with all it arguments values and names if named

* also shows the function name (if it has one) and more info

* Note: The info is assigned a FUNCTION status which has a level of 2

* If the LOG.level is set to 3 or above then the LOG.args() method will not do anything

* @param {Function arguments} args The arguments to be parsed

* Typically one would place the line log.args(arguments); // no quote around arguments

* inside a function to get a snapshot of the arguments values

* @param {Function} funct [Optional] For es5 strict mode compliance one can pass the function

* (whose arguments one is processing) to this argument (currently not needed)

* @param {Integer} line [Optional] The line number of the function caller.

* can use log.args(arguments, $.line);

* @return {String} The report produced

LOG.args = function(args, funct, line) {

// IF the debug level is not set to the DEBUG / FUNCTION level then return without waisting resources

if (LOG.level > LOG_STATUS.FUNCTION) return;

// The 5th edition of ECMAScript (ES5) forbids use of arguments.callee() in strict mode.

// So if you want to play safe for that then pass both the arguments and the function

// If the functions anonymous then you could have difficulty passing the function

// A non-airtight check if the args being feed are function arguments

// This function might be quite resource greedy

if (!(args && ('' + args.constructor).replace(/\s+/g, '') === 'functionObject(){[nativecode]}')) return;

// The general regex method for getting the arguments names appears several places on the web

// I can't remember were I saw it and can't give credits for it

// This particular implementation of it here is made by me Trevor http://www.creative-scripts.com

if (!LOG.args.STRIP_COMMENTS) {

LOG.args.STRIP_COMMENTS = /((\/\/.*$)|(\/\*[\s\S]*?\*\/))/mg;

}

if (!LOG.args.ARGUMENT_NAMES) {

LOG.args.ARGUMENT_NAMES = /([^\s,]+)/g;

}

if (!LOG.args.OUTER_BRACKETS) {

LOG.args.OUTER_BRACKETS = /^$(.+)?$$/;

}

if (!LOG.args.NEW_SOMETHING) {

LOG.args.NEW_SOMETHING = /^new \w+$(.+)?$$/;

}

var functionString, argumentNames, stackInfo, report,

functionName, arg, argsL, n, argName, argValue, argsTotal;

// The funct value might actually be the line number as it's an optional value so

if (funct === ~~funct) {

line = funct;

}

if (!(funct instanceof Function)) {

funct = args.callee;

}

if (!(funct instanceof Function)) return;

functionName = funct.name;

functionString = ('' + funct).replace(LOG.args.STRIP_COMMENTS, '');

argumentNames = functionString.slice(functionString.indexOf('(') + 1, functionString.indexOf(')')).match(LOG.args.ARGUMENT_NAMES);

// could be there's no matches so

argumentNames = argumentNames || [];

report = [];

report.push('--------------');

report.push('Function Data:');

report.push('--------------');

report.push('Function Name: ' + functionName);

argsL = args.length;

// could be there some useful info in the $.stack

stackInfo = $.stack.split(/[\n\r]/);

stackInfo.pop();

stackInfo = stackInfo.join('\n ');

report.push('Call stack: ' + stackInfo);

if (line) {

report.push('Function Line around: ' + line);

}

report.push('Arguments Provided: ' + argsL);

report.push('Named Arguments: ' + argumentNames.length);

if (argumentNames.length) {

report.push('Arguments Names: ' + argumentNames.join(', '));

}

if (argsL) {

report.push('----------------');

report.push('Argument Values:');

report.push('----------------');

}

argsTotal = Math.max(argsL, argumentNames.length);

for (n = 0; n < argsTotal; n++) {

argName = argumentNames[n];

arg = args[n];

if (n >= argsL) {

argValue = 'NO VALUE PROVIDED';

} else if (arg === undefined) {

argValue = 'undefined';

} else if (arg === null) {

argValue = 'null';

} else {

argValue = arg.toSource().replace(LOG.args.OUTER_BRACKETS, '$1').replace(LOG.args.NEW_SOMETHING, '$1');

}

report.push((argName ? argName : 'arguments[' + n + ']') + ': ' + argValue);

}

report.push('');

report = report.join('\n ');

LOG(report, 'f');

return report;

};

/**

* [stack] Logs the current call stack info formated

* @param {Boolean} reverse [Optional] if true the last function called in the call stack is at the top

* Default false

* @return {String} The formatted stack (function names and argument values but not names)

* Can use the more detailed log.args(arguments); method for more detailed info

LOG.stack = function(reverse) {

var st = $.stack.split('\n');

st.pop();

if (reverse) {

st.reverse();

}

return LOG(st.join('\n '), 's');

};

/**

* [values Logs a neatly presented list of values of a array or object]

* @param {Array or Object} values [description]

* @return {String} The log produced

LOG.values = function(values) {

var n, value, map = [];

if (!(values instanceof Object || values instanceof Array)) {

return;

}

if (!LOG.values.OUTER_BRACKETS) {

LOG.values.OUTER_BRACKETS = /^$(.+)?$$/;

}

if (!LOG.values.NEW_SOMETHING) {

LOG.values.NEW_SOMETHING = /^new \w+$(.+)?$$/;

}

for (n in values) {

try {

value = values[n];

if (value === undefined) {

value = 'undefined';

} else if (value === null) {

value = 'null';

} else {

value = value.toSource().replace(LOG.values.OUTER_BRACKETS, '$1').replace(LOG.values.NEW_SOMETHING, '$1');

}

} catch (e) {

value = '\uD83D\uDEAB ' + e;

}

map.push(n + ': ' + value);

}

if (map.length) {

map = map.join('\n ') + '\n ';

return LOG(map, 'v');

}

};

/**

* reset For reseting the count and log stack or all the log values

* @param {Boolean} all [Optional] whether only the stack and count are reset or if also additional properties

* @return void

* Probably this function need some playing with to reset missed out properties, enjoy!

LOG.reset = function(all) {

stack.length = 0;

LOG.count = 1;

if (all !== false) {

if (logFile instanceof File) {

logFile.close();

}

logFile = LOG.store = LOG.writeToFile = undefined;

LOG.write = true;

logFolder = Folder.temp;

logTime = new Date();

logPoint = 'After Log Reset';

}

};

/**

* stopper description log the time elapsed between one log.stopper() call and the next log.stopper call

* @param {String or false} message [Optional] if false then just the time will be recored with no logging

* Otherwise the timing will be logged

* @return {String} The log produced

LOG.stopper = function(message) {

var newLogTime, t, m, newLogPoint;

newLogTime = new Date();

newLogPoint = (LOG.count !== undefined) ? 'LOG#' + LOG.count : 'BEFORE LOG#1';

LOG.time = t = newLogTime - logTime;

if (message === false) {

return;

}

message = message || 'Stopper start point';

t = LOG.prettyTime(t);

m = message + '\n ' +

'From ' + logPoint + ' to ' + newLogPoint +

' took ' + t + ' Starting ' + logTime + ' ' + logTime.getMilliseconds() + 'ms' +

' Ending ' + newLogTime + ' ' + newLogTime.getMilliseconds() + 'ms';

LOG(m, 'st');

logPoint = newLogPoint;

logTime = newLogTime;

return m;

};

/**

* start sets up the start times to be logged when calling the LOG.stop() method.

* @param {String} message [Optional]

* @return {String} The timing report

LOG.start = function(message) {

var t = new Date();

times.push([t, (message !== undefined) ? message + '' : '']);

};

/**

* stop logs times from the paired LOG.start registered times.

* Differs from the stopper method in that the times act as brackets

* log.start('point 1');

* log.start('point 2');

* log.stop('This will give the time from point 2');

* log.stop('This will give the time from point 1');

* @param {String} message [Optional]

* @return {String} The timing report

LOG.stop = function(message) {

if (!times.length) return;

message = (message) ? message + ' ' : '';

var nt, startLog, ot, om, td, m;

nt = new Date();

// startLog = times[0];

startLog = times.pop();

// times.splice(0, 1);

ot = startLog[0];

om = startLog[1];

td = nt - ot;

if (om.length) {

om += ' ';

}

m = om + 'STARTED [' + ot + ' ' + ot.getMilliseconds() + 'ms]\n ' + message + 'FINISHED [' + nt + ' ' + nt.getMilliseconds() + 'ms]\n TOTAL TIME [' + LOG.prettyTime(td) + ']';

LOG(m, 'ti');

return m;

};

/**

* [prettyTime] Represents ms times in the more friendly hours, minutes, seconds, ms format

* @param {Integer} t the amount of ms

* @return {Sting} Formatted time 3 hours 25 minutes 45 seconds & 678ms is more meaningful than 12345678ms (to me anyway!)

LOG.prettyTime = function(t) {

var h, m, s, ms;

h = Math.floor(t / 3600000);

m = Math.floor((t % 3600000) / 60000);

s = Math.floor((t % 60000) / 1000);

ms = t % 1000;

t = (!t) ? '<1ms' : ((h) ? h + ' hours ' : '') + ((m) ? m + ' minutes ' : '') + ((s) ? s + ' seconds ' : '') + ((ms && (h || m || s)) ? ' & ' : '') + ((ms) ? ms + 'ms' : '');

return t;

};

/**

* [get description] alerts the selected lines i.e.

* log.alert(3,6,-1); will alert (1 alert not 3) the 3rd, 6th and last log entry in the stack

* Note: by default the stack is set not to record so unless the stack has been set either

* at the formation of the LogFactory or by using log.store = true;

* Note if the log.store was not set at the same time as the log.write then the numbers won't be in sync

* @return {undefined}

LOG.get = function() {

if (!stack.length) return 'THE LOG IS NOT SET TO STORE';

var a = fetchLogLines(arguments);

return a ? '\n' + a.join('\n') : 'NO LOGS AVAILABLE';

};

/** [fetchLogLines] interprets the arguments of the LOG.alert, LOG.wl and LOG.range methods */

var fetchLogLines = function() {

var args = arguments[0];

if (!args.length) return stack; // will return the whole log array to be outputted

var c, n, l, a = [],

ln, start, end, j, sl;

l = args.length;

sl = stack.length - 1;

n = 0;

for (c = 0; c < l; c++) {

ln = args[c];

if (~~ln === ln) { // the argument is an integer

ln = (0 > ln) ? sl + ln + 1 : ln - 1;

if (ln >= 0 && ln <= sl) a[n++] = stack[ln];

} else if (ln instanceof Array && ln.length === 2) {

start = ln[0];

end