feat: allow links in the todo description

Links to other pages within the Obsidian vault can be created by
enclosing in double square brackets for example: [[Inbox]]

Closes #9

dist/manifest.json

@@ -1,7 +1,7 @@
 {
 	"id": "todotxt",
 	"name": "TodoTxt",
-	"version": "1.4.4",
+	"version": "1.5.0",
 	"minAppVersion": "0.15.0",
 	"description": "Manage Todo.txt files.",
 	"author": "Mark Grimes",

dist/versions.json

@@ -16,5 +16,6 @@
 	"1.3.3": "0.15.0",
 	"1.4.0": "0.15.0",
 	"1.4.3": "0.15.0",
-	"1.4.4": "0.15.0"
-}
+	"1.4.4": "0.15.0",
+	"1.5.0": "0.15.0"
+}

manifest.json

@@ -1,7 +1,7 @@
 {
 	"id": "todotxt",
 	"name": "TodoTxt",
-	"version": "1.4.4",
+	"version": "1.5.0",
 	"minAppVersion": "0.15.0",
 	"description": "Manage Todo.txt files.",
 	"author": "Mark Grimes",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "obsidian-sample-plugin",
-  "version": "1.4.4",
+  "version": "1.5.0",
   "description": "This is a sample plugin for Obsidian (https://obsidian.md)",
   "main": "dist/main.js",
   "scripts": {

src/ui/todoslist.tsx

@@ -8,6 +8,7 @@ type TodosListProps = {
   onCompleteToggle: (t: Todo) => void;
   onDeleteClicked: (t: Todo) => void;
   onEditClicked: (t: Todo) => void;
+  onNavigate: (url: string, newTab: boolean) => void;
 };
 
 export const TodosList = (props: TodosListProps) => {
@@ -34,6 +35,7 @@ export const TodosList = (props: TodosListProps) => {
           onDeleteClicked={props.onDeleteClicked}
           onEditClicked={props.onEditClicked}
           onKeyPressed={handleKeyPress}
+          onNavigate={props.onNavigate}
           key={todo.id}
         />
       ))}

src/ui/todosview.tsx

@@ -13,6 +13,7 @@ type TodosViewProps = {
   defaultOrganizeBy: 'project' | 'context';
   preservePriority: boolean;
   recurringTasks: boolean;
+  onNavigate: (url: string, newTab: boolean) => void;
 };
 type OrganizeBy = 'project' | 'context';
 
@@ -176,6 +177,7 @@ export const TodosView = (props: TodosViewProps) => {
               onCompleteToggle={handleCompleteToggle}
               onDeleteClicked={handleShowDelete}
               onEditClicked={handleShowEdit}
+              onNavigate={props.onNavigate}
             />
           </section>
         ))}

src/ui/todoview.tsx

@@ -11,6 +11,7 @@ type TodoViewProps = {
   onDeleteClicked: (t: Todo) => void;
   onEditClicked: (t: Todo) => void;
   onKeyPressed: (e: React.KeyboardEvent<HTMLInputElement>, t: Todo) => void;
+  onNavigate: (url: string, newTab: boolean) => void;
 };
 export const TodoView = (props: TodoViewProps) => {
   const { todo } = props;
@@ -43,7 +44,10 @@ export const TodoView = (props: TodoViewProps) => {
                 todo.preThreshold() ? 'todo-prethreshold' : '',
               )}
             >
-              {todo.description}
+              <TodoDescription
+                description={todo.description}
+                onNavigate={props.onNavigate}
+              />
             </span>
             {todo.tags.map((tag, i) => (
               <TodoTagView tag={tag} key={i} />
@@ -106,3 +110,36 @@ const TodoTagView = ({ tag }: { tag: TodoTag }) => {
     </span>
   );
 };
+
+const DESC_RE = /(\[\[[^\]]+\]\])/g;
+
+const TodoDescription = ({
+  description,
+  onNavigate,
+}: {
+  description: string;
+  onNavigate: (url: string, newTab: boolean) => void;
+}) => {
+  const parts = description.split(DESC_RE);
+  console.log(description, parts);
+
+  return (
+    <span>
+      {parts.map((part) => {
+        const url = part.match(/^\[\[(.*)\]\]$/);
+        if (url)
+          return (
+            <a
+              onClick={(e) => {
+                e.preventDefault();
+                onNavigate(url[1], true);
+              }}
+            >
+              {url[1]}
+            </a>
+          );
+        return <>{part}</>;
+      })}
+    </span>
+  );
+};

src/view.tsx

@@ -59,6 +59,11 @@ export class TodotxtView extends TextFileView {
     this.requestSave();
   }
 
+  handleNavigate(url: string, newTab: boolean) {
+    const callingFilePath = ''; // TODO: this must be available in `this`
+    this.plugin.app.workspace.openLinkText(url, callingFilePath, newTab);
+  }
+
   refresh() {
     const settings = this.plugin?.settings;
 
@@ -70,6 +75,7 @@ export class TodotxtView extends TextFileView {
         defaultOrganizeBy={settings?.defaultOrganizeBy || 'project'}
         preservePriority={settings?.preservePriority ?? true}
         recurringTasks={settings?.recurringTasks ?? false}
+        onNavigate={this.handleNavigate.bind(this)}
       />,
     );
   }

versions.json

@@ -16,5 +16,6 @@
 	"1.3.3": "0.15.0",
 	"1.4.0": "0.15.0",
 	"1.4.3": "0.15.0",
-	"1.4.4": "0.15.0"
-}
+	"1.4.4": "0.15.0",
+	"1.5.0": "0.15.0"
+}