Feature release version

manifest.json

@@ -1,7 +1,7 @@
 {
     "id": "obsidian-zotero-annotations",
     "name": "Zotero Annotations",
-    "version": "0.2.8",
+    "version": "0.3.0",
     "description": "Plugin to import metadata and annotations from Zotero",
     "author": "Anoop K. Chandran",
     "authorUrl": "anoopkcn.com",

package.json

@@ -1,6 +1,6 @@
 {
     "name": "obsidian-zotero-annotations",
-    "version": "0.2.8",
+    "version": "0.3.0",
     "description": "Plugin to import and format annotations from Zotero",
     "main": "main.js",
     "scripts": {

src/creators.ts

@@ -1,7 +1,6 @@
 import { Creator, CreatorArray } from "./types";
 import { getInitials, makeQuotes, makeWiki, replaceTemplate } from "./utils";
 
-
 export const getCreatorKey = (creators: CreatorArray) => {
     const authorKey: string[] = [];
     const editorKey: string[] = [];

src/notes.ts

@@ -1,5 +1,4 @@
-//Solution copied from obsidian-bibnotes: https://github.com/stefanopagliari/bibnotes/blob/master/src/main.ts
-
+//Solution copied and modified from obsidian-bibnotes: https://github.com/stefanopagliari/bibnotes/blob/master/src/main.ts
 
 import { Notice, TFile, WorkspaceLeaf } from "obsidian";
 import * as fs from "fs";

src/parser.ts

@@ -166,7 +166,6 @@ export function extractAnnotation(
     }
 
     if (selectedEntry.notes.length > 0) {
-
         // cincatinate notes and annotations from multiple files for the same reference
         if (settings.importAllAnnotationFiles) {
             for (indexNote = 0; indexNote < selectedEntry.notes.length; indexNote++) {
@@ -187,7 +186,6 @@ export function extractAnnotation(
         );
 
         keywordArray = resultsLineElements.keywordArray;
-
         //Create the annotation by merging the individial elements of rowEditedArray. Do the same for the colour
         extractedAnnotations =
             resultsLineElements.rowEditedArray.join("\n");
@@ -260,15 +258,12 @@ export function parseMetadata(
 
     //Fix itemType
     selectedEntry.itemType = camelToNormalCase(selectedEntry.itemType);
-
     // Create in-line citation (e.g. Collier, Laporte and Seawright (2009))
     selectedEntry.citationInLine = `${getCreatorKey(selectedEntry.creators)} (${selectedEntry.year})`;
     selectedEntry.citationInLine = selectedEntry.citationInLine.replace("()", "");
-
     // Create in-line citation with initials (e.g. Collier, D., Laporte, J. and Seawright, J. (2009))
     selectedEntry.citationInLineInitials = `${getCreatorFullInitials(selectedEntry.creators)} (${selectedEntry.year})`;
     selectedEntry.citationInLineInitials = selectedEntry.citationInLineInitials.replace("()", "");
-
     // Create in-line citation with initials (e.g. Collier, D., Laporte, J. and Seawright, J. (2009))
     selectedEntry.citationInLineFullName = `${getCreatorFullNames(selectedEntry.creators)} (${selectedEntry.year})`;
     selectedEntry.citationInLineFullName = selectedEntry.citationInLineFullName.replace("()", "");
@@ -277,7 +272,6 @@ export function parseMetadata(
     if (selectedEntry.itemType == "Journal Article") {
         selectedEntry.citationShort = `${selectedEntry.citationInLine} '${selectedEntry.title}'`;
         selectedEntry.citationFull = `${selectedEntry.citationShort}, *${selectedEntry.publicationTitle}*, ${selectedEntry.volume}(${selectedEntry.issue}), pp. ${selectedEntry.pages}.`;
-
         selectedEntry.citationFull = selectedEntry.citationFull.replace("() ", "");
         selectedEntry.citationShort = selectedEntry.citationShort.replace("** ", "");
         selectedEntry.citationFull = selectedEntry.citationFull.replace("** ", "");
@@ -289,15 +283,12 @@ export function parseMetadata(
     selectedEntry.file = getLocalFileLink(selectedEntry);
     // Create an array with all the fields
     const entriesArray = Object.keys(selectedEntry);
-
     //replace the single-value placeholders with the value of the field
     note = replaceAllTemplates(entriesArray, note, selectedEntry);
-
     //remove single backticks but retain triple backticks
     note = note.replace(/```/g, "HEREISAPLACEHOLDERFORBACKTICK");
     note = note.replace(/`/g, "'");
     note = note.replace(/HEREISAPLACEHOLDERFORBACKTICK/g, "```");
-
     // //if the abstract is missing, delete Abstract headings
     // Return the metadata
     return note;
@@ -314,12 +305,9 @@ export function parseAnnotationLinesintoElementsZotfile(
     for (let indexLines = 0; indexLines < lines.length; indexLines++) {
         //Remote html tags
         const selectedLineOriginal = lines[indexLines];
-
         const selectedLine = selectedLineOriginal.replace(/<\/?[^>]+(>|$)/g, "");
-
         //Skip if empty
         if (selectedLine === "") continue;
-
         //Crety empty lineElements
         //@ts-ignore
         const lineElements: AnnotationElements = {
@@ -354,7 +342,6 @@ export function parseAnnotationLinesintoElementsZotfile(
         }
 
         const posCiteKeyBegins = selectedLine.indexOf(lineElements.citeKey);
-
         let extractedText = "";
         if (posCiteKeyBegins !== -1) {
             extractedText = selectedLine
@@ -464,10 +451,8 @@ export function parseAnnotationLinesintoElementsUserNote(note: string) {
     const lengthLines = Object.keys(lines).length;
     for (let indexLines = 0; indexLines < lengthLines; indexLines++) {
         const selectedLineOriginal = unescape(lines[indexLines]);
-
         // Replace backticks with single quote
         let selectedLine = replaceTemplate(selectedLineOriginal, "`", "'");
-
         // Correct encoding issues with special character showing incorrectly
         selectedLine = replaceTemplate(selectedLine, "&amp;", "&")
             .replace(/&lt;/g, "<")
@@ -508,9 +493,7 @@ export function parseAnnotationLinesintoElementsUserNote(note: string) {
         };
 
         lineElements.rowEdited = selectedLine;
-
         //Add the element to the array containing all the elements
-
         noteElements.push(lineElements);
     }
 
@@ -568,15 +551,13 @@ export function parseAnnotationLinesintoElementsZotero(
 
         //Record the extraction method
         lineElements.extractionSource = "zotero";
-
         //Identify images
         if (/data-attachment-key=/gm.test(selectedLineOriginal)) {
             lineElements.annotationType = "typeImage";
             lineElements.imagePath = String(selectedLineOriginal.match(/key="([^"]*)"/g)[0])
                 .replaceAll('"', "")
                 .replace("key=", "");
         }
-
         //Extract the colour of the highlight
         if (/"color":"#......"/gm.test(selectedLineOriginal)) {
             let highlightColour = String(selectedLineOriginal.match(/"color":"#......"/gm));
@@ -585,7 +566,6 @@ export function parseAnnotationLinesintoElementsZotero(
             highlightColour = highlightColour.replace('"', "");
             lineElements.highlightColour = highlightColour;
         }
-
         // Extract the location of the annotation in the PDF
         // "locator":"12345"
         if (/"locator":"\d+"/gm.test(selectedLineOriginal)) {

src/settings.ts

@@ -15,9 +15,6 @@ export class SettingsTab extends PluginSettingTab {
         const { settings } = plugin;
 
         containerEl.empty();
-
-        // containerEl.createEl("h1", { text: "Zotero Annotations " });
-
         containerEl.createEl("h2", { text: "General Settings" });
         new Setting(containerEl)
             .setName(t("JSON_FILE_PATH"))
@@ -58,7 +55,6 @@ export class SettingsTab extends PluginSettingTab {
                     })
             );
 
-        // containerEl.createEl("h2", { text: "Template" });
         new Setting(containerEl)
             .setName(t("TEMPLATE_FILE"))
             .setDesc(fragWithHTML(t("TEMPLATE_FILE_DESC")))
@@ -134,7 +130,6 @@ export class SettingsTab extends PluginSettingTab {
                     })
             );
 
-        // containerEl.createEl("h2", { text: "In-text citations" });
         new Setting(containerEl)
             .setName(t("CREATE_BACKLINKS"))
             .setDesc(fragWithHTML(t("CREATE_BACKLINKS_DESC")))

src/utils.ts

@@ -159,25 +159,21 @@ export function replaceMissingFields(
 
 export function getLocalFileLink(reference: Reference) {
     //if there is no attachment, return placeholder
-    if (reference.attachments.length == 0) return "{{localFile}}";
+    const len_attachments = reference.attachments.length;
+    if (len_attachments == 0) return "{{localFile}}";
     const filesList: string[] = [];
 
     for (
-        let attachmentindex = 0;
-        attachmentindex < reference.attachments.length;
-        attachmentindex++
-    ) {
-        if (reference.attachments[attachmentindex].itemType !== "attachment")
-            continue;
-
+        let index = 0; index < len_attachments; index++) {
+        if (reference.attachments[index].itemType !== "attachment") continue;
         //remove white spaces from file name
-        if (reference.attachments[attachmentindex].path == undefined) {
-            reference.attachments[attachmentindex].path = "";
+        if (reference.attachments[index].path == undefined) {
+            reference.attachments[index].path = "";
         }
 
         const selectedfile: string =
-            "[" + reference.attachments[attachmentindex].title + "](file:///" +
-            encodeURI(reference.attachments[attachmentindex].path.replaceAll(" ", " ")) + ")"; 
+            "[" + reference.attachments[index].title + "](file:///" +
+            encodeURI(reference.attachments[index].path.replaceAll(" ", " ")) + ")"; 
 
         filesList.push(selectedfile);
     }
@@ -208,10 +204,7 @@ export function getNoteTitle(
     return exportTitle;
 }
 
-export function createNotePath(
-    noteTitle: string,
-    exportPath: string
-) {
+export function createNotePath(noteTitle: string, exportPath: string) {
     return resolvePath(`${exportPath}/${noteTitle}.md`)
 }
 
@@ -296,7 +289,6 @@ export function getZoteroAppInfo(
         //first look into the same path as the pdf attachment
         let pathZoteroStorage = "";
         let zoteroBuildWindows: boolean = undefined;
-
         //check if the base path where the attachment is stored is in Zotero/storage
         const zoteroStorageMac = new RegExp(/.+?(?=Zotero\/storage)Zotero\/storage\//gm);