Sketch.app Copyeditor Plugin

copyeditor.js

// repo here: https://github.com/caycefischer/sketch-copyeditor

var com = {};

com.updatecopy = {

    debugLog: function(msg) {
        if(this.debug) log(msg);
    },

    alert: function (msg, title) {
        title = title || 'Sketch Copy Update';
        var app = [NSApplication sharedApplication];
        [app displayDialog:msg withTitle:title];
    },
    getTextLayersForPage: function(page) {
        var layers = [page children],
                textLayers = [];

        for (var i = 0; i < layers.count(); i++) {
            var layer = [layers objectAtIndex:i];
            if (this.isTextLayer(layer)) {
                textLayers.push(layer);
            }
        }

        return textLayers;
    },

    isTextLayer: function(layer) {
        if (layer.class() === MSTextLayer) {
            return true;
        }
        return false;
    },

    localeStringFromTextLayers: function(textLayers) {
        var localeObject = {};

        for (var i = 0; i < textLayers.length; i++) {
            var textLayer = textLayers[i],
                    stringValue = unescape(textLayer.stringValue());

            // localeObject[stringValue] = stringValue;

            var textLayer2 = textLayers[i],
                stringValue2 = unescape(textLayer2.name());

            localeObject[stringValue2] = stringValue;
        }

        var localeJsonString = JSON.stringify(localeObject, undefined, 2);

        return localeJsonString;
    },

    generateLocaleForPage: function(page) {
        var textLayers = this.getTextLayersForPage(page);
        return this.localeStringFromTextLayers(textLayers);
    },

    generateLocaleForCurrentPage: function() {
        var currentPage = [doc currentPage];
        return this.generateLocaleForPage(currentPage);
    },

    copyStringToClipboard: function(string) {
        var clipboard = NSPasteboard.generalPasteboard();
        clipboard.declareTypes_owner([NSPasteboardTypeString], null);
        clipboard.setString_forType(string , NSPasteboardTypeString);
        this.alert('The copy deck for this Sketch file has been copied to your clipboard, paste it in a text editor and save it as a *.json file for example \'copydeck-V1.json\'.\n\nWhen you are ready to import your changes run \'2. Update Copy\' and pick your json file that contains the updated copy.', null);
        return true;
    },

    updatePageWithData: function(page, language, data) {
        var pageName = [page name],
                page = [page copy]
                // page.setName(pageName + ': ' + language),
                page.setName(language),
                textLayers = this.getTextLayersForPage(page),
                errorCount = 0;

        [[doc documentData] addPage:page];

        for (var i = 0; i < textLayers.length; i++) {
            var textLayer = textLayers[i],
                    nameValue = unescape(textLayer.name());
            
            // THIS
            if(data[nameValue]){
                textLayer.setStringValue(data[nameValue]);
                [textLayer adjustFrameToFit];
            }else{
                errorCount++;
            }
        }

        [doc setCurrentPage:page];

        // add suffix to artboard names
        var artboards = page.artboards();

        var loop = [artboards objectEnumerator]
        while (artboard = loop.nextObject()) {
            // artboard.setName(artboard.name() + "_" + language);
        }

        return errorCount;
    },

    updatePageWithFilePicker: function(page) {
        var openPanel = [NSOpenPanel openPanel];

        var defaultDirectory = [NSURL fileURLWithPath:"~/Documents/"];
        if([doc fileURL]) {
            defaultDirectory = [[doc fileURL] URLByDeletingLastPathComponent]]
        }

        [openPanel setCanChooseDirectories:true];
        [openPanel setCanChooseFiles:true];
        [openPanel setAllowedFileTypes:['json']];
        [openPanel setCanCreateDirectories:false];
        [openPanel setDirectoryURL:defaultDirectory];
        [openPanel setAllowsMultipleSelection: true]

        [openPanel setTitle:"Pick a copy file"];
        [openPanel setPrompt:"Update Copy"];

        if ([openPanel runModal] == NSOKButton) {
            var urls = [openPanel URLs];
            var errorCount = 0;

            var url, filename, getString;
            for (var i = 0; i < urls.count(); i++) {
                url = urls[i];
                filename = [[url lastPathComponent] stringByDeletingPathExtension];
                getString = NSString.stringWithContentsOfFile_encoding_error(url, NSUTF8StringEncoding, null);

                if(getString){
                    data = JSON.parse(getString.toString());
                    errorCount += this.updatePageWithData(page, filename, data);
                }
            }
            if (errorCount > 0){
                this.alert('Copy Update completed with ' + errorCount + ' errors.', null);
            }else{
                this.alert('Copy Update completed successfully! \n*** IMPORTANT: Please immediately save your file, close it and then reopen it. This avoids any Sketch bugs or weirdness. ***', null);
            }
        }

        return true;
    },

    debug: false

};