ExtendScript (.jsx) library for Photoshop.
npm install bulk.jsxExtendScript (.jsx) library for Photoshop.
``
#include "bulk.full.jsx"
bulk(Folder.selectDialog('Select source folder.'), {filePattern: /\.(jpg|jpeg|png|gif|tif|tiff|psd)$/i})
.mode({
mode: ChangeMode.RGB
})
.resize({
type: 'fit',
width: 1000,
height: 1000,
expand: false
})
.jpg({
dest: Folder.selectDialog('Select destination folder.'),
filename: '<%= bulk.pad(index + 1, 3) %>-<%= basename %>-<%= Number(doc.width) %>x<%= Number(doc.height) %>.jpg',
overwrite: 'ask',
quality: 80
})
.exec();
`
1. Download bulk.jsx and Unzip.
2. Go to the unzipped folder bulk.jsx-master/templates and edit template.jsx (there are already some codes).
3. Launch Photoshop and select menu: File > Scripts > Brwse… then open template.jsx.
4. Script runs.
Install:
`
npm install bulk.jsx
Script:
`
#include "node_modules/bulk.jsx/bulk.full.jsx"
// your code here
`
Install:
`
bower install bulk.jsx
Script:
`
#include "bower_components/bulk.jsx/bulk.full.jsx"
// your code here
`
- src Folder | File | String | Array | bulk Object | Function
Source object:
- Folder: Use all matched files inside the folder as task targets.
- File: Use the file as task target.
- String: Absolute file/folder path. Same as File(string).bulk.src()
- Array: Dig items recursively. Folder, File, String or Array are accepted.
- bulk Object: Same as .func()
- Function: Same as .null
- options Object
- options.filePattern RegExp
Filename pattern to specify targets. If , all files are accepted. Default value: null
- options.folderPattern RegExp
Folder name pattern to specify targets. If , all folders are accepted. Default value: null
- options.mask String
Parameter passed to . Default value: '*'.true
- options.deep Boolean
Traverse deeply through files in folders. Default value: .
Returns: bulk Object
`
bulk(Folder.selectDialog('Select folder.'), {filePattern: /\.jpg$/})
.resize({type: 'fit', width: 1000, height: 1000})
.save()
.exec();
- filename String
Returns: String
`
bulk.basename('hello.jpg');
// => 'hello'
- filename String
Returns: String
`
bulk.extension('hello.jpg');
// => 'jpg'
Returns: bulk
- string String
- length Integer
- padString String
- right Boolean
Returns: String
`
bulk.pad('5', 3);
// => '005'
Shortcut of bulk.units(Units.PIXELS, callback, context).
- callback Function
- context Object
Returns: undefined
Set preference.rulerUnits to specified units, execute callback and reset to original units.
- units Units
- callback Function
- context Object
Returns: undefined
`
bulk.units(Units.INCHES, function() {
$.writeln('document width: ' + String(app.activeDocument.width) + ' inches');
$.writeln('document height: ' + String(app.activeDocument.height) + ' inches');
});
Traverse through files in source, yield each file/other object to callback.
- src Folder | File | String | Array
Source object: Folder, File, String (Same as File(string)), Array (Parse recursively).null
- fileCallback Function(file)
Callback for File objects.
- otherCallback Function(otherObject)
Callback for unknown objects.
- options Object
- options.filePattern RegExp
Filename pattern to specify targets. If null, all files are accepted. Default value:
- options.folderPattern RegExp
Folder name pattern to specify targets. If null, all folders are accepted. Default value:
- options.mask String
Parameter passed to . Default value: '*'.true
- options.deep Boolean
Traverse deeply through files in folders. Default value: .
Returns: undefined
`
bulk.walk(Folder.selectDialog('Select folder.'), function(file) {
$.writeln(file.name); // log filename
}, null, {
filePattern: /\.txt$/
});
Task: crop document.
- options Object
- options.width UnitValue
- options.height UnitValue
- options.anchor AnchorPosition
Default value: AnchorPosition.MIDDLECENTER.
Returns: bulk Object
`
bulk(src, options)
.crop({
width: 100,
height: 100,
anchor: AnchorPosition.TOPCENTER
})
.save()
.exec();
Actually execute bulk object. Specifying ruler units.
- options Object
- options.units Units
Default value: Units.PIXELS
Returns: bulk Object
Task: export document.
- options Object
- options.dest Folder | String | Template String | Function
Destination folder for output file. Default value: null..template
- Folder: Passed folder.
- String: Passed to underscore’s function with bulk.DocInfo object: _.template(string, docInfo). Then, evaluated as an absolute path, or a relative path to parent folder of the original file.func(docInfo)
- Function: Use return value of .null
- null: Same folder with the original file.
- options.filename String | Template String | Function
Filename for output file. Default value: ..template
- String: Passed to underscore’s function with bulk.DocInfo object: _.template(string, docInfo).func(docInfo)
- Function: Use return value of .'ask'
- null: Same name with the original file.
- options.overwrite Boolean | 'ask'
Define behavior in case a filename already exists. Default value: .
- true: Overwrite file.
- false: Cancel saving document.
- 'ask': Popup confirm dialog.
- options.exportType ExportType
- options.exportOptions ExportOptions
Returns: bulk Object
`
var exportOptions = new ExportOptionsSaveForWeb();
exportOptions.format = SaveDocumentType.JPEG;
exportOptions.quality = 50;
bulk(src, options)
.export({
dest: Folder.selectDialog('Select destination folder.'),
filename: '<%= basename %>-low.<%= extension %>',
overwrite: false,
exportType: ExportType.SAVEFORWEB,
exportOptions: exportOptions
})
.exec();
`
Task: export document as JPEG for web.
- options Object
- options.dest Folder | String | Template String | Function
See .export()..export()
- options.filename String | Template String | Function
See .'ask'
- options.overwrite Boolean | .export()
See .0
- options.quality Number ( – 100) 100
Default value:
Returns: bulk Object
Task: output document/file information to JavaScript console of ExtendScript Toolkit.
- options Object
- options.template String | Template String
Passed to underscore’s .template function with bulk.DocInfo object: _.template(string, docInfo). Default value: '<%= filename %>'.true
- options.opensDoc Boolean
Set if you want to use <% doc ... %> inside template string. If false, file never opens as document, unless the other tasks require doc. Default value: true.
Returns: bulk Object
`
bulk(src, options)
.log({
template: '<%= bulk.pad(index + 1, 3) %>: <%= filename %>',
opensDoc: false
})
.exec();
Example output:
`
001: hello.jpg
002: world.jpg
…
Task: change color mode of document.
- options Object
- options.mode ChangeMode
Default value: ChangeMode.RGB.
Returns: bulk Object
`
bulk(src, options)
.mode({
mode: ChangeMode.CMYK
})
.exec();
Internal method: get opensDoc property, whether or not bulk object’s tasks need to open file as Photoshop document.
Returns: Boolean
Internal method: set opensDoc property. Once it is set true, unable to change it.
- opens Boolean
Returns: bulk Object
Get options object passed to bulk().
Returns: Object
Pass bulk object to all callbacks as this. You can use this method to fork tasks.
- callbacks... Function
Returns: bulk Object
`
bulk(src, options)
.resize({
type: 'fit',
width: 1000,
height: 1000
})
.pass(
function() {
this.jpg({
dest: destForJpg,
filename: '<%= basename %>.jpg'
})
.exec();
},
function() {
this.crop({
width: 100,
height: 100
})
.png({
dest: destForPng,
filename: '<%= basename %>.png'
})
.exec();
}
);
Task: export document as 24-bit PNG for web.
- options Object
- options.dest Folder | String | Template String | Function
See .export()..export()
- options.filename String | Template String | Function
See .'ask'
- options.overwrite Boolean | .export()
See .
Returns: bulk Object
Push task to bulk object and returns clone bulk object. See “Create Custom Task” section.
- task Function
Task function executed for each document/file. this in the function is set to bulk.DocInfo.true
- opensDoc Boolean
If , bulk object opens file as document.
Returns: bulk Object
Taks: resize document.
- options (Object)
- options.type 'fit' | 'fill' | 'remain' | 'stretch' | Function(space, rect, options)
Resize method. Default value: 'fit'.true
- 'fit': Resize document to fit into space.
- 'fill': Resize document to fill space.
- 'remain': Keep document size.
- 'stretch': Resize document stretched into the same size with space. (Doesn’t keep aspect ratio)
- Function: Custom resize function. See rebounds.js for detail.
- options.width UnitValue
- options.height UnitValue
- options.reduce Boolean
Allow size reduction of document.
Default value:
- options.expand Boolean
Allow size expansion of document.
Default value:
- options.resolution Number
Default value: .ResampleMethod.BICUBICSHARPER
- options.resampleMethod ResampleMethod
Default value: .
Returns bulk Object
`
bulk(src, options)
.resize({
type: 'fit',
width: 1000,
height: 1000,
reduce: true,
expand: false,
resolution: 96,
resampleMethod: ResampleMethod.BICUBIC
})
.save()
.exec();
Task: save document.
Returns: bulk Object
`
bulk(src, options)
.mode({
mode: ChangeMode.RGB
})
.save()
.exec();
Source object passed to bulk().
Returns: Folder | File | String | Array | bulk Object | Function
Internal method: task functions added to the bulk object.
Returns: Function Array
Internal method: set tasks to the bulk object.
Returns: bulk Object
Document and File information class. Its instances are passed to task functions as this objects.
Properties:
- doc Document
Target Document object.
- file File
File object of the target Document.
- index Integer
Current index in sources.
- filename String
Filename of the File.
- basename String
Basename of the File. (example: 'hello' if filename is 'hello.jpg')'jpg'
- extension String
Extension of the File. (example: if filename is 'hello.jpg')
To create task logSize for example:
`
bulk.fn.logSize = function(options) {
// options
var filename = !!options.filename;
var prefix = options.prefix || 'document ';
var suffix = options.suffix || ' pixels';
// push task and return cloned bulk object
return this.push(function() {
// - is log function in ExtendScriptthis
// - is current bulk.DocInfo object`
if (filename) {
$.writeln(String(this.index) + ' filename: ' + this.file.name);
}
$.writeln(prefix + 'width: ' + String(this.doc.width) + suffix);
$.writeln(prefix + 'height: ' + String(this.doc.height) + suffix);
$.writeln('-');
});
};
To use:
`
bulk(src, options)
.logSize({
filename: true,
prefix: 'my document ',
suffix: 'px'
})
.exec();
Example output:
`
0 filename: hello.jpg
my document width: 500px
my document height: 350px
-
1 filename: world.jpg
my document width: 550px
my document height: 200px
-
2 filename: salt.jpg
my document width: 1024px
my document height: 768px
-
MIT License