feat: adding tags to global regexp (#649)

Author: akosbalasko

README.md

@@ -213,7 +213,7 @@ The following configurational properties are available:
 | ```sanitizeResourceNameSpaces``` | true or false | Replace spaces in resource names with the `replacementChar`. e.g "linked file.jpg" will be converted to "linked_file.jpg"
 | ```replacementChar``` | string | the replacement character. e.g "linked*file.jpg" will be converted to "linked_file.jpg". It defaults to "_"
 | ```replacementCharacterMap``` | JSON Object | it contains character key-value pairs, the keys will be replaced by the proper values in the filename 
-| ```globalReplacementSettings``` | JSON Array | it contains search and replace pairs, the keys will be replaced by the proper values according to the given type (title or content). Please note: this property has to be in valid JSON Array format, and each item has to have <b>type</b> ('title' or 'content'), <b>regex</b> (what you want to replace as a valid regular expression) and <b>replace</b> (what you want to push instead of the matched text) properties)
+| ```globalReplacementSettings``` | JSON Array | it contains search and replace pairs, the keys will be replaced by the proper values according to the given type (title or content). Please note: this property has to be in valid JSON Array format, and each item has to have <b>type</b> ('title', 'content' or 'tag'), <b>regex</b> (what you want to replace as a valid regular expression) and <b>replace</b> (what you want to push instead of the matched text) properties)
 | ```keepOriginalAmountOfNewlines``` | true or false | keep the original amount of newlines, default is false, when the multiple newlines are collapsed to one.
 | ```generateNakedUrls``` | true or false | if it's true, Yarle generates 'naked' external Urls without any extra characters. If its false, external Urls are wrapped by  '<' and '>' characters
 | ```addExtensionToInternalLinks``` | true or false | adds '.md' extensions at the end of internal file links, to make them recognizable by DevonThink and other tools

config.json

@@ -59,6 +59,11 @@
         "type": "content",
         "regex": "",
         "replace": ""
+        },
+        {
+        "type": "tag",
+        "regex": "",
+        "replace": ""
         }
     ],
     "logseqSettings": {

config.logseq.json

@@ -43,6 +43,11 @@
         "type": "content",
         "regex": "",
         "replace": ""
+        },
+        {
+        "type": "tag",
+        "regex": "",
+        "replace": ""
         }
     ],
     "pathSeparator": "/",

config.tana.json

@@ -58,6 +58,11 @@
         "type": "content",
         "regex": "",
         "replace": ""
+        },
+        {
+        "type": "tag",
+        "regex": "",
+        "replace": ""
         }
     ],
     "generateNakedUrls": true,

src/models/ReplaceType.ts

@@ -1,4 +1,5 @@
 export enum ReplaceType {
     title = 'title',
-    content = 'content'
+    content = 'content',
+    tag = 'tag'
 }

src/ui/index.html

@@ -536,9 +536,9 @@ <h5 class="info-text">Attachments</h5>
 											</div>
 											<div class="form-group">
 												<label for="globalReplacementSettings">
-													Global search and replace (regexp) in note title and content
+													Global search and replace (regexp) in note title, content and tags
 													<br><div style='font-size: 12px;'><i>(
-													Please provide settings in valid JSON Array format, each item has to have <b>type</b> ('title' or 'content'), <b>regex</b> (what you want to replace as a valid regular expression) and <b>replace</b> (what you want to push instead of the matched text) properties)</i></div> 
+													Please provide settings in valid JSON Array format, each item has to have <b>type</b> ('title', 'content' or 'tag'), <b>regex</b> (what you want to replace as a valid regular expression) and <b>replace</b> (what you want to push instead of the matched text) properties)</i></div> 
 												</label>
 												<textarea class="form-control configurationItem" name="globalReplacementSettings" id="globalReplacementSettings" rows="15"></textarea>
 

src/ui/renderer.js

