joplin-plugin-backup 1.0.5 → 1.1.0

package/.github/workflows/auto-assign-issue.yml

@@ -0,0 +1,14 @@
+name: Issue assignment
+
+on:
+  issues:
+    types: [opened]
+
+jobs:
+  auto-assign:
+    runs-on: ubuntu-latest
+    steps:
+      - name: "Auto-assign issue"
+        uses: pozil/auto-assign-issue@v1.4.0
+        with:
+          assignees: JackGruber

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2021 Gruber Alexander
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2021 Gruber Alexander
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -34,7 +34,6 @@ 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!                                                    |                         |
-| `Single JEX`                 | Create only one JEX file for all notebooks                                                                                                                               | `false`                 |
 | `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 +43,9 @@ Go to `Tools > Options > Backup`
 | `Zip compression Level`      | Compression level for zip archive archive                                                                                                                                | `Copy (no compression)` |
 | `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`                  |
+| `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`                  |
 
 ## Keyboard Shortcuts
 
@@ -59,13 +61,14 @@ Under `Options > Keyboard Shortcuts` you can assign a keyboard shortcut for the
 - The `userchrome.css` (Your Joplin customization)
 - The `userstyle.css` (Your Joplin customization)
 - The `templates` folder (Note templates)
+- The `plugin` folder (All installed plugins, no plugin settings!)
 
 ## Restore
 
 ### Settings
 
 To restore the Settings, copy the desired files from `<Backup Path>\Profile` to the Joplin directory `.config\joplin-desktop`.  
-The exact path can be found in Joplin under `Tools > Options > Generla`:
+The exact path can be found in Joplin under `Tools > Options > General`:
 
 <img src=img/joplin_path_in_gui.jpg>
 
@@ -78,6 +81,27 @@ The notes are imported via `File > Import > JEX - Joplin Export 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).
 
+## FAQ
+
+### Internal Joplin links betwen notes are lost
+
+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
+
+By combining the JEX files into one, the Joplin internal links will work again after the import.
+
+1. Open one of the JEX files in a ZIP program like 7-Zip
+2. Open a second JEX and add all files to the first JEX
+3. Repeat step 2 for all files
+4. Import first JEX which now contains all notes
+
+## Open a JEX Backup file
+
+A Joplin JEX Backup file is a tar archive which can be opened with any zip program that supports TAR archive.
+The file names in the archive correspond to the Joplin internal IDs.
+
 ## Changelog
 
 See [CHANGELOG.md](CHANGELOG.md)

package/__test__/backup.test.ts

@@ -24,6 +24,7 @@ let spyOnLogVerbose = null;
 let spyOnLogInfo = null;
 let spyOnLogWarn = null;
 let spyOnLogError = null;
+let spyOnShowError = null;
 let spyOnSaveBackupInfo = null;
 
 const spyOnsSettingsValue = jest.spyOn(joplin.settings, "value");
