/
html.cocoascript
executable file
·531 lines (427 loc) · 15 KB
/
html.cocoascript
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
// - Mark: Utility functions
function runCommand(cmd, path){
var task = [[NSTask alloc] init];
task.setLaunchPath("/bin/bash");
task.setArguments(cmd);
task.launch();
}
function alertError(msg, title) {
runCommand(['-c', 'afplay /System/Library/Sounds/Basso.aiff']);
alert(msg, title);
}
function alert(msg, title) {
title = title || "Alert";
var app = [NSApplication sharedApplication];
[app displayDialog:msg withTitle:title];
}
function exit() {
throw(nil);
}
function hexColor(color) {
var r = color.red() * 255;
var g = color.green() * 255;
var b = color.blue() * 255;
return ("#" + r.toString(16) + g.toString(16) + b.toString(16)).toUpperCase();
}
function nameForScale(scale) {
return (scale > 1) ? "@" + scale + "x" : "";
}
// All logic to export selection to HTML / CSS
function Exporter(context) {
var context = context;
var doc = context.document;
var page = doc.currentPage();
var selection = doc ? doc.findSelectedLayers() : nil;
var selectedArtboards = getSelectedArtboards();
var imageFormat = "svg";
var imageScales = [1];
var embedSvg = false;
var exportFolder = null;
this.setOptions = function(options) {
imageFormat = options.imageFormat;
embedSvg = options.embedSvg;
imageScales = options.imageScales;
}
// Accessors
this.getSelection = function() {
return selection;
}
this.getSelectedArtboards = function() {
return selectedArtboards;
}
// Utility functions
function forEachLayer(group, func) {
var layers = group.layers();
for (var i=0; i < layers.count(); i++) {
func(layers.objectAtIndex(i));
}
};
function forEachChild(group, func) {
var layers = group.children();
for (var i=0; i < layers.count(); i++) {
func(layers.objectAtIndex(i));
}
}
function cleanString(str) {
return str.replace(/\W+/g, "-");
}
function layerMarkedForExport(layer) {
var exportOptions = layer.exportOptions();
var formats = exportOptions.exportFormats();
return formats.count() > 0;
}
function saveTextToFile (filename, text) {
var path = [@"" stringByAppendingString:filename];
var str = [@"" stringByAppendingString:text];
str.dataUsingEncoding_(NSUTF8StringEncoding).writeToFile_atomically_(path, true);
}
// Gets the artboards belonging to the selected items
function getSelectedArtboards() {
var artboards = [];
selection.forEach(function(layer) {
var artboard = layer.parentArtboard();
if (artboard != undefined) {
artboards.push(artboard);
}
});
return artboards;
}
var exportLayers = {};
function generateHTML(artboard) {
// Create new array to save layers for export for each artboard
exportLayers[artboard] = [];
// Get HTML & CSS for children
var childrenHtml = generateHTMLForChildren(artboard, "\t\t\t");
// Generate HTML
var html = generateHTMLHeader(artboard);
html += childrenHtml;
html += generateHTMLFooter();
return html;
}
function generateCSS(artboard) {
// Generate CSS
var css = "/* Generated by Sketch HTML Export */\n";
css += "\n"
css += "/* Boiler plate CSS */\n";
css += "\n";
css += generateBoilerPlateCSS();
css += "\n";
css += "/* Specific to " + artboard.name() + " */\n";
css += generateCSSForArtboard(artboard);
css += "\n";
exportLayers[artboard].forEach(function(layer) {
css += generateCSSForLayer(layer);
});
return css;
}
function generateHTMLHeader(artboard) {
var html = "<html>\n";
html += "\t<head>\n";
html += "\t\t<link href='styles.css' rel='stylesheet'>\n";
html += "\t</head>\n";
html += "\t<body>\n";
html += "\t\t<div class='sk-ab sk-" + cleanString(artboard.name()) + "'>\n";
return html;
}
function generateHTMLFooter() {
var html = "\t\t</div>\n";
html += "\t</body>\n";
html += "</html>";
return html;
}
function generateHTMLForChildren(group, tabs) {
var html = "";
forEachLayer(group, function(layer) {
if (!layer.isVisible()) {
return;
}
var openTag = tabs + "<div class='sk-asset sk-" + cleanString(layer.name()) + "'>";
var closeTag = "</div>\n";
// If layer is exportable, write it to HTML but not its children
if (layerMarkedForExport(layer)) {
// This layer's image needs to be exported
exportLayers[layer.parentArtboard()].push(layer);
var embedCode = "";
if (embedSvg) {
embedCode = generateSVGString(layer);
}
html += openTag + embedCode + closeTag;
}
// If layer is group...
else if (layer instanceof MSLayerGroup) {
var childrenHtml = generateHTMLForChildren(layer, tabs + "\t");
// If group is not empty, write it and its children to HTML
if (childrenHtml != "") {
html += openTag + "\n";
html += childrenHtml;
html += tabs + closeTag;
// This layer needs to be exported to HTML
exportLayers[layer.parentArtboard()].push(layer);
}
}
});
return html;
}
function exportImages(layers, exportPath) {
layers.forEach(function(layer) {
exportImageForLayer(layer, exportPath + "images/", imageFormat, imageScales);
});
}
function exportImageForLayer(layer, exportPath, imageFormat, imageScales) {
var filePaths = [];
var formats = imageScales.map(function(scale) {
return [MSExportFormat formatWithScale:scale name:nameForScale(scale) fileFormat:imageFormat];
});
var requests = [MSExportRequest exportRequestsFromExportableLayer:layer exportFormats:formats useIDForName: false];
requests.forEach(function(request) {
var filePath = exportPath + request.name() + "." + request.format();
filePaths.push(filePath);
[doc saveExportRequest:request toFile: filePath];
});
return filePaths;
}
function generateSVGString(layer) {
var filePaths = exportImageForLayer(layer, exportFolder, "svg", [1]);
var filePath = filePaths[0];
var fileUrl = [NSURL fileURLWithPath:filePath];
var str = [[NSString alloc] initWithContentsOfURL:fileUrl];
deleteFile(filePath);
return str;
}
function generateCSSForLayer(layer) {
var css = ".sk-asset.sk-" + cleanString(layer.name()) + " {\n";
css += "\twidth: " + Math.round(layer.frame().width()) + "px;\n";
css += "\theight: " + Math.round(layer.frame().height()) + "px;\n";
css += "\tleft: " + Math.round(layer.frame().x()) + "px;\n";
css += "\ttop: " + Math.round(layer.frame().y()) + "px;\n";
// Set background image for exported layer
if (layerMarkedForExport(layer) && !embedSvg) {
css += "\tbackground-image: url(\"images/" + layer.name() + "." + imageFormat + "\");\n";
}
css += "}\n";
css += "\n";
// Set background image for exported layer
if (layerMarkedForExport(layer) && !embedSvg && imageScales.length > 1) {
for (var index in imageScales) {
var scale = imageScales[index];
if (scale > 1) {
var appendName = nameForScale(scale);
css += "@media only screen and (min--moz-device-pixel-ratio: " + scale + "),\n"
+ "only screen and (-o-min-device-pixel-ratio: " + scale + "/1),\n"
+ "only screen and (-webkit-min-device-pixel-ratio: " + scale + "),\n"
+ "only screen and (min-device-pixel-ratio: " + scale + ") {\n";
css += "\t.sk-asset.sk-" + cleanString(layer.name()) + " {\n";
css += "\t\tbackground-image: url(\"images/" + layer.name() + appendName + "." + imageFormat + "\");\n";
css += "\t\tbackground-size: " + Math.round(layer.frame().width()) + "px " + Math.round(layer.frame().height()) + "px;\n";
css += "\t}\n";
css += "}\n";
}
}
}
return css;
}
// Generate Header CSS
function generateBoilerPlateCSS() {
var css = ".sk-ab {\n"
+ "\tposition: relative;\n"
+ "\toverflow: hidden;\n"
+ "}\n";
css += "\n";
css += ".sk-asset {\n"
+ "\tposition: absolute;\n"
+ "\tbackground-repeat: no-repeat;\n"
+ "}\n";
return css;
}
// Generates CSS for just the artboard div
function generateCSSForArtboard(artboard) {
var css = ".sk-ab.sk-" + cleanString(artboard.name()) + " {\n";
if (artboard.hasBackgroundColor) {
css += "\tbackground-color: " + hexColor(artboard.backgroundColor()) + ";\n";
}
css += "\twidth: " + Math.round(artboard.frame().width()) + "px;\n";
css += "\theight: " + Math.round(artboard.frame().height()) + "px;\n";
css += "}\n";
return css;
}
this.saveFiles = function(folder) {
exportFolder = folder;
selectedArtboards.forEach(function(artboard) {
var exportPath = exportFolder + artboard.name() + "/";
deleteFile(exportPath);
createFolder(exportPath);
var htmlPath = exportPath + "index.html";
saveTextToFile(htmlPath, generateHTML(artboard));
var cssPath = exportPath + "styles.css";
saveTextToFile(cssPath, generateCSS(artboard));
if (!embedSvg) {
createFolder(exportPath + "images/");
exportImages(exportLayers[artboard], exportPath);
}
});
}
}
function createFolder(name) {
var fileManager = [NSFileManager defaultManager];
[fileManager createDirectoryAtPath:name withIntermediateDirectories:true attributes:nil error:nil];
}
function deleteFile(name) {
var fileManager = [NSFileManager defaultManager];
[fileManager removeItemAtPath:name error:nil];
}
function fileSaver() {
// Panel
var openPanel = [NSOpenPanel openPanel]
[openPanel setTitle: "Choose a location…"]
[openPanel setMessage: "Select the export location…"];
[openPanel setPrompt: "Export"];
[openPanel setCanCreateDirectories: true]
[openPanel setCanChooseFiles: false]
[openPanel setCanChooseDirectories: true]
[openPanel setAllowsMultipleSelection: false]
[openPanel setShowsHiddenFiles: false]
[openPanel setExtensionHidden: false]
// [openPanel setDirectoryURL:url]
var openPanelButtonPressed = [openPanel runModal]
if (openPanelButtonPressed == NSFileHandlingPanelOKButton) {
return [openPanel URL]
} else {
exit();
}
}
function getOptions(exporter) {
// Create alert window
var alert = NSAlert.alloc().init();
alert.setMessageText("Image Options");
alert.addButtonWithTitle('Continue');
alert.addButtonWithTitle('Cancel');
// Create panel
var view = NSView.alloc().initWithFrame(NSMakeRect(0, 0, 300, 180));
alert.setAccessoryView(view);
// Create a label for image format
var formatLabel = [[NSTextField alloc] initWithFrame:NSMakeRect(0, 160, 300, 18)];
[formatLabel setStringValue:"Export images as:"];
// [formatLabel setFont:[NSFont boldSystemFontOfSize:12]];
[formatLabel setFont:[NSFont systemFontOfSize:12]];
[formatLabel setBezeled:false];
[formatLabel setDrawsBackground:false];
[formatLabel setEditable:false];
[formatLabel setSelectable:false];
[view addSubview:formatLabel];
// Create radio button array for image format
var formatButton = NSButtonCell.alloc().init();
formatButton.setButtonType(NSRadioButton);
var formatMatrix = [[NSMatrix alloc] initWithFrame:NSMakeRect(0, 110, 300, 40)
mode:NSRadioModeMatrix
prototype:formatButton
numberOfRows:2
numberOfColumns:1];
var cellArray = formatMatrix.cells();
cellArray.objectAtIndex(0).setTitle("png");
cellArray.objectAtIndex(1).setTitle("svg");
view.addSubview(formatMatrix);
// Create view for SVG options
var svgView = NSView.alloc().initWithFrame(NSMakeRect(0, 20, 300, 70));
svgView.hidden = true;
view.addSubview(svgView);
// Create a label for svg Options
var svgLabel = [[NSTextField alloc] initWithFrame:NSMakeRect(0, 50, 300, 18)];
[svgLabel setStringValue:"Export SVG as:"];
[svgLabel setFont:[NSFont systemFontOfSize:12]];
[svgLabel setBezeled:false];
[svgLabel setDrawsBackground:false];
[svgLabel setEditable:false];
[svgLabel setSelectable:false];
[svgView addSubview:svgLabel];
// Create radio button array for SVG options
var svgOptionButton = NSButtonCell.alloc().initTextCell("Separate image files");
svgOptionButton.setButtonType(NSRadioButton);
var svgMatrix = [[NSMatrix alloc] initWithFrame:NSMakeRect(0, 0, 300, 40)
mode:NSRadioModeMatrix
prototype:svgOptionButton
numberOfRows:2
numberOfColumns:1];
cellArray = svgMatrix.cells();
cellArray.objectAtIndex(0).setTitle("Separate image files");
cellArray.objectAtIndex(1).setTitle("Embeded in HTML");
svgView.addSubview(svgMatrix);
// Create view for PNG options
var pngView = NSView.alloc().initWithFrame(NSMakeRect(0, 0, 300, 90));
view.addSubview(pngView);
// Create a label for png Options
var pngLabel = [[NSTextField alloc] initWithFrame:NSMakeRect(0, 70, 300, 18)];
[pngLabel setStringValue:"PNG sizes:"];
[pngLabel setFont:[NSFont systemFontOfSize:12]];
[pngLabel setBezeled:false];
[pngLabel setDrawsBackground:false];
[pngLabel setEditable:false];
[pngLabel setSelectable:false];
[pngView addSubview:pngLabel];
// Add PNG options
var pngButton = NSButtonCell.alloc().init();
pngButton.setTitle("Support Retina Sizes");
pngButton.setButtonType(NSSwitchButton);
[pngButton setState:NSOnState];
var pngMatrix = [[NSMatrix alloc] initWithFrame:NSMakeRect(0, 0, 300, 60)
mode:NSTrackModeMatrix
prototype:pngButton
numberOfRows:3
numberOfColumns:1];
pngMatrix.setAllowsEmptySelection(true);
var pngCellArray = pngMatrix.cells();
pngCellArray.objectAtIndex(0).setTitle("@1x");
pngCellArray.objectAtIndex(1).setTitle("@2x");
pngCellArray.objectAtIndex(2).setTitle("@3x");
pngCellArray.objectAtIndex(0).setEnabled(false);
pngView.addSubview(pngMatrix);
// Detect what format is selected and updated UI
[formatMatrix setCOSJSTargetFunction:function(sender) {
if (formatMatrix.selectedRow() == 0) { // PNG
svgView.hidden = true;
pngView.hidden = false;
} else { // SVG
svgView.hidden = false;
pngView.hidden = true;
}
}];
[formatMatrix setAction:"callAction:"]
// Display alert
var responseCode = alert.runModal();
// Errors or user hit cancel
if (responseCode != NSAlertFirstButtonReturn) {
exit();
}
// Return options
var options = {};
options.imageFormat = formatMatrix.selectedCells()[0].title();
options.embedSvg = svgMatrix.selectedRow() == 1;
options.imageScales = [];
for (var i = 0; i < pngCellArray.count(); i++) {
var cell = pngCellArray.objectAtIndex(i);
if (cell.state()) {
options.imageScales.push(parseInt(cell.title().substring(1)));
}
}
return options;
}
// Called when user runs "Eport HTML"
function exportHTML(context) {
try {
var exporter = new Exporter(context);
if (exporter.getSelectedArtboards() == undefined || exporter.getSelectedArtboards().length < 1) {
alertError("Please select the artboards you want to export to HTML.", "No Artboard Selected");
return;
}
var options = getOptions();
exporter.setOptions(options);
// Open the system dialog to choose the export location
var fileURL = fileSaver();
var exportPath = fileURL.path() + "/";
exporter.saveFiles(exportPath);
} catch(e) {
if (e != nil) { // Nil error means plugin was exited
log(e);
alert(e, "Error");
}
}
}