Render and hide metadata

Depending on the user setting.

This fixes issue #37
#37

app/lib/documentRendering/documentRenderingMain.js

@@ -9,6 +9,7 @@ const ENABLE_TYPOGRAPHY_MENU_ID = "enable-typographic-replacements"
 const ENABLE_EMOJIS_MENU_ID = "enable-emojis"
 const RENDER_FILE_AS_MD_MENU_ID = "render-file-as-markdown"
 const RENDER_FILE_TYPE_AS_MD_MENU_ID = "render-file-type-as-markdown"
+const HIDE_METADATA_MENU_ID = "hide-metadata"
 
 const UPDATE_FILE_SPECIFICA_NAV_ID = "update-file-specific-document-rendering"
 
@@ -41,6 +42,7 @@ function notifyOptionChanges(filePath) {
         typographyEnabled: _applicationSettings.typographyEnabled,
         emojisEnabled: _applicationSettings.emojisEnabled,
         renderAsMarkdown: documentSettings.renderAsMarkdown || isMarkdownFileType(filePath),
+        hideMetadata: _applicationSettings.hideMetadata,
     })
 }
 
@@ -68,6 +70,8 @@ exports.RENDER_FILE_AS_MD_MENU_ID = RENDER_FILE_AS_MD_MENU_ID
 
 exports.RENDER_FILE_TYPE_AS_MD_MENU_ID = RENDER_FILE_TYPE_AS_MD_MENU_ID
 
+exports.HIDE_METADATA_MENU_ID = HIDE_METADATA_MENU_ID
+
 exports.init = (mainMenu, applicationSettings, filePath) => {
     _mainMenu = mainMenu
     _applicationSettings = applicationSettings
@@ -130,3 +134,9 @@ exports.switchRenderFileTypeAsMarkdown = filePath =>
             menu.getChecked(_mainMenu, RENDER_FILE_TYPE_AS_MD_MENU_ID),
         ),
     )
+
+exports.hideMetadata = () =>
+    changeOption(
+        () =>
+            (_applicationSettings.hideMetadata = menu.getChecked(_mainMenu, HIDE_METADATA_MENU_ID)),
+    )

app/lib/documentRendering/documentRenderingRenderer.js

@@ -1,10 +1,12 @@
 const hljs = require("highlight.js")
 
+const metadata = require("../renderer/metadata")
 const toc = require("../toc/tocRenderer")
 
 let _markdown
 
 let _shallRenderAsMarkdown = false
+let _shallHideMetadata = false
 
 function generateCodeText(text, options = {}) {
     options = {
@@ -79,8 +81,10 @@ exports.reset = options => {
     }
 
     _shallRenderAsMarkdown = options.renderAsMarkdown
+    _shallHideMetadata = options.hideMetadata
 }
 
-exports.renderContent = content => _markdown.render(content)
+exports.renderContent = content =>
+    _markdown.render(_shallHideMetadata ? metadata.hide(content) : metadata.render(content))
 
 exports.shallRenderAsMarkdown = () => _shallRenderAsMarkdown

app/lib/main/storage.js

@@ -53,6 +53,7 @@ class ApplicationSettings extends StorageBase {
     #MD_FILE_TYPES_KEY = "md-file-types"
     #SHOW_TOC_KEY = "show-toc"
     #TOC_WIDTH_KEY = "toc-width"
+    #HIDE_METADATA_KEY = "hide-metadata"
 
     SYSTEM_THEME = common.SYSTEM_THEME
     LIGHT_THEME = common.LIGHT_THEME
@@ -68,6 +69,8 @@ class ApplicationSettings extends StorageBase {
     SHOW_TOC_DEFAULT = false
     TOC_WIDTH_DEFAULT = null
 
+    HIDE_METADATA_DEFAULT = false
+
     get theme() {
         return this._loadValue(this.#THEME_KEY, electron.nativeTheme.themeSource)
     }
@@ -138,6 +141,14 @@ class ApplicationSettings extends StorageBase {
         this._storeValue(this.#TOC_WIDTH_KEY, value)
     }
 
+    get hideMetadata() {
+        return this._loadValue(this.#HIDE_METADATA_KEY, this.HIDE_METADATA_DEFAULT)
+    }
+
+    set hideMetadata(value) {
+        this._storeValue(this.#HIDE_METADATA_KEY, value)
+    }
+
     _loadValue(key, defaultValue) {
         return this._data[key] ?? defaultValue
     }

app/lib/renderer/metadata.js

@@ -0,0 +1,24 @@
+exports.render = content => {
+    const lines = content.split("\n")
+    if (lines.length === 0 || lines[0].trim() !== "---") {
+        return content
+    }
+    lines[0] = "**Metadata**<br>\n```yaml"
+
+    const metadataEndIndex = lines.slice(1).findIndex(line => ["---", "..."].includes(line.trim()))
+    if (metadataEndIndex < 0) {
+        return content
+    }
+    lines[metadataEndIndex + 1] = "```"
+
+    return lines.join("\n")
+}
+
+exports.hide = content => {
+    const lines = content.split("\n")
+    if (lines.length === 0 || lines[0].trim() !== "---") {
+        return content
+    }
+    const metadataEndIndex = lines.slice(1).findIndex(line => ["---", "..."].includes(line.trim()))
+    return metadataEndIndex >= 0 ? lines.slice(metadataEndIndex + 2).join("\n") : content
+}

app/lib/toc/tocRenderer.js

@@ -1,5 +1,6 @@
 const common = require("../common")
 const ipc = require("../ipc/ipcRenderer")
+const metadata = require("../renderer/metadata")
 
 const shared = require("./tocShared")
 
@@ -286,7 +287,8 @@ exports.reset = reset
 exports.addHeader = (title, id) => _headers.push({ title, id })
 
 exports.build = content => {
-    const lines = content
+    const lines = metadata
+        .hide(content)
         .split(/\r?\n/)
         .map(line => line.trim())
         .filter(line => Boolean(line))

app/main.js

@@ -402,6 +402,14 @@ function createMainMenu() {
                                 documentRendering.switchEnableEmojis()
                             },
                         },
+                        {
+                            label: "Hide &Metatdata Header",
+                            type: "checkbox",
+                            id: documentRendering.HIDE_METADATA_MENU_ID,
+                            click() {
+                                documentRendering.hideMetadata()
+                            },
+                        },
                     ],
                 },
                 { type: "separator" },

test/documents/metadata.md

@@ -0,0 +1,28 @@
+---
+# Just a random workflow to have a valid YAML
+
+name: Test
+
+on:
+  workflow_dispatch:
+  push:
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@master
+        with:
+          node-version: latest
+      - name: Install dependencies
+        run: npm install
+      - name: Test
+        run: npm run test-ci
+---
+
+# A file with metadata
+
+This file has a metadata header.