joplin-plugin-backup 1.1.0 → 1.2.0

package/README.md

@@ -2,8 +2,35 @@
 
 A plugin to extend Joplin with a manual and automatic backup function.
 
+<!-- markdownlint-disable MD033 -->
+<!-- markdownlint-disable MD028 -->
+<!-- markdownlint-disable MD007 -->
+
 <img src=img/main.jpg>
 
+<!-- prettier-ignore-start -->
+<!-- TOC depthfrom:2 orderedlist:false -->
+
+- [Installation](#installation)
+    - [Automatic](#automatic)
+    - [Manual](#manual)
+- [Usage](#usage)
+- [Options](#options)
+- [Keyboard Shortcuts](#keyboard-shortcuts)
+- [What is backed up](#what-is-backed-up)
+- [Restore](#restore)
+    - [Settings](#settings)
+    - [Notes](#notes)
+- [FAQ](#faq)
+    - [Internal Joplin links betwen notes are lost](#internal-joplin-links-betwen-notes-are-lost)
+    - [Combine multiple JEX Files to one](#combine-multiple-jex-files-to-one)
+- [Open a JEX Backup file](#open-a-jex-backup-file)
+- [Changelog](#changelog)
+- [Links](#links)
+
+<!-- /TOC -->
+<!-- prettier-ignore-end -->
+
 ## Installation
 
 ### Automatic
@@ -33,7 +60,7 @@ Go to `Tools > Options > Backup`
 
 | Option                       | Description                                                                                                                                                              | Default                 |
 | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------- |
-| `Backup path`                | Where to save the backups to. <br>This path is exclusive for the Joplin backups, there should be no other data in it!                                                    |                         |
+| `Backup path`                | Where to save the backups to. <br>This path is exclusive for the Joplin backups, there should be no other data in it when you disable the `Create Subfolder` settings!   |                         |
 | `Keep x backups`             | How many backups should be kept                                                                                                                                          | `1`                     |
 | `Backups interval in hours`  | Create a backup every X hours                                                                                                                                            | `24`                    |
 | `Only on change`             | Creates a backup at the specified backup interval only if there was a change to a `note`, `tag`, `resource` or `notebook`                                                | `false`                 |
@@ -44,6 +71,8 @@ Go to `Tools > Options > Backup`
 | `Temporary export path`      | The data is first exported into this path before it is copied to the backup `Backup path`.                                                                               | ``                      |
 | `Backup set name`            | Name of the backup set if multiple backups are to be keep. [Available moment tokens](https://momentjs.com/docs/#/displaying/format/), which can be used with `{<TOKEN>}` | `{YYYYMMDDHHmm}`        |
 | `Single JEX`                 | Create only one JEX file for all, this option is recommended to prevent the loss of internal note links or folder structure during a restore!                            | `true`                  |
+| `Export format`              | Selection of the export format of the notes.                                                                                                                             | `jex`                   |
+| `Command on Backup finish`   | Execute command when backup is finished.                                                                                                                                 |                         |
 | `Create Subfolder`           | Create a sub folder `JoplinBackup` in the configured `Backup path`. Deactivate only if there is no other data in the `Backup path`!                                      | `true`                  |
 | `Backup plugins`             | Backup the plugin folder from the Joplin profile with all installed plugin jpl files.                                                                                    | `true`                  |
 
@@ -79,7 +108,7 @@ The notes are imported via `File > Import > JEX - Joplin Export File`.
 > Individual notes cannot be restored from the JEX file!
 
 The notes are imported additionally, no check for duplicates is performed.
-If the folder in which the note was located already exists in you Joplin, than the folder name is extended by one (1).
+If the notebook in which the note was located already exists in your Joplin, then a "(1)" will be appended to the folder name.
 
 ## FAQ
 
@@ -88,7 +117,7 @@ If the folder in which the note was located already exists in you Joplin, than t
 If several JEX files are imported and the notes have links to each other, these links will be lost.
 Therefore it is recommended to create a Single JEX Backup!
 
-### Compine multiple JEX Files to one
+### Combine multiple JEX Files to one
 
 By combining the JEX files into one, the Joplin internal links will work again after the import.
 

package/__test__/backup.test.ts

@@ -15,6 +15,7 @@ function getTestPaths(): any {
   );
   testPath.joplinProfile = path.join(testPath.base, "joplin-desktop");
   testPath.templates = path.join(testPath.joplinProfile, "templates");
+  testPath.plugins = path.join(testPath.joplinProfile, "plugins");
   return testPath;
 }
 
@@ -39,6 +40,7 @@ async function createTestStructure() {
   fs.emptyDirSync(test.backupBasePath);
   fs.emptyDirSync(test.joplinProfile);
   fs.emptyDirSync(test.templates);
+  fs.emptyDirSync(test.plugins);
 }
 
 const testPath = getTestPaths();
@@ -573,6 +575,45 @@ describe("Backup", function () {
   });
 
   describe("Backup retention", function () {
+    it(`file/Folder deletion`, async () => {
+      const backupRetention = 2;
+      const set1 = path.join(testPath.backupBasePath, "202101011630");
+      const set2 = path.join(testPath.backupBasePath, "202101021630.7z");
+      const set3 = path.join(testPath.backupBasePath, "202101031630");
+      const set4 = path.join(testPath.backupBasePath, "202101041630.7z");
+
+      fs.emptyDirSync(set1);
+      fs.closeSync(fs.openSync(set2, "w"));
+      fs.emptyDirSync(set3);
+      fs.closeSync(fs.openSync(set4, "w"));
+
+      const backupInfo = [
+        { name: "202101011630", date: 1609515000 },
+        { name: "202101021630.7z", date: 1609601400 },
+        { name: "202101031630", date: 1609687800 },
+        { name: "202101041630.7z", date: 1609774200 },
+      ];
+
+      when(spyOnsSettingsValue)
+        .calledWith("backupInfo")
+        .mockImplementation(() => Promise.resolve(JSON.stringify(backupInfo)));
+
+      expect(fs.existsSync(set1)).toBe(true);
+      expect(fs.existsSync(set2)).toBe(true);
+      expect(fs.existsSync(set3)).toBe(true);
+      expect(fs.existsSync(set4)).toBe(true);
+      await backup.deleteOldBackupSets(
+        testPath.backupBasePath,
+        backupRetention
+      );
+
+      expect(fs.existsSync(set1)).toBe(false);
+      expect(fs.existsSync(set2)).toBe(false);
+      expect(fs.existsSync(set3)).toBe(true);
+      expect(fs.existsSync(set4)).toBe(true);
+      expect(fs.readdirSync(testPath.backupBasePath).length).toBe(2);
+    });
+
     it(`Backups < retention`, async () => {
       const backupRetention = 3;
       const folder1 = path.join(testPath.backupBasePath, "202101011630");
@@ -585,11 +626,15 @@ describe("Backup", function () {
         { name: "202101011630", date: 1 },
         { name: "202101021630", date: 2 },
       ];
-      /* prettier-ignore */
+
       when(spyOnsSettingsValue)
-            .calledWith("backupInfo").mockImplementation(() => Promise.resolve(JSON.stringify(backupInfo)));
+        .calledWith("backupInfo")
+        .mockImplementation(() => Promise.resolve(JSON.stringify(backupInfo)));
 
-      backup.deleteOldBackupSets(testPath.backupBasePath, backupRetention);
+      await backup.deleteOldBackupSets(
+        testPath.backupBasePath,
+        backupRetention
+      );
 
       const folderAnz = fs
         .readdirSync(testPath.backupBasePath, { withFileTypes: true })
@@ -616,11 +661,15 @@ describe("Backup", function () {
         { name: "202101021630", date: 2 },
         { name: "202101031630", date: 3 },
       ];
-      /* prettier-ignore */
+
       when(spyOnsSettingsValue)
-            .calledWith("backupInfo").mockImplementation(() => Promise.resolve(JSON.stringify(backupInfo)));
+        .calledWith("backupInfo")
+        .mockImplementation(() => Promise.resolve(JSON.stringify(backupInfo)));
 
-      backup.deleteOldBackupSets(testPath.backupBasePath, backupRetention);
+      await backup.deleteOldBackupSets(
+        testPath.backupBasePath,
+        backupRetention
+      );
       const folderAnz = fs
         .readdirSync(testPath.backupBasePath, { withFileTypes: true })
         .filter((dirent) => dirent.isDirectory()).length;
@@ -653,9 +702,10 @@ describe("Backup", function () {
         { name: "202101041630", date: 4 },
         { name: "202101051630", date: 5 },
       ];
-      /* prettier-ignore */
+
       when(spyOnsSettingsValue)
-            .calledWith("backupInfo").mockImplementation(() => Promise.resolve(JSON.stringify(backupInfo)));
+        .calledWith("backupInfo")
+        .mockImplementation(() => Promise.resolve(JSON.stringify(backupInfo)));
 
       await backup.deleteOldBackupSets(
         testPath.backupBasePath,
@@ -835,12 +885,14 @@ describe("Backup", function () {
       const userstyle = path.join(testPath.joplinProfile, "userstyle.css");
       const userchrome = path.join(testPath.joplinProfile, "userchrome.css");
       const keymap = path.join(testPath.joplinProfile, "keymap-desktop.json");
+      const plugin = path.join(testPath.plugins, "test-plugin.jpl");
 
       fs.writeFileSync(template, "template");
       fs.writeFileSync(settings, "settings");
       fs.writeFileSync(userstyle, "userstyle");
       fs.writeFileSync(userchrome, "userchrome");
       fs.writeFileSync(keymap, "keymap");
+      fs.writeFileSync(plugin, "plugin");
 
       fs.emptyDirSync(testPath.activeBackupJob);
 
@@ -870,8 +922,15 @@ describe("Backup", function () {
         "profile",
         "keymap-desktop.json"
       );
+      const backupPlugin = path.join(
+        testPath.activeBackupJob,
+        "profile",
+        "plugins",
+        "test-plugin.jpl"
+      );
 
       backup.activeBackupPath = testPath.activeBackupJob;
+      backup.backupPlugins = true;
       await backup.backupProfileData();
 
       expect(fs.existsSync(backupTemplate)).toBe(true);
@@ -879,6 +938,7 @@ describe("Backup", function () {
       expect(fs.existsSync(backupUserstyle)).toBe(true);
       expect(fs.existsSync(backupUserchrome)).toBe(true);
       expect(fs.existsSync(backupKeymap)).toBe(true);
+      expect(fs.existsSync(backupPlugin)).toBe(true);
 
       expect(backup.log.error).toHaveBeenCalledTimes(0);
       expect(backup.log.warn).toHaveBeenCalledTimes(0);

package/__test__/help.test.ts

@@ -71,4 +71,79 @@ describe("Test helper", function () {
       );
     }
   });
+  it(`Compare versions`, async () => {
+    const testCases = [
+      {
+        version1: "2.9.12",
+        version2: "2.9.12",
+        expected: 0,
+      },
+      {
+        version1: "2.9.12",
+        version2: "2.9.13",
+        expected: -1,
+      },
+      {
+        version1: "2.9.13",
+        version2: "2.9.12",
+        expected: 1,
+      },
+      {
+        version1: "2.10.6",
+        version2: "2.9.12",
+        expected: 1,
+      },
+      {
+        version1: "3.10.6",
+        version2: "2.11.8",
+        expected: 1,
+      },
+      {
+        version1: "2.10.6",
+        version2: "3.11.8",
+        expected: -1,
+      },
+      {
+        version1: "2",
+        version2: "2.1",
+        expected: -1,
+      },
+      {
+        version1: "2.1",
+        version2: "2",
+        expected: 1,
+      },
+      {
+        version1: "3",
+        version2: "2",
+        expected: 1,
+      },
+      {
+        version1: "2",
+        version2: "2",
+        expected: 0,
+      },
+      {
+        version1: "3.11.8",
+        version2: "3.11.8-a",
+        expected: 0,
+      },
+      {
+        version1: "2",
+        version2: "",
+        expected: -2,
+      },
+      {
+        version1: "3.a.8",
+        version2: "3.11.8",
+        expected: -1,
+      },
+    ];
+
+    for (const testCase of testCases) {
+      expect(
+        await helper.versionCompare(testCase.version1, testCase.version2)
+      ).toBe(testCase.expected);
+    }
+  });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "joplin-plugin-backup",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "scripts": {
     "dist": "webpack --joplin-plugin-config buildMain && webpack --joplin-plugin-config buildExtraScripts && webpack --joplin-plugin-config createArchive",
     "prepare": "npm run dist && husky install",

package/publish/io.github.jackgruber.backup.json

@@ -2,7 +2,7 @@
 	"manifest_version": 1,
 	"id": "io.github.jackgruber.backup",
 	"app_min_version": "2.1.3",
-	"version": "1.1.0",
+	"version": "1.2.0",
 	"name": "Simple Backup",
 	"description": "Plugin to create manual and automatic backups.",
 	"author": "JackGruber",
@@ -16,6 +16,6 @@
 		"7zip",
 		"encrypted"
 	],
-	"_publish_hash": "sha256:8d8c6a3bb92fafc587269aea58b623b05242d42c0766a05bbe25c3ba2bbdf8ee",
-	"_publish_commit": "master:00ed52133c659e0f3ac1a55f70b776c42fca0a6d"
+	"_publish_hash": "sha256:5b9605100911c96c157853884f1fb8fc0e4374697f493dcbeb45fd09068e469d",
+	"_publish_commit": "master:1a5f98eef052081f501e9bcda2fd1f69f2dbeb04"
 }