add YAML front matter when exporting

browser/main/lib/dataApi/attachmentManagement.js

@@ -386,6 +386,17 @@ function removeStorageAndNoteReferences (input, noteKey) {
   return input.replace(new RegExp(mdurl.encode(path.sep), 'g'), path.sep).replace(new RegExp(STORAGE_FOLDER_PLACEHOLDER + '(' + escapeStringRegexp(path.sep) + noteKey + ')?', 'g'), DESTINATION_FOLDER)
 }
 
+/**
+ * @description replace all :storage references with given destination folder.
+ * @param input Input in which the references should be deleted
+ * @param noteKey Key of the current note
+ * @param destinationFolder Destination folder of the attachements
+ * @returns {String} Input without the references
+ */
+function replaceStorageReferences (input, noteKey, destinationFolder) {
+  return input.replace(new RegExp(STORAGE_FOLDER_PLACEHOLDER + '(' + escapeStringRegexp(path.sep) + noteKey + ')?', 'g'), destinationFolder || DESTINATION_FOLDER)
+}
+
 /**
  * @description Deletes the attachment folder specified by the given storageKey and noteKey
  * @param storageKey Key of the storage of the note to be deleted
@@ -542,6 +553,7 @@ module.exports = {
   getAttachmentsInMarkdownContent,
   getAbsolutePathsOfAttachmentsInContent,
   removeStorageAndNoteReferences,
+  replaceStorageReferences,
   deleteAttachmentFolder,
   deleteAttachmentsNotPresentInNote,
   moveAttachments,

browser/main/lib/dataApi/exportFolder.js

@@ -2,14 +2,17 @@ import { findStorage } from 'browser/lib/findStorage'
 import resolveStorageData from './resolveStorageData'
 import resolveStorageNotes from './resolveStorageNotes'
 import filenamify from 'filenamify'
-import * as path from 'path'
-import * as fs from 'fs'
+import path from 'path'
+import exportNote from './exportNote'
+import formatMarkdown from './formatMarkdown'
+import formatHTML from './formatHTML'
 
 /**
  * @param {String} storageKey
  * @param {String} folderKey
  * @param {String} fileType
  * @param {String} exportDir
+ * @param {Object} config
  *
  * @return {Object}
  * ```
@@ -22,7 +25,7 @@ import * as fs from 'fs'
  * ```
  */
 
