Complete Tag functionality

Author: jsonMartin

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.1.0 (2021-06-24)
+### Added
+- Added tag support, both in highlights and sources (books, articles, etc)
+
 ## 1.0.2 (2021-05-24)
 ### Fixed
 - Fixed linking bug when illegal characters were stripped in filename, but not in Note title (https://github.com/jsonMartin/readwise-mirror/issues/4)

README.md

@@ -15,6 +15,7 @@ The first time this plugin is ran, it will do a full sync downloading all conten
 - Enhanced Obsidian Markdown formatting
   - Automatically creates `[[Links]]` for book titles and authors
   - Contains block level link references *(using the Highlight ID)*. Allows to automatically link/transclude any highlight without needing to modify the Readwise note.
+- Supports tags, both within highlights as well as sources (books, articles, etc)
 
 ## Usage
 After installing, visit the plugin configuration page to enter the Readwise Access Token, which can be found here: [https://readwise.io/access_token](https://readwise.io/access_token)

main.ts

@@ -2,7 +2,7 @@ import { App, Plugin, PluginSettingTab, Setting } from 'obsidian';
 import Notify from 'notify';
 import spacetime from 'spacetime';
 
-import { ReadwiseApi, Library, Highlight, Book } from 'readwiseApi';
+import { ReadwiseApi, Library, Highlight, Book, Tag } from 'readwiseApi';
 
 interface PluginSettings {
   baseFolderName: string;
@@ -25,15 +25,22 @@ export default class ReadwiseMirror extends Plugin {
   readwiseApi: ReadwiseApi;
   notify: Notify;
 
+  private formatTags(tags: Tag[]) {
+    return tags.map((tag) => `#${tag.name}`).join(', ');
+  }
+
   private formatHighlight(highlight: Highlight, book: Book) {
-    const { id, text, note, location, color } = highlight;
+    const { id, text, note, location, color, tags } = highlight;
     const locationUrl = `https://readwise.io/to_kindle?action=open&asin=${book['asin']}&location=${location}`;
     const locationBlock = location !== null ? `([${location}](${locationUrl}))` : '';
 
+    const formattedTags = tags.filter((tag) => tag.name !== color);
+    const formattedTagStr = this.formatTags(formattedTags);
+
     return `
 ${text} ${book.category === 'books' ? locationBlock : ''}${color ? ` %% Color: ${color} %%` : ''} ^${id}${
       note ? `\n\n**Note: ${note}**` : ``
-    }
+    }${formattedTagStr.length >= 1 ? `\n\n**Tags: ${formattedTagStr}**` : ``}
 
 ---
 `;
@@ -74,6 +81,7 @@ ${text} ${book.category === 'books' ? locationBlock : ''}${color ? ` %% Color: $
         highlights,
         last_highlight_at,
         source_url,
+        tags
       } = book;
       const sanitizedTitle = `${title.replace(':', '-').replace(/[<>"'\/\\|?*]+/g, '')}`;
 
@@ -103,7 +111,7 @@ Updated: ${this.formatDate(updated)}
 # About
 Title: [[${sanitizedTitle}]]
 ${authors.length > 1 ? 'Authors' : 'Author'}: ${authorStr}
-Category: #${category}
+Category: #${category}${tags.length > 1 ? ('\nTags: ' + this.formatTags(tags)): ''}
 Number of Highlights: ==${num_highlights}==
 Last Highlighted: *${last_highlight_at ? this.formatDate(last_highlight_at) : 'Never'}*
 Readwise URL: ${highlights_url}${category === 'articles' ? `\nSource URL: ${source_url}\n` : ''}

manifest.json

@@ -1,7 +1,7 @@
 {
   "id": "readwise-mirror",
   "name": "Readwise Mirror",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "minAppVersion": "0.11.0",
   "description": "Mirror your Readwise library directly to an Obsidian vault",
   "author": "jsonmartin",

readwiseApi.ts

@@ -19,6 +19,12 @@ export interface Highlight {
   color: string;
   updated: string;
   book_id: number;
+  tags: Tag[];
+}
+
+export interface Tag {
+  id: number;
+  name: string;
 }
 
 export interface Book {
@@ -34,6 +40,7 @@ export interface Book {
   source_url: string | null;
   asin: string;
   highlights: Highlight[];
+  tags: Tag[];
 }
 
 export interface Books {