@@ -73,6 +74,10 @@ describe("Backup", function () {
     spyOnLogError = jest
       .spyOn(backup.log, "error")
       .mockImplementation(() => {});
+
+    spyOnShowError = jest
+      .spyOn(backup, "showError")
+      .mockImplementation(() => {});
   });
 
   afterEach(async () => {
@@ -80,6 +85,7 @@ describe("Backup", function () {
     spyOnLogInfo.mockReset();
     spyOnLogWarn.mockReset();
     spyOnLogError.mockReset();
+    spyOnShowError.mockReset();
     spyOnsSettingsValue.mockReset();
     spyOnGlobalValue.mockReset();
     spyOnSaveBackupInfo.mockReset();
@@ -88,29 +94,72 @@ describe("Backup", function () {
   afterAll(async () => {
     fs.removeSync(testPath.base);
   });
-
   describe("Backup path", function () {
-    it(`Backup path != Profile`, async () => {
-      await backup.loadBackupPath();
-      expect(backup.backupBasePath).toBe(testPath.backupBasePath);
-      expect(backup.backupBasePath).not.toBe(testPath.joplinProfile);
-
-      /* prettier-ignore */
-      when(spyOnsSettingsValue)
-      .calledWith("path").mockImplementation(() => Promise.resolve(""));
-      await backup.loadBackupPath();
-      expect(backup.backupBasePath).not.toBe(testPath.joplinProfile);
-      expect(backup.backupBasePath).toBe(null);
+    it(`Path tests`, async () => {
+      const testCases = [
+        {
+          backupPath: testPath.joplinProfile,
+          createSubfolder: false,
+          expectedBackupPath: null,
+          expectedBackupPathExist: null,
+        },
+        {
+          backupPath: testPath.joplinProfile,
+          createSubfolder: true,
+          expectedBackupPath: path.join(testPath.joplinProfile, "JoplinBackup"),
+          expectedBackupPathExist: true,
+        },
+        {
+          backupPath: testPath.backupBasePath,
+          createSubfolder: false,
+          expectedBackupPath: testPath.backupBasePath,
+          expectedBackupPathExist: true,
+        },
+        {
+          backupPath: testPath.backupBasePath,
+          createSubfolder: true,
+          expectedBackupPath: path.join(
+            testPath.backupBasePath,
+            "JoplinBackup"
+          ),
+          expectedBackupPathExist: true,
+        },
+        {
+          backupPath: path.join(testPath.backupBasePath, "NotExisting"),
+          createSubfolder: false,
+          expectedBackupPath: path.join(testPath.backupBasePath, "NotExisting"),
+          expectedBackupPathExist: false,
+        },
+        {
+          backupPath: path.join(testPath.backupBasePath, "NotExisting"),
+          createSubfolder: true,
+          expectedBackupPath: path.join(
+            testPath.backupBasePath,
+            "NotExisting",
+            "JoplinBackup"
+          ),
+          expectedBackupPathExist: false,
+        },
+      ];
 
-      /* prettier-ignore */
-      when(spyOnsSettingsValue)
-      .calledWith("path").mockImplementation(() => Promise.resolve(testPath.joplinProfile));
-      await backup.loadBackupPath();
-      expect(backup.backupBasePath).not.toBe(testPath.joplinProfile);
-      expect(backup.backupBasePath).toBe(null);
+      for (const testCase of testCases) {
+        when(spyOnsSettingsValue)
+          .calledWith("path")
+          .mockImplementation(() => Promise.resolve(testCase.backupPath));
+        backup.createSubfolder = testCase.createSubfolder;
+        await backup.loadBackupPath();
+        expect(backup.backupBasePath).toBe(testCase.expectedBackupPath);
+        expect(backup.backupBasePath).not.toBe(testPath.joplinProfile);
+
+        if (testCase.expectedBackupPathExist !== null) {
+          expect(fs.existsSync(backup.backupBasePath)).toBe(
+            testCase.expectedBackupPathExist
+          );
+        }
 
-      expect(backup.log.error).toHaveBeenCalledTimes(0);
-      expect(backup.log.warn).toHaveBeenCalledTimes(0);
+        expect(backup.log.error).toHaveBeenCalledTimes(0);
+        expect(backup.log.warn).toHaveBeenCalledTimes(0);
+      }
     });
 
     it(`relative paths`, async () => {

package/__test__/sevenZip.test.ts

@@ -32,7 +32,9 @@ describe("Test sevenZip", function () {
     expect(fs.existsSync(file3)).toBe(true);
     expect(fs.existsSync(zip)).toBe(false);
 
-    expect(await sevenZip.add(zip, testBaseDir + "\\*", "secret")).toBe(true);
+    expect(await sevenZip.add(zip, path.join(testBaseDir, "*"), "secret")).toBe(
+      true
+    );
     expect(fs.existsSync(zip)).toBe(true);
 
     expect(await sevenZip.passwordProtected(zip)).toBe(true);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "joplin-plugin-backup",
-  "version": "1.0.5",
+  "version": "1.1.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.0.5",
+	"version": "1.1.0",
 	"name": "Simple Backup",
 	"description": "Plugin to create manual and automatic backups.",
 	"author": "JackGruber",
@@ -16,6 +16,6 @@
 		"7zip",
 		"encrypted"
 	],
-	"_publish_hash": "sha256:afa40d7e0ed66a962aab6cbb7a01401cced7e165c4eddec4f1bbbe13ea96187e",
-	"_publish_commit": "master:2c035a3d426785deeaacc1948a2469d0824e0c25"
+	"_publish_hash": "sha256:8d8c6a3bb92fafc587269aea58b623b05242d42c0766a05bbe25c3ba2bbdf8ee",
+	"_publish_commit": "master:00ed52133c659e0f3ac1a55f70b776c42fca0a6d"
 }

package/.ENV

@@ -1 +0,0 @@
-GITHUB_TOKEN=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