-function exportFolder (storageKey, folderKey, fileType, exportDir) {
+function exportFolder (storageKey, folderKey, fileType, exportDir, config) {
   let targetStorage
   try {
     targetStorage = findStorage(storageKey)
@@ -31,31 +34,50 @@ function exportFolder (storageKey, folderKey, fileType, exportDir) {
   }
 
   return resolveStorageData(targetStorage)
-    .then(function assignNotes (storage) {
-      return resolveStorageNotes(storage)
-        .then((notes) => {
-          return {
-            storage,
-            notes
-          }
-        })
-    })
-    .then(function exportNotes (data) {
-      const { storage, notes } = data
-
-      notes
-        .filter(note => note.folder === folderKey && note.isTrashed === false && note.type === 'MARKDOWN_NOTE')
-        .forEach(snippet => {
-          const notePath = path.join(exportDir, `${filenamify(snippet.title, {replacement: '_'})}.${fileType}`)
-          fs.writeFileSync(notePath, snippet.content)
-        })
-
-      return {
+    .then(storage => {
+      return resolveStorageNotes(storage).then(notes => ({
         storage,
-        folderKey,
-        fileType,
-        exportDir
+        notes: notes.filter(note => note.folder === folderKey && !note.isTrashed && note.type === 'MARKDOWN_NOTE')
+      }))
+    })
+    .then(({ storage, notes }) => {
+      let contentFormatter = null
+      if (fileType === 'md') {
+        contentFormatter = formatMarkdown({
+          storagePath: storage.path,
+          export: config.export
+        })
+      } else if (fileType === 'html') {
+        contentFormatter = formatHTML({
+          theme: config.ui.theme,
+          fontSize: config.preview.fontSize,
+          fontFamily: config.preview.fontFamily,
+          codeBlockTheme: config.preview.codeBlockTheme,
+          codeBlockFontFamily: config.editor.fontFamily,
+          lineNumber: config.preview.lineNumber,
+          scrollPastEnd: config.preview.scrollPastEnd,
+          smartQuotes: config.preview.smartQuotes,
+          breaks: config.preview.breaks,
+          sanitize: config.preview.sanitize,
+          customCSS: config.preview.customCSS,
+          allowCustomCSS: config.preview.allowCustomCSS,
+          storagePath: storage.path,
+          export: config.export
+        })
       }
+
+      return Promise
+        .all(notes.map(note => {
+          const targetPath = path.join(exportDir, `${filenamify(note.title, {replacement: '_'})}.${fileType}`)
+
+          return exportNote(storage.key, note, targetPath, contentFormatter)
+        }))
+        .then(() => ({
+          storage,
+          folderKey,
+          fileType,
+          exportDir
+        }))
     })
 }
 

browser/main/lib/dataApi/exportNote.js

@@ -16,7 +16,7 @@ const path = require('path')
  * @param {function} outputFormatter
  * @return {Promise.<*[]>}
  */
-function exportNote (storageKey, noteContent, targetPath, outputFormatter) {
+function exportNote (storageKey, note, targetPath, outputFormatter) {
   const storagePath = path.isAbsolute(storageKey) ? storageKey : findStorage(storageKey).path
   const exportTasks = []
 
@@ -24,20 +24,18 @@ function exportNote (storageKey, noteContent, targetPath, outputFormatter) {
     throw new Error('Storage path is not found')
   }
 
-  let exportedData = noteContent
-
-  if (outputFormatter) {
-    exportedData = outputFormatter(exportedData, exportTasks)
-  }
+  const exportedData = outputFormatter ? outputFormatter(note, targetPath, exportTasks) : note.content
 
   const tasks = prepareTasks(exportTasks, storagePath, path.dirname(targetPath))
 
-  return Promise.all(tasks.map((task) => copyFile(task.src, task.dst)))
+  return Promise
+  .all(tasks.map(task => copyFile(task.src, task.dst)))
   .then(() => {
     return saveToFile(exportedData, targetPath)
-  }).catch((err) => {
+  })
+  .catch(error => {
     rollbackExport(tasks)
-    throw err
+    throw error
   })
 }
 
@@ -57,10 +55,12 @@ function prepareTasks (tasks, storagePath, targetPath) {
 
 function saveToFile (data, filename) {
   return new Promise((resolve, reject) => {
-    fs.writeFile(filename, data, (err) => {
-      if (err) return reject(err)
-
-      resolve(filename)
+    fs.writeFile(filename, data, error => {
+      if (error) {
+        reject(error)
+      } else {
+        resolve(filename)
+      }
     })
   })
 }

browser/main/lib/dataApi/exportStorage.js

@@ -2,13 +2,17 @@ import { findStorage } from 'browser/lib/findStorage'
 import resolveStorageData from './resolveStorageData'
 import resolveStorageNotes from './resolveStorageNotes'
 import filenamify from 'filenamify'
-import * as path from 'path'
-import * as fs from 'fs'
+import path from 'path'
+import fs from 'fs'
+import exportNote from './exportNote'
+import formatMarkdown from './formatMarkdown'
+import formatHTML from './formatHTML'
 
 /**
  * @param {String} storageKey
  * @param {String} fileType
  * @param {String} exportDir
+ * @param {Object} config
  *
  * @return {Object}
  * ```
@@ -20,7 +24,7 @@ import * as fs from 'fs'
  * ```
  */
 
-function exportStorage (storageKey, fileType, exportDir) {
+function exportStorage (storageKey, fileType, exportDir, config) {
   let targetStorage
   try {
     targetStorage = findStorage(storageKey)
@@ -29,34 +33,61 @@ function exportStorage (storageKey, fileType, exportDir) {
   }
 
   return resolveStorageData(targetStorage)
-    .then(storage => (
-      resolveStorageNotes(storage).then(notes => ({storage, notes}))
-    ))
-    .then(function exportNotes (data) {
-      const { storage, notes } = data
+    .then(storage => {
+      return resolveStorageNotes(storage).then(notes => ({
+        storage,
+        notes: notes.filter(note => !note.isTrashed && note.type === 'MARKDOWN_NOTE')
+      }))
+    })
+    .then(({ storage, notes }) => {
+      let contentFormatter = null
+      if (fileType === 'md') {
+        contentFormatter = formatMarkdown({
+          storagePath: storage.path,
+          export: config.export
+        })
+      } else if (fileType === 'html') {
+        contentFormatter = formatHTML({
+          theme: config.ui.theme,
+          fontSize: config.preview.fontSize,
+          fontFamily: config.preview.fontFamily,
+          codeBlockTheme: config.preview.codeBlockTheme,
+          codeBlockFontFamily: config.editor.fontFamily,
+          lineNumber: config.preview.lineNumber,
+          scrollPastEnd: config.preview.scrollPastEnd,
+          smartQuotes: config.preview.smartQuotes,
+          breaks: config.preview.breaks,
+          sanitize: config.preview.sanitize,
+          customCSS: config.preview.customCSS,
+          allowCustomCSS: config.preview.allowCustomCSS,
+          storagePath: storage.path,
+          export: config.export
+        })
+      }
+
       const folderNamesMapping = {}
       storage.folders.forEach(folder => {
         const folderExportedDir = path.join(exportDir, filenamify(folder.name, {replacement: '_'}))
+
         folderNamesMapping[folder.key] = folderExportedDir
+
         // make sure directory exists
         try {
           fs.mkdirSync(folderExportedDir)
         } catch (e) {}
       })
-      notes
-        .filter(note => !note.isTrashed && note.type === 'MARKDOWN_NOTE')
-        .forEach(markdownNote => {
-          const folderExportedDir = folderNamesMapping[markdownNote.folder]
-          const snippetName = `${filenamify(markdownNote.title, {replacement: '_'})}.${fileType}`
-          const notePath = path.join(folderExportedDir, snippetName)
-          fs.writeFileSync(notePath, markdownNote.content)
-        })
 
-      return {
-        storage,
-        fileType,
-        exportDir
-      }
+      return Promise
+        .all(notes.map(note => {
+          const targetPath = path.join(folderNamesMapping[note.folder], `${filenamify(note.title, {replacement: '_'})}.${fileType}`)
+
+          return exportNote(storage.key, note, targetPath, contentFormatter)
+        }))
+        .then(() => ({
+          storage,
+          fileType,
+          exportDir
+        }))
     })
 }
 

browser/main/lib/dataApi/formatHTML.js

@@ -0,0 +1,295 @@
+import path from 'path'
+import fileUrl from 'file-url'
+import { remote } from 'electron'
+import consts from 'browser/lib/consts'
+import Markdown from 'browser/lib/markdown'
+import attachmentManagement from './attachmentManagement'
+
+const { app } = remote
+const appPath = fileUrl(process.env.NODE_ENV === 'production' ? app.getAppPath() : path.resolve())
+
+let markdownStyle = ''
+try {
+  markdownStyle = require('!!css!stylus?sourceMap!../../../components/markdown.styl')[0][1]
+} catch (e) {}
+
+export const CSS_FILES = [
+  `${appPath}/node_modules/katex/dist/katex.min.css`,
+  `${appPath}/node_modules/codemirror/lib/codemirror.css`
+]
+
+const defaultFontFamily = ['helvetica', 'arial', 'sans-serif']
+if (global.process.platform !== 'darwin') {
+  defaultFontFamily.unshift('Microsoft YaHei')
+  defaultFontFamily.unshift('meiryo')
+}
+
+const defaultCodeBlockFontFamily = [
+  'Monaco',
+  'Menlo',
+  'Ubuntu Mono',
+  'Consolas',
+  'source-code-pro',
+  'monospace'
+]
+
+/**
+ * ```
+ * {
+ *   fontFamily,
+ *   fontSize,
+ *   lineNumber,
+ *   codeBlockFontFamily,
+ *   codeBlockTheme,
+ *   scrollPastEnd,
+ *   theme,
+ *   allowCustomCSS,
+ *   customCSS
+ *   smartQuotes,
+ *   sanitize,
+ *   breaks,
+ *   storagePath,
+ *   export
+ * }
+ * ```
+ */
+export default function formatHTML (props) {
+  const {
+    fontFamily,
+    fontSize,
+    codeBlockFontFamily,
+    lineNumber,
+    codeBlockTheme,
+    scrollPastEnd,
+    theme,
+    allowCustomCSS,
+    customCSS
+  } = getStyleParams(props)
+
+  const inlineStyles = buildStyle(
+    fontFamily,
+    fontSize,
+    codeBlockFontFamily,
+    lineNumber,
+    scrollPastEnd,
+    theme,
+    allowCustomCSS,
+    customCSS
+  )
+  const { smartQuotes, sanitize, breaks } = props
+
+  const markdown = new Markdown({
+    typographer: smartQuotes,
+    sanitize,
+    breaks
+  })
+
+  const files = [getCodeThemeLink(codeBlockTheme), ...CSS_FILES]
+
+  return function (note, targetPath, exportTasks) {
+    let body = markdown.render(note.content)
+
+    const attachmentsAbsolutePaths = attachmentManagement.getAbsolutePathsOfAttachmentsInContent(note.content, props.storagePath)
+
+    files.forEach(file => {
+      if (global.process.platform === 'win32') {
+        file = file.replace('file:///', '')
+      } else {
+        file = file.replace('file://', '')
+      }
+      exportTasks.push({
+        src: file,
+        dst: 'css'
+      })
+    })
+
+    const destinationFolder = props.export.prefixAttachmentFolder ? `${path.parse(targetPath).name} - ${attachmentManagement.DESTINATION_FOLDER}` : attachmentManagement.DESTINATION_FOLDER
+
+    attachmentsAbsolutePaths.forEach(attachment => {
+      exportTasks.push({
+        src: attachment,
+        dst: destinationFolder
+      })
+    })
+
+    body = attachmentManagement.replaceStorageReferences(body, note.key, destinationFolder)
+
+    let styles = ''
+    files.forEach(file => {
+      styles += `<link rel="stylesheet" href="css/${path.basename(file)}">`
+    })
+
+    return `<html>
+                <head>
+                  <meta charset="UTF-8">
+                  <meta name = "viewport" content = "width = device-width, initial-scale = 1, maximum-scale = 1">
+                  <style id="style">${inlineStyles}</style>
+                  ${styles}
+                </head>
+                <body>${body}</body>
+            </html>`
+  }
+}
+
+export function getStyleParams (props) {
+  const {
+    fontSize,
+    lineNumber,
+    codeBlockTheme,
+    scrollPastEnd,
+    theme,
+    allowCustomCSS,
+    customCSS
+  } = props
+
+  let { fontFamily, codeBlockFontFamily } = props
+
+  fontFamily = _.isString(fontFamily) && fontFamily.trim().length > 0
+    ? fontFamily
+        .split(',')
+        .map(fontName => fontName.trim())
+        .concat(defaultFontFamily)
+    : defaultFontFamily
+
+  codeBlockFontFamily = _.isString(codeBlockFontFamily) &&
+    codeBlockFontFamily.trim().length > 0
+    ? codeBlockFontFamily
+        .split(',')
+        .map(fontName => fontName.trim())
+        .concat(defaultCodeBlockFontFamily)
+    : defaultCodeBlockFontFamily
+
+  return {
+    fontFamily,
+    fontSize,
+    codeBlockFontFamily,
+    lineNumber,
+    codeBlockTheme,
+    scrollPastEnd,
+    theme,
+    allowCustomCSS,
+    customCSS
+  }
+}
+
+export function getCodeThemeLink (theme) {
+  if (consts.THEMES.some(_theme => _theme === theme)) {
+    theme = theme !== 'default' ? theme : 'elegant'
+  }
+
+  return theme.startsWith('solarized')
+    ? `${appPath}/node_modules/codemirror/theme/solarized.css`
+    : `${appPath}/node_modules/codemirror/theme/${theme}.css`
+}
+
+export function buildStyle (
+  fontFamily,
+  fontSize,
+  codeBlockFontFamily,
+  lineNumber,
+  scrollPastEnd,
+  theme,
+  allowCustomCSS,
+  customCSS
+) {
+  return `
+@font-face {
+  font-family: 'Lato';
+  src: url('${appPath}/resources/fonts/Lato-Regular.woff2') format('woff2'), /* Modern Browsers */
+       url('${appPath}/resources/fonts/Lato-Regular.woff') format('woff'), /* Modern Browsers */
+       url('${appPath}/resources/fonts/Lato-Regular.ttf') format('truetype');
+  font-style: normal;
+  font-weight: normal;
+  text-rendering: optimizeLegibility;
+}
+@font-face {
+  font-family: 'Lato';
+  src: url('${appPath}/resources/fonts/Lato-Black.woff2') format('woff2'), /* Modern Browsers */
+       url('${appPath}/resources/fonts/Lato-Black.woff') format('woff'), /* Modern Browsers */
+       url('${appPath}/resources/fonts/Lato-Black.ttf') format('truetype');
+  font-style: normal;
+  font-weight: 700;
+  text-rendering: optimizeLegibility;
+}
+@font-face {
+  font-family: 'Material Icons';
+  font-style: normal;
+  font-weight: 400;
+  src: local('Material Icons'),
+       local('MaterialIcons-Regular'),
+       url('${appPath}/resources/fonts/MaterialIcons-Regular.woff2') format('woff2'),
+       url('${appPath}/resources/fonts/MaterialIcons-Regular.woff') format('woff'),
+       url('${appPath}/resources/fonts/MaterialIcons-Regular.ttf') format('truetype');
+}
+${markdownStyle}
+
+body {
+  font-family: '${fontFamily.join("','")}';
+  font-size: ${fontSize}px;
+  ${scrollPastEnd && 'padding-bottom: 90vh;'}
+}
+@media print {
+  body {
+    padding-bottom: initial;
+  }
+}
+code {
+  font-family: '${codeBlockFontFamily.join("','")}';
+  background-color: rgba(0,0,0,0.04);
+}
+.lineNumber {
+  ${lineNumber && 'display: block !important;'}
+  font-family: '${codeBlockFontFamily.join("','")}';
+}
+
+.clipboardButton {
+  color: rgba(147,147,149,0.8);;
+  fill: rgba(147,147,149,1);;
+  border-radius: 50%;
+  margin: 0px 10px;
+  border: none;
+  background-color: transparent;
+  outline: none;
+  height: 15px;
+  width: 15px;
+  cursor: pointer;
+}
+
+.clipboardButton:hover {
+  transition: 0.2s;
+  color: #939395;
+  fill: #939395;
+  background-color: rgba(0,0,0,0.1);
+}
+
+h1, h2 {
+  border: none;
+}
+
+h1 {
+  padding-bottom: 4px;
+  margin: 1em 0 8px;
+}
+
+h2 {
+  padding-bottom: 0.2em;
+  margin: 1em 0 0.37em;
+}
+
+body p {
+  white-space: normal;
+}
+
+@media print {
+  body[data-theme="${theme}"] {
+    color: #000;
+    background-color: #fff;
+  }
+  .clipboardButton {
+    display: none
+  }
+}
+
+${allowCustomCSS ? customCSS : ''}
+`
+}

browser/main/lib/dataApi/formatMarkdown.js

@@ -0,0 +1,94 @@
+import attachmentManagement from './attachmentManagement'
+import yaml from 'js-yaml'
+import path from 'path'
+
+const delimiterRegExp = /^\-{3}/
+
+/**
+ * ```
+ * {
+ *   storagePath,
+ *   export
+ * }
+ * ```
+ */
+export default function formatMarkdown (props) {
+  return function (note, targetPath, exportTasks) {
+    let result = note.content
+
+    if (props.storagePath && note.key) {
+      const attachmentsAbsolutePaths = attachmentManagement.getAbsolutePathsOfAttachmentsInContent(result, props.storagePath)
+
+      const destinationFolder = props.export.prefixAttachmentFolder ? `${path.parse(targetPath).name} - ${attachmentManagement.DESTINATION_FOLDER}` : attachmentManagement.DESTINATION_FOLDER
+
+      attachmentsAbsolutePaths.forEach(attachment => {
+        exportTasks.push({
+          src: attachment,
+          dst: destinationFolder
+        })
+      })
+
+      result = attachmentManagement.replaceStorageReferences(result, note.key, destinationFolder)
+    }
+
+    if (props.export.metadata === 'MERGE_HEADER') {
+      const metadata = getFrontMatter(result)
+
+      const values = Object.assign({}, note)
+      delete values.content
+      delete values.isTrashed
+
+      for (const key in values) {
+        metadata[key] = values[key]
+      }
+
+      result = replaceFrontMatter(result, metadata)
+    } else if (props.export.metadata === 'MERGE_VARIABLE') {
+      const metadata = getFrontMatter(result)
+
+      const values = Object.assign({}, note)
+      delete values.content
+      delete values.isTrashed
+
+      if (props.export.variable) {
+        metadata[props.export.variable] = values
+      } else {
+        for (const key in values) {
+          metadata[key] = values[key]
+        }
+      }
+
+      result = replaceFrontMatter(result, metadata)
+    }
+
+    return result
+  }
+}
+
+function getFrontMatter (markdown) {
+  const lines = markdown.split('\n')
+
+  if (delimiterRegExp.test(lines[0])) {
+    let line = 0
+    while (++line < lines.length && delimiterRegExp.test(lines[line])) {
+    }
+
+    return yaml.load(lines.slice(1, line).join('\n')) || {}
+  } else {
+    return {}
+  }
+}
+
+function replaceFrontMatter (markdown, metadata) {
+  const lines = markdown.split('\n')
+
+  if (lines[0] === '---') {
+    let line = 0
+    while (++line < lines.length && lines[line] !== '---') {
+    }
+
+    return `---\n${yaml.dump(metadata)}---\n${lines.slice(line + 1).join('\n')}`
+  } else {
+    return `---\n${yaml.dump(metadata)}---\n\n${markdown}`
+  }
+}

browser/main/lib/dataApi/moveNote.js

@@ -1,7 +1,6 @@
 const resolveStorageData = require('./resolveStorageData')
 const _ = require('lodash')
 const path = require('path')
-const fs = require('fs')
 const CSON = require('@rokt33r/season')
 const keygen = require('browser/lib/keygen')
 const sander = require('sander')