move export config to .sketchrc

mathieudutour · mathieudutour · commit 238f950444ee · 2017-04-11T10:52:03.000+01:00
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,5 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
diff --git a/.eslintrc b/.eslintrc
@@ -9,5 +9,4 @@ parserOptions:
   ecmaVersion: 2017
   sourceType: module
   ecmaFeatures:
-    experimentalObjectRestSpread: true
     jsx: true
diff --git a/.gitsketchrc b/.gitsketchrc
@@ -0,0 +1,6 @@
+{
+  "exportFolder": ".exportedArtboards",
+  "exportFormat": "png",
+  "exportScale": "0.5",
+  "includeOverviewFile": false
+}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,11 @@
+## [0.10.0] - 2017-04-11
+
+* move export config to `.gitsketchrc` so that everybody working
+  on the same file will have the same settings
+* fix the default config which could be break sometimes
+* fix exporting artboards when there is a space in the path to Sketch
+
+
 ## [0.9.2] - 2017-04-06
 
 * Added support for multiple file formats (png, jpg, pdf, eps, svg)
diff --git a/Git.sketchplugin/exportArtboard.sh b/Git.sketchplugin/exportArtboard.sh
@@ -1,4 +1,5 @@
 #!/bin/bash
+set -e -o pipefail
 
 DIR_PATH="$1"
 EXPORT_FOLDER="$2"
@@ -11,22 +12,22 @@ INCLUDE_OVERVIEW="$8"
 
 
 cd "$DIR_PATH"
-mkdir -p "$EXPORT_FOLDER"
+mkdir -p "$EXPORT_FOLDER" || true
 
 # move old artboards to temp directory to compare them with the new ones
-rm -rf .oldArtboards
-mv "$FILE_FOLDER" .oldArtboards 2>/dev/null
+rm -rf .oldArtboards || true
+mv "$FILE_FOLDER" .oldArtboards || true
 
 # get list of artboards regex to ignore
 IGNORE=$([ -e .sketchignore ] && (cat .sketchignore | sed '/^$/d' | sed 's/^/^/' | sed 's/$/$/' | tr '\n' ',') || echo "")
 
 # get list of artboard names to export
-ARTBOARDS=$($BUNDLE_PATH/Contents/Resources/sketchtool/bin/sketchtool list artboards "$FILENAME" --include-symbols=YES | python "$(dirname "$0")"/getArtboardNames.py "$IGNORE" | tr '\n' ',')
+ARTBOARDS=$("$BUNDLE_PATH"/Contents/Resources/sketchtool/bin/sketchtool list artboards "$FILENAME" --include-symbols=YES | python "$(dirname "$0")"/getArtboardNames.py "$IGNORE" | tr '\n' ',')
 
 
 # generate new artboards
 mkdir -p "$FILE_FOLDER"
-$BUNDLE_PATH/Contents/Resources/sketchtool/bin/sketchtool export artboards "$FILENAME" --formats="$FORMAT" --scales="$SCALE" --output="$FILE_FOLDER" --overwriting=YES --items="$ARTBOARDS" --include-symbols=YES
+"$BUNDLE_PATH"/Contents/Resources/sketchtool/bin/sketchtool export artboards "$FILENAME" --formats="$FORMAT" --scales="$SCALE" --output="$FILE_FOLDER" --overwriting=YES --items="$ARTBOARDS" --include-symbols=YES
 
 # Construct a ${FILENAME}-boards.md file which shows all the artboards in the sketch directory
 if [[ ${INCLUDE_OVERVIEW} == "true" ]]
diff --git a/example/example-boards.md b/example/example-boards.md
@@ -0,0 +1,13 @@
+# Artboards
+
+This is an autogenerated file showing all the artboards. Do not edit it directly.
+
+## Artboard 1@0.5x
+
+![Artboard 1@0.5x](./.exportedArtboards/example/Artboard 1@0.5x.png)
+
+
+## Rectangle@0.5x
+
+![Rectangle@0.5x](./.exportedArtboards/example/Rectangle@0.5x.png)
+
diff --git a/example/example.sketch b/example/example.sketch
diff --git a/package.json b/package.json
@@ -47,9 +47,10 @@
     "eslint-config-standard-preact": "1.0.1",
     "eslint-plugin-react": "6.10.3",
     "preact": "^7.1.0",
+    "sketch-module-fs": "0.1.2",
     "sketch-module-google-analytics": "^0.1.3",
     "sketch-module-update": "^0.1.2",
-    "sketch-module-user-preferences": "^0.2.3",
+    "sketch-module-user-preferences": "1.0.1",
     "sketch-module-web-view": "0.1.4"
   }
 }
