Hello gang!
I just wanted to share with you my small utility tool for Photoshop called Clean SL that cleans ScriptingListenerJS.log file to make it more readable.
Recently watched Davide_Barranca's Adobe Photoshop HTML Panels Development course and realised how painful it is to work with Action Manager's code and how unreadable it is right off the box. I know there are quite a few other tools that cleans log file, however it doesn't hurt to have an option to choose.
Interested? Grab it here: rendertom / Clean SL / source / — Bitbucket
Script performs multiple actions such as cleaning-up variable names and hoisting them to the top, wraps code block into function, converts charID to string ID for better readability and such. Resulting code is clean and maintains better readability.
Features:
- Load entire ScriptingListenerJS.log content
- Load only last entry in ScriptingListenerJS.log
- Enter ScriptingListenerJS code manually
Options:
- Hoist variable declaration to the top
- Consolidate variables
- Give descriptive variable names
- Convert charID to stringID for better readability
- Replace stringIDToTypeID() to s2t() function
- Wrap to function block.
Example:
From this:
var idHStr = charIDToTypeID( "HStr" );
var desc21 = new ActionDescriptor();
var idpresetKind = stringIDToTypeID( "presetKind" );
var idpresetKindType = stringIDToTypeID( "presetKindType" );
var idpresetKindCustom = stringIDToTypeID( "presetKindCustom" );
desc21.putEnumerated( idpresetKind, idpresetKindType, idpresetKindCustom );
var idClrz = charIDToTypeID( "Clrz" );
desc21.putBoolean( idClrz, false );
var idAdjs = charIDToTypeID( "Adjs" );
var list1 = new ActionList();
var desc22 = new ActionDescriptor();
var idH = charIDToTypeID( "H " );
desc22.putInteger( idH, 39 );
var idStrt = charIDToTypeID( "Strt" );
desc22.putInteger( idStrt, 23 );
var idLght = charIDToTypeID( "Lght" );
desc22.putInteger( idLght, -27 );
var idHsttwo = charIDToTypeID( "Hst2" );
list1.putObject( idHsttwo, desc22 );
desc21.putList( idAdjs, list1 );
executeAction( idHStr, desc21, DialogModes.NO );
to this:
hueSaturation();
function hueSaturation() {
var s2t = function (s) {
return app.stringIDToTypeID(s);
};
var descriptor = new ActionDescriptor();
var list = new ActionList();
var descriptor2 = new ActionDescriptor();
descriptor.putEnumerated( s2t( "presetKind" ), s2t( "presetKindType" ), s2t( "presetKindCustom" ));
descriptor.putBoolean( s2t( "colorize" ), false );
descriptor2.putInteger( s2t( "hue" ), 39 );
descriptor2.putInteger( s2t( "saturation" ), 23 );
descriptor2.putInteger( s2t( "lightness" ), -27 );
list.putObject( s2t( "hueSatAdjustmentV2" ), descriptor2 );
descriptor.putList( s2t( "adjustment" ), list );
executeAction( s2t( "hueSaturation" ), descriptor, DialogModes.NO );
}
Installation
Clone or download repository and place Clean SJ.jsx script to Photoshop’s Scripts folder:
Adobe Photoshop CC 20XX -> Presets -> Scripts -> Clean JS.jsx
Restart Photoshop to access Clean JS script from File -> Scripts
------------------------------------------------
Since I am rather new to Photoshop Scripting, I might have missed something of my code brakes. So if you find any bugs or issues, please do not hesitate to let me know so I could fix it.
So, happy cleaning everybody!
Explore related tutorials & articles
131
Replies
Much love to everyone contributing, especially JJMack for testing it. Love you guys!
Clean SL v1.3 is online: Please remove old Clean SL Settings.txt file before using this update.
- Renames Descriptive variable name to Rename constructors
- Renames Shorten stringIDToTypeID to Shorten method names
- Exposes predefined object with variables for you guys to change in code:
- junkArray: in case I am removing something important, feel free to edit this.
- constructorNames: feel free to change how you name your constructors. Davide_Barranca going to love this!
- shortMethodNames : if you don't like name s2t() or c2t() feel free to edit this.
- printToESTK: want to print clean code to ESTK console? Sure thing SuperMerlin
- removeJunkOnFullLogRead: as you requested JJMack
- closeAfterSaving : done! geppettol66959005
- Removes duplicate variable declarations and sorts them alphabetically when hoisting
- Shorten method names shortens both charIDToTypeID() and stringIDToTypeID()
- Skips converting charIDtoStringID() if CharID has conflicting StringID values - thanks xbytor2 and Davide_Barranca for bringing this to my attention.
- Parses variable declarations to check if same variable has different values - JJMack you had issues with this in your extra-big log file you sent me earlier.
Enjoy! 
What have I done wrong? Is there a dependency on this JSON2.JS file? Latest CC17…
Is this the one?
I have updated the code:
//@include "/Applications/Adobe Photoshop CS6/Presets/Scripts/json2.js"
Should I be using CC17 instead? I usually have ScriptListener in a lesser used “sandpit” version, in this case CS6.
Now returns a new error:
EDIT: Same error in CC17. I have tried moving the JSON2 file into different folders, both inside and outside of the logged in User’s folder with the same results (obviously updating the path each time).
Thomas
I want to thank you again for this tool ant the work you have put into it. You know I only hack at scripting. I use windows and control the Scriptlistener log via Windows commands. Which I wrapped into a widows Batch command file. I'm sure you could do something like that on a Mac. If the JSX Launcher works on a Mac and works it does on windows With CC 2014 through CC 2017 you could also have a persistent Palette window in Photoshop to control the log file. If you start the palette before opening any document the Palette will be associated with the JSX Launcher and stick around. As lone as Photoshop and SAX Launcher extension is active. I wrote an Palette script today for windows. You could most likely to use it with Mac OSX and CC 2014 - CC 2017. With the right OSX command. Or even modify it to work on both Windows and Mac machine by testing the users platform. You could distribute is along with Clean SL as a companion palette.
]
Jive messes with formatting Its not much code you should be able to still read it. Or use the link
// JJMack 2017 Control Scriptistener Log in Photoshop
var palette = new Window( "palette" ,"Scriptlistener Log File");
palette.orientation = "row";
palette.btna = palette.add( "button", undefined,'Lock' );
palette.btnb = palette.add( "button", undefined,'UnLock' );
palette.btnc = palette.add( "button", undefined,'Edit' );
palette.btnd = palette.add( "button", undefined,'Clear' );
palette.btnx = palette.add( "button", undefined, "Exit Palette");
customEventManager = {
events: {},
addListener: function( evt, handler, context ) {
if ( !this.events[ evt ] ) {
this.events[ evt ] = [];
}
this.events[ evt ].push( { "handler": handler, "context": context } );
},
trigger: function( evt ) {
if ( this.events[ evt ] ) {
for ( var i = 0; i < this.events[ evt ].length; i++ ) {
this.events[ evt ][ i ].handler.call( this.events[ evt ][ i ].context, evt );
}
}
}
}
palette.btna.onClick = function() {palette.evt.trigger( "Lock" );}
palette.btnb.onClick = function() {palette.evt.trigger( "UnLock" );}
palette.btnc.onClick = function() {palette.evt.trigger( "Edit" );}
palette.btnd.onClick = function() {palette.evt.trigger( "Clear" );}
palette.btnx.onClick = function() {palette.close();};
aHandler = function( evt) {
app.system('Attrib +R "%USERPROFILE%\\Desktop\\ScriptingListenerJS.log"');
}
bHandler = function( evt) {
app.system('Attrib -R "%USERPROFILE%\\Desktop\\ScriptingListenerJS.log"');
}
cHandler = function( evt) {
app.system('Start notepad "%USERPROFILE%\\Desktop\\ScriptingListenerJS.log"');
}
dHandler = function( evt) {
app.system('Echo. > "%USERPROFILE%\\Desktop\\ScriptingListenerJS.log"');
}
palette.evt = customEventManager;
palette.evt.addListener( "Lock", aHandler );
palette.evt.addListener( "UnLock", bHandler );
palette.evt.addListener( "Edit", cHandler );
palette.evt.addListener( "Clear", dHandler );
palette.onShow = function(){
var ww = palette.bounds.width;
var hh = palette.bounds.height;
PaletteDisplay = 0; // Photoshop's First Display
//PaletteDisplay = $.screens.length-1; // Photoshop's Last Display
PaletteTop = $.screens[PaletteDisplay].top + 990; // Relative to Top of display
PaletteLeft] = $.screens[PaletteDisplay].right - ww - 41 ; // Relative to Right of side not Left side of display
palette.bounds.x = PaletteLeft;
palette.bounds.y = PaletteTop;
palette.bounds.width = ww;
palette.bounds.height = hh;
}
//alert($.screens);
palette.show();
AdChoices