feat: support of naked urls (#211)

akosbalasko · Jul 18, 2021 · 193f61d · 193f61d
1 parent d0cebb9
commit 193f61d
Show file tree

Hide file tree

Showing 8 changed files with 42 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -114,6 +114,8 @@ The following configurational properties are available:
 | ```keepImageSize``` | `ObsidianMD` or `StandardMD` | preserve an image's width and height in the chosen format when specified
 | ```urlEncodeFileNamesAndLinks``` | true or false | URL-encodes linked file names and internal EN links . e.g "linked file.jpg" will be converted to "linked%20file.jpg" 
 | ```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 
 
 Metadata settings can be set via the template.
diff --git a/src/YarleOptions.ts b/src/YarleOptions.ts
@@ -28,6 +28,7 @@ export interface YarleOptions {
     nestedTags?: TagSeparatorReplaceOptions;
     keepImageSize?: OutputFormat;
     keepOriginalAmountOfNewlines?: boolean;
+    generateNakedUrls?: boolean;
     addExtensionToInternalLinks?: boolean;
     pathSeparator?: string;
     resourcesDir?: string;

diff --git a/src/ui/sections/config.html b/src/ui/sections/config.html
@@ -98,7 +98,16 @@ <h2>General</h2>
               keep the original amount of newlines, default is false, when the multiple newlines are collapsed to one.)</i></div>
           </label>
       </div>
-
+      <div class="field half">
+        <input type="checkbox" value="false" id='generateNakedUrls'> 
+        <label for="generateNakedUrls" class="pure-checkbox">
+          Generate 'naked' URLs
+          <br><div style='font-size: 12px;'><i>(
+            if it's true, Yarle generates 'naked' external Urls without any extra characters. If its false, external Urls are wrapped by  '\<' and '\>' characters
+            )</i></div>
+        </label>
+    </div>
+
       <div class="field half">
         <input type="checkbox" value="false" id='addExtensionToInternalLinks'> 
         <label for="addExtensionToInternalLinks" class="pure-checkbox">

diff --git a/src/ui/settingsMapper.ts b/src/ui/settingsMapper.ts
@@ -33,5 +33,6 @@ export const mapSettingsToYarleOptions = (): YarleOptions => {
         keepImageSize: store.get('keepImageSize') as OutputFormat,
         keepOriginalAmountOfNewlines: store.get('keepOriginalAmountOfNewlines') as boolean,
         addExtensionToInternalLinks: store.get('addExtensionToInternalLinks') as boolean,
+        generateNakedUrls: store.get('generateNakedUrls') as boolean,
     }
 }
diff --git a/src/utils/turndown-rules/internal-links-rule.ts b/src/utils/turndown-rules/internal-links-rule.ts
@@ -68,6 +68,6 @@ export const wikiStyleLinksRule = {
 
 export const getShortLinkIfPossible = (token: any, value: string): string => {
     return (!token['text'] || _.unescape(token['text']) === _.unescape(value))
-                ? `<${value}>`
+                ? yarleOptions.generateNakedUrls ? value : `<${value}>`
                 : `${token['mdKeyword']}[${token['text']}](${value})`;
 }
diff --git a/test/data/test-externalLink-naked.enex b/test/data/test-externalLink-naked.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="20200518T214836Z" application="Evernote" version="Evernote Mac 7.14 (458265)">
+<note><title>External Link</title><content><![CDATA[<!DOCTYPE en-note SYSTEM "http://xml.evernote.com/pub/enml2.dtd"><en-note><div><a href="https://444.hu/"></a></div></en-note>]]></content><created>20200518T214753Z</created><updated>20200518T214817Z</updated><note-attributes><latitude>47.62493896484375</latitude><longitude>19.13836314872808</longitude><altitude>127.599723815918</altitude><author>akos</author><source>desktop.mac</source><reminder-order>0</reminder-order></note-attributes></note>
+</en-export>
diff --git a/test/data/test-externalLink-naked.md b/test/data/test-externalLink-naked.md
@@ -0,0 +1,8 @@
+# External Link
+
+https://444.hu/
+
+    Created at: 2020-05-18T22:47:53+01:00
+    Updated at: 2020-05-18T22:48:17+01:00
+    Where: 47.62493896484375,19.13836314872808
+
diff --git a/test/yarle-tests.ts b/test/yarle-tests.ts
@@ -645,6 +645,20 @@ export const yarleTests: Array<YarleTest> = [
 
     expectedOutputPath: `${dataFolder}test-externalLink-escape.md`,
   },
+  {
+    name: ' Pure external url naked',
+    options: {
+      enexSource: `.${testDataFolder}test-externalLink-naked.enex`,
+      outputDir: 'out',
+      isMetadataNeeded: true,
+      skipLocation: true,
+      keepMDCharactersOfENNotes: true,
+      generateNakedUrls: true,
+    },
+    testOutputPath: `notes${path.sep}test-externalLink-naked${path.sep}External Link.md`,
+
+    expectedOutputPath: `${dataFolder}test-externalLink-naked.md`,
+  },
 
   {
     name: ' Custom date format',