@@ -177,7 +177,7 @@ const updateDomAndConfig = (configItem, disable) => {
     if (domItem.getAttribute('type') === 'checkbox'){
       document.getElementById(configItem.name).checked = configItem.value;
     } else {
-      if (isObject(itemValueToStore)){
+      if (isObject(itemValueToStore) || Array.isArray(itemValueToStore)){
         itemValueToStore =  JSON.stringify(configItem.value)
         document.getElementById(configItem.name).value = JSON.stringify(configItem.value, undefined, 2);;
       }

src/utils/content-utils.ts

@@ -7,6 +7,7 @@ import { EvernoteNoteData, NoteData } from './../models';
 import { getHtmlFileLink } from './folder-utils';
 import { escapeStringRegexp } from './escape-string-regexp';
 import { OutputFormat } from './../output-format';
+import { performRegexpOnTag } from './get-title';
 
 export const getMetadata = (note: EvernoteNoteData, notebookName: string): MetaData => {
 
@@ -97,10 +98,13 @@ export const logTags = (note: EvernoteNoteData): string => {
       let cleanTag = tag
         .toString()
         .replace(/^#/, '');
+        
+      cleanTag = performRegexpOnTag(yarleOptions, cleanTag)
       if (tagOptions) {
         cleanTag = cleanTag.replace(new RegExp(escapeStringRegexp(tagOptions.separatorInEN), 'g'), tagOptions.replaceSeparatorWith);
       }
 
+
       const replaceSpaceWith = (tagOptions && tagOptions.replaceSpaceWith) || '-';
 
       cleanTag = cleanTag.replace(/ /g, replaceSpaceWith);

src/utils/get-title.ts

@@ -25,4 +25,8 @@ export const performRegexpOnTitle = (options: YarleOptions, title: string): stri
 
 export const performRegexpOnContent = (options: YarleOptions, content: string): string => {
     return regexpProcess(options, content, ReplaceType.content);
+}
+
+export const performRegexpOnTag = (options: YarleOptions, tag: string): string => {
+    return regexpProcess(options, tag, ReplaceType.tag)
 }

test/data/test-noteWithNestedTagsWithGlobalRegex.enex

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE en-export SYSTEM "http://xml.evernote.com/pub/evernote-export3.dtd">
+<en-export export-date="20181006T112423Z" application="Evernote" version="Evernote Mac 7.5 (457109)">
+<note><title>test -note with text only</title><content><![CDATA[<!DOCTYPE en-note SYSTEM "http://xml.evernote.com/pub/enml2.dtd"><en-note><div>This is the content</div></en-note>]]></content><created>20181006T084349Z</created><updated>20181006T084411Z</updated><tag>tag1_nestedTag1</tag><tag>tag2_nestedTag2</tag><note-attributes><author>akos</author><source>desktop.mac</source><reminder-order>0</reminder-order></note-attributes></note>
+</en-export>

test/data/test-noteWithNestedTagsWithGlobalRegex.md

@@ -0,0 +1,12 @@
+# test -note with text only
+
+---
+Tag(s): #tag1/nestedTag1 #tag2/nestedTag2
+
+---
+
+This is the content
+
+    Created at: 2018-10-06T09:43:49+01:00
+    Updated at: 2018-10-06T09:44:11+01:00
+

test/yarle-tests.ts

@@ -2,6 +2,7 @@ import { YarleTest } from './yarle-test';
 import { OutputFormat } from "../src/output-format";
 import * as path from 'path';
 import { YarleTestModifierOptions } from './yarle-test-modifier-options';
+import { ReplaceType } from '../src/models';
 
 const dataFolder = `${path.sep}data${path.sep}`;
 const testDataFolder = `${path.sep}test${dataFolder}`;
@@ -95,6 +96,24 @@ export const yarleTests: Array<YarleTest> = [
 
     expectedOutputPath: `${dataFolder}test-noteWithNestedTags.md`,
   },
+  {
+    name: 'Note with nested tags with global regexp',
+    options: {
+      enexSources: [ `.${testDataFolder}test-noteWithNestedTagsWithGlobalRegex.enex` ],
+      outputDir: 'out',
+      isMetadataNeeded: true,
+      globalReplacementSettings: [
+        {
+        type: ReplaceType.tag,
+        regex: "_+",
+        replace: "/"
+        }
+    ],
+      useHashTags: true
+    },
+    testOutputPath: `notes${path.sep}test-noteWithNestedTagsWithGlobalRegex${path.sep}test -note with text only.md`,
+    expectedOutputPath: `${dataFolder}test-noteWithNestedTagsWithGlobalRegex.md`,
+  },
   {
     name: 'Note with nested tags containing spaces',
     options: {