diff --git a/src/analytics.js b/src/analytics.js
@@ -4,7 +4,7 @@ import { getUserPreferences } from './preferences'
 const key = 'UA-88206962-1'
 
 export function sendEvent (context, category, action, label, value) {
-  const { sendAnalytics } = getUserPreferences()
+  const { sendAnalytics } = getUserPreferences(context)
   if (!sendAnalytics) { return }
   const payload = {}
   if (category) { payload.ec = category }
@@ -16,7 +16,7 @@ export function sendEvent (context, category, action, label, value) {
 }
 
 export function sendError (context, error) {
-  const { sendAnalytics } = getUserPreferences()
+  const { sendAnalytics } = getUserPreferences(context)
   if (!sendAnalytics) { return }
   return send(context, key, 'event', {exd: error})
 }
diff --git a/src/commands/Commit.js b/src/commands/Commit.js
@@ -8,12 +8,13 @@ export default function (context) {
   executeSafely(context, function () {
     sendEvent(context, 'Commit', 'Start commiting')
     var currentBranch = getCurrentBranch(context)
-    var commitMsg = createInputWithCheckbox(context, 'Commit to "' + currentBranch + '"', 'Generate files for pretty diffs', getUserPreferences().diffByDefault, 'Commit')
+    const prefs = getUserPreferences(context)
+    var commitMsg = createInputWithCheckbox(context, 'Commit to "' + currentBranch + '"', 'Generate files for pretty diffs', prefs.diffByDefault, 'Commit')
 
     if (commitMsg.responseCode == 1000 && commitMsg.message != null) {
       if (commitMsg.checked) {
         sendEvent(context, 'Commit', 'Export artboards')
-        exportArtboards(context)
+        exportArtboards(context, prefs)
       }
       sendEvent(context, 'Commit', 'Do commit')
       var command = `git commit -m "${commitMsg.message.split('"').join('\\"')}" -a; exit`
diff --git a/src/commands/Export.js b/src/commands/Export.js
@@ -1,12 +1,13 @@
 // Export artboards for pretty diffs
 import { sendEvent } from '../analytics'
 import { checkForFile, executeSafely, exportArtboards } from '../common'
+import { getUserPreferences } from '../preferences'
 
 export default function (context) {
   if (!checkForFile(context)) { return }
   executeSafely(context, function () {
     sendEvent(context, 'Manual Export', 'Do export')
-    exportArtboards(context)
+    exportArtboards(context, getUserPreferences(context))
     context.document.showMessage('Artboards exported')
   })
 }
diff --git a/src/commands/OpenTerminal.js b/src/commands/OpenTerminal.js
@@ -6,6 +6,6 @@ import { getUserPreferences } from '../preferences'
 export default function (context) {
   sendEvent(context, 'Terminal', 'Open terminal')
   const path = getCurrentDirectory(context)
-  const {terminal} = getUserPreferences()
+  const {terminal} = getUserPreferences(context)
   NSWorkspace.sharedWorkspace().openFile_withApplication_(path, terminal)
 }
diff --git a/src/commands/Preferences.js b/src/commands/Preferences.js
@@ -5,7 +5,7 @@ import { executeSafely } from '../common'
 import { getUserPreferences, setUserPreferences } from '../preferences'
 
 export default function (context) {
-  const preferences = getUserPreferences()
+  const preferences = getUserPreferences(context)
   const webUI = new WebUI(context, 'preferences.html', {
     identifier: 'git-sketch-plugin.preferences',
     width: 340,
@@ -16,7 +16,7 @@ export default function (context) {
       savePreferences (prefs) {
         executeSafely(context, function () {
           sendEvent(context, 'Preferences', 'Save preferences')
-          setUserPreferences(prefs)
+          setUserPreferences(context, prefs)
           webUI.panel.close()
           WebUI.clean()
           context.document.showMessage('Preferences updated')
diff --git a/src/common.js b/src/common.js
@@ -1,6 +1,5 @@
 // Common library of things
 import { sendError } from './analytics'
-import { getUserPreferences } from './preferences'
 
 export function setIconForAlert (context, alert) {
   alert.setIcon(NSImage.alloc().initWithContentsOfFile(
@@ -34,9 +33,12 @@ export function exec (context, command) {
   const data = pipe.fileHandleForReading().readDataToEndOfFile()
 
   if (task.terminationStatus() != 0) {
-    const message = errData != null && errData.length()
-      ? NSString.alloc().initWithData_encoding_(errData, NSUTF8StringEncoding)
-      : 'Unknow error'
+    let message = 'Unknow error'
+    if (errData != null && errData.length()) {
+      message = NSString.alloc().initWithData_encoding_(errData, NSUTF8StringEncoding)
+    } else if (data != null && data.length()) {
+      message = NSString.alloc().initWithData_encoding_(data, NSUTF8StringEncoding)
+    }
     return NSException.raise_format_('failed', message)
   }
 
@@ -47,6 +49,10 @@ export function getCurrentDirectory (context) {
   return context.document.fileURL().URLByDeletingLastPathComponent().path()
 }
 
+export function getGitDirectory (context) {
+  return exec(context, 'git rev-parse --show-toplevel').trim().replace('(B[m', '')
+}
+
 export function getCurrentFileName (context) {
   return context.document.fileURL().lastPathComponent()
 }
@@ -65,11 +71,14 @@ export function createFailAlert (context, title, error, buttonToReport) {
   var responseCode = alert.runModal()
 
   if (responseCode == 1001) {
-    var errorString
-    try {
-      errorString = JSON.stringify(error, null, '\t')
-    } catch (e) {
-      errorString = error
+    var errorString = error
+    if (typeof error === 'object') {
+      try {
+        errorString = JSON.stringify(error, null, '\t')
+        if (errorString === '{}') {
+          errorString = error
+        }
+      } catch (e) {}
     }
     var urlString = `https://github.com/mathieudutour/git-sketch-plugin/issues/new?body=${encodeURIComponent('### How did it happen?\n1.\n2.\n3.\n\n\n### Error log\n\n```\n' + errorString + '\n```')}`
     var url = NSURL.URLWithString(urlString)
@@ -165,15 +174,15 @@ export function getCurrentBranch (context) {
   return branch
 }
 
-export function exportArtboards (context) {
+export function exportArtboards (context, prefs) {
   const currentFileName = getCurrentFileName(context)
   const path = getCurrentDirectory(context)
   const currentFileNameWithoutExtension = currentFileName.replace(/\.sketch$/, '')
-  const {exportFolder, exportFormat, exportScale, includeOverviewFile} = getUserPreferences()
+  const {exportFolder, exportFormat, exportScale, includeOverviewFile} = prefs
   const pluginPath = context.scriptPath.replace(/Contents\/Sketch\/(\w*)\.cocoascript$/, '').replace(/ /g, '\\ ')
+  const bundlePath = NSBundle.mainBundle().bundlePath()
   const fileFolder = exportFolder + '/' + currentFileNameWithoutExtension
-
-  const command = `${pluginPath}/exportArtboard.sh "${path}" "${exportFolder}" "${fileFolder}" "${NSBundle.mainBundle().bundlePath()}" "${currentFileName}" "${exportFormat || 'png'}" "${exportScale}" "${includeOverviewFile}"`
+  const command = `${pluginPath}/exportArtboard.sh "${path}" "${exportFolder}" "${fileFolder}" "${bundlePath}" "${currentFileName}" "${exportFormat || 'png'}" "${exportScale}" "${includeOverviewFile}"`
   return exec(context, command)
 }
 
diff --git a/src/preferences.js b/src/preferences.js
@@ -1,19 +1,54 @@
 import prefsManager from 'sketch-module-user-preferences'
+import fs from 'sketch-module-fs'
+import {exec, getGitDirectory} from './common'
 
 const keyPref = 'gitSketch'
+const PREFS_FILE = '.gitsketchrc'
+const LOCAL_PREFS = {
+  exportFolder: '.exportedArtboards',
+  exportFormat: 'png',
+  exportScale: '1.0',
+  includeOverviewFile: true
+}
+const GLOBAL_PREFS = {
+  terminal: 'Terminal',
+  diffByDefault: true,
+  sendAnalytics: true
+}
 
-export function getUserPreferences () {
-  return prefsManager.getUserPreferences(keyPref, {
-    exportFolder: '.exportedArtboards',
-    exportFormat: 'png',
-    exportScale: '1.0',
-    terminal: 'Terminal',
-    diffByDefault: true,
-    includeOverviewFile: true,
-    sendAnalytics: true
-  })
+export function getUserPreferences (context) {
+  let localPrefs = {}
+  try {
+    var path = getGitDirectory(context)
+    localPrefs = JSON.parse(fs.readFile(path + '/' + PREFS_FILE))
+  } catch (e) {
+    console.log(e)
+  }
+  return Object.assign(
+    {},
+    LOCAL_PREFS,
+    prefsManager.getUserPreferences(keyPref, GLOBAL_PREFS),
+    localPrefs
+  )
 }
 
-export function setUserPreferences (prefs) {
-  return prefsManager.setUserPreferences(keyPref, prefs)
+export function setUserPreferences (context, prefs) {
+  const localPrefs = {}
+  const globalPrefs = {}
+  Object.keys(prefs).forEach(k => {
+    if (Object.keys(LOCAL_PREFS).indexOf(k) !== -1) {
+      localPrefs[k] = prefs[k]
+    } else {
+      globalPrefs[k] = prefs[k]
+    }
+  })
+
+  try {
+    var path = getGitDirectory(context)
+    fs.writeFile(path + '/' + PREFS_FILE, JSON.stringify(localPrefs, null, '  '))
+    exec(context, 'git add "' + path + '/' + PREFS_FILE + '"')
+  } catch (e) {
+    console.log(e)
+  }
+  return prefsManager.setUserPreferences(keyPref, globalPrefs)
 }

Original file line number	Diff line number	Diff line change
`@@ -47,9 +47,10 @@`
`47`	`47`	`"eslint-config-standard-preact": "1.0.1",`
`48`	`48`	`"eslint-plugin-react": "6.10.3",`
`49`	`49`	`"preact": "^7.1.0",`
	`50`	`+ "sketch-module-fs": "0.1.2",`
`50`	`51`	`"sketch-module-google-analytics": "^0.1.3",`
`51`	`52`	`"sketch-module-update": "^0.1.2",`
`52`		`- "sketch-module-user-preferences": "^0.2.3",`
	`53`	`+ "sketch-module-user-preferences": "1.0.1",`
`53`	`54`	`"sketch-module-web-view": "0.1.4"`
`54`	`55`	`}`
`55`	`56`	`}`