add escapeHashtags setting (#43)

manifest.json

@@ -1,7 +1,7 @@
 {
 	"id": "obsidian-tweet-to-markdown",
 	"name": "Tweet to Markdown",
-	"version": "2.11.2",
+	"version": "2.12.0",
 	"minAppVersion": "0.12.17",
 	"description": "Save tweets as Markdown files, along with their images, polls, etc.",
 	"author": "kbravh",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "obsidian-tweet-to-markdown",
-  "version": "2.11.2",
+  "version": "2.12.0",
   "description": "Save tweets as beautiful markdown files in Obsidian (https://obsidian.md)",
   "main": "main.js",
   "engines": {

src/settings.ts

@@ -17,6 +17,7 @@ export interface TTMSettings {
   tags: string[]
   cssclass: string
   freeformFrontmatter: string[]
+  escapeHashtags: boolean
   avatars: boolean
   avatarSize: string
   defaultToThread: boolean
@@ -45,6 +46,7 @@ export const DEFAULT_SETTINGS: TTMSettings = {
   tags: [],
   cssclass: '',
   freeformFrontmatter: [],
+  escapeHashtags: false,
   avatars: true,
   avatarSize: '',
   defaultToThread: false,
@@ -297,6 +299,20 @@ export class TTMSettingTab extends PluginSettingTab {
           })
       )
 
+    new Setting(containerEl)
+      .setName('Escape hashtags')
+      .setDesc(
+        'Prevent hashtags from being included in Obsidian tags (change # to \\#)'
+      )
+      .addToggle(toggle =>
+        toggle
+          .setValue(this.plugin.settings.escapeHashtags)
+          .onChange(async value => {
+            this.plugin.settings.escapeHashtags = value
+            await this.plugin.saveSettings()
+          })
+      )
+
     new Setting(containerEl)
       .setName('Include profile pictures')
       .setDesc(

src/util.ts

@@ -329,7 +329,11 @@ type GenericEntity = Pick<
 /**
  * replace any mentions, hashtags, cashtags, urls with links
  */
-export const replaceEntities = (entities: Entities, text: string): string => {
+export const replaceEntities = (
+  settings: TTMSettings,
+  entities: Entities,
+  text: string
+): string => {
   /**
    * Each entity comes with start and end indices. However, if we were to replace
    * them in the order they occur, the indices further down the line would be shifted
@@ -342,7 +346,9 @@ export const replaceEntities = (entities: Entities, text: string): string => {
     })),
     ...(entities?.hashtags ?? []).map(hashtag => ({
       ...hashtag,
-      replacement: `[#${hashtag.tag}](https://twitter.com/hashtag/${hashtag.tag})`,
+      replacement: `[${settings.escapeHashtags ? '\\' : ''}#${
+        hashtag.tag
+      }](https://twitter.com/hashtag/${hashtag.tag})`,
     })),
     ...(entities?.cashtags ?? []).map(cashtag => ({
       ...cashtag,
@@ -400,7 +406,7 @@ export const buildMarkdown = async (
    * replace entities with markdown links
    */
   if (tweet.data?.entities && plugin.settings.includeLinks) {
-    text = replaceEntities(tweet.data.entities, text)
+    text = replaceEntities(plugin.settings, tweet.data.entities, text)
   }
 
   text = decode(text)

versions.json

@@ -1,3 +1,3 @@
 {
-  "2.11.2": "0.12.17"
+  "2.12.0": "0.12.17"
 }