joplin-plugin-backup 0.5.3 → 1.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (18) hide show
  1. package/.ENV +1 -0
  2. package/.husky/pre-commit +4 -0
  3. package/.husky/pre-push +4 -0
  4. package/.prettierignore +4 -0
  5. package/.prettierrc.json +16 -0
  6. package/.vscode/settings.json +4 -0
  7. package/README.md +90 -84
  8. package/__test__/backup.test.ts +838 -0
  9. package/__test__/help.test.ts +74 -0
  10. package/__test__/pw.test.ts +82 -0
  11. package/__test__/sevenZip.test.ts +102 -0
  12. package/__test__/sevenZipUpdateBinPath.test.ts +16 -0
  13. package/img/main.jpg +0 -0
  14. package/package.json +71 -33
  15. package/plugin.config.json +3 -3
  16. package/publish/io.github.jackgruber.backup.jpl +0 -0
  17. package/publish/io.github.jackgruber.backup.json +8 -5
  18. package/CHANGELOG.md +0 -54
package/.ENV ADDED
@@ -0,0 +1 @@
1
+ GITHUB_TOKEN=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
package/.husky/pre-commit ADDED
@@ -0,0 +1,4 @@
1
+ #!/bin/sh
2
+ . "$(dirname "$0")/_/husky.sh"
3
+
4
+ npx lint-staged
package/.husky/pre-push ADDED
@@ -0,0 +1,4 @@
1
+ #!/bin/sh
2
+ . "$(dirname "$0")/_/husky.sh"
3
+
4
+ npm test
package/.prettierignore ADDED
@@ -0,0 +1,4 @@
1
+ api/
2
+ dist/
3
+ publish/
4
+ webpack.config.js
package/.prettierrc.json ADDED
@@ -0,0 +1,16 @@
1
+ {
2
+ "trailingComma": "es5",
3
+ "tabWidth": 2,
4
+ "semi": true,
5
+ "singleQuote": false,
6
+ "endOfLine": "auto",
7
+ "overrides": [
8
+ {
9
+ "files": ["tsconfig.json"],
10
+ "options": {
11
+ "tabWidth": 4,
12
+ "useTabs": true
13
+ }
14
+ }
15
+ ]
16
+ }
package/.vscode/settings.json ADDED
@@ -0,0 +1,4 @@
1
+ {
2
+ "files.insertFinalNewline": true,
3
+ "editor.tabSize": 2
4
+ }
package/README.md CHANGED
@@ -1,84 +1,90 @@
1
- # Joplin Backup Plugin
2
-
3
- A plugin to extend Joplin with a manual and automatic backup function.
4
-
5
- <img src=img/main.jpg>
6
-
7
- ## Installation
8
-
9
- ### Automatic
10
-
11
- - Go to `Tools > Options > Plugins`
12
- - Search for `Simple Backup`
13
- - Click Install plugin
14
- - Restart Joplin to enable the plugin
15
-
16
- ### Manual
17
-
18
- - Download the latest released JPL package (`io.github.jackgruber.backup.jpl`) from [here](https://github.com/JackGruber/joplin-plugin-backup/releases/latest)
19
- - Close Joplin
20
- - Copy the downloaded JPL package in your profile `plugins` folder
21
- - Start Joplin
22
-
23
- ## Usage
24
-
25
- First configure the Plugin under `Tools > Options > Backup`!
26
-
27
- Backups can be created manually with the command `Tools > Create Backup` or are created automatically based on the configured interval.
28
- The backup started manually by `Create Backup` respects all the settings except for the `Backups interval in hours`.
29
-
30
- ## Options
31
-
32
- Go to `Tools > Options > Backup`
33
-
34
- | Option | Description | Default |
35
- | --- | --- | --- |
36
- | `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! | |
37
- | `Single JEX` | Create only one JEX file for all notebooks | `false` |
38
- | `Keep x Backups` | How many backups should be kept | `1` |
39
- | `Backups interval in hours` | Create a backup every X hours | `24` |
40
- | `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` |
41
- | `Logfile` | Loglevel for backup.log | `error` |
42
-
43
- ## Keyboard Shortcuts
44
-
45
- Under `Options > Keyboard Shortcuts` you can assign a keyboard shortcut for the following commands:
46
-
47
- - `Create Backup`
48
-
49
- ## What is backuped
50
-
51
- - Notebooks as JEX export (empty notbooks are not backed up)
52
- - The `settings.json` (Joplin settings)
53
- - The `keymap-desktop.json` (Keyboard Shortcuts)
54
- - The `userchrome.css` (Your Joplin Customization)
55
- - The `userstyle.css` (Your Joplin Customization)
56
- - The `templates` folder (Note templates)
57
-
58
- ## Restore
59
-
60
- ### Settings
61
-
62
- To restore the Settings, copy the desired files from `<Backup Path>\Profile` to the Joplin directory `.config\joplin-desktop`.
63
- The exact path can be found in Joplin under `Tools > Options > Generla`:
64
-
65
- <img src=img/joplin_path_in_gui.jpg>
66
-
67
- ### Notes
68
-
69
- The notes are imported via `File > Import > JEX - Joplin Export File`.
70
- > Individual notes cannot be restored from the JEX file!
71
-
72
- The notes are imported additionally, no check for duplicates is performed.
73
- If the folder in which the note was located already exists in you Joplin, than the folder name is extended by one (1).
74
-
75
- ## Changelog
76
-
77
- See [CHANGELOG.md](CHANGELOG.md)
78
-
79
- ## Links
80
-
81
- - [Joplin - Getting started with plugin development](https://joplinapp.org/api/get_started/plugins/)
82
- - [Joplin - Plugin API reference](https://joplinapp.org/api/references/plugin_api/classes/joplin.html)
83
- - [Joplin - Data API reference](https://joplinapp.org/api/references/rest_api/)
84
- - [Joplin - Plugin examples](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins)
1
+ # Joplin Backup Plugin
2
+
3
+ A plugin to extend Joplin with a manual and automatic backup function.
4
+
5
+ <img src=img/main.jpg>
6
+
7
+ ## Installation
8
+
9
+ ### Automatic
10
+
11
+ - Go to `Tools > Options > Plugins`
12
+ - Search for `Simple Backup`
13
+ - Click Install plugin
14
+ - Restart Joplin to enable the plugin
15
+
16
+ ### Manual
17
+
18
+ - Download the latest released JPL package (`io.github.jackgruber.backup.jpl`) from [here](https://github.com/JackGruber/joplin-plugin-backup/releases/latest)
19
+ - Close Joplin
20
+ - Copy the downloaded JPL package in your profile `plugins` folder
21
+ - Start Joplin
22
+
23
+ ## Usage
24
+
25
+ First configure the Plugin under `Tools > Options > Backup`!
26
+
27
+ Backups can be created manually with the command `Tools > Create backup` or are created automatically based on the configured interval.
28
+ The backup started manually by `Create backup` respects all the settings except for the `Backups interval in hours`.
29
+
30
+ ## Options
31
+
32
+ Go to `Tools > Options > Backup`
33
+
34
+ | Option | Description | Default |
35
+ | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------- |
36
+ | `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! | |
37
+ | `Single JEX` | Create only one JEX file for all notebooks | `false` |
38
+ | `Keep x backups` | How many backups should be kept | `1` |
39
+ | `Backups interval in hours` | Create a backup every X hours | `24` |
40
+ | `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` |
41
+ | `Password protected backups` | Protect the backups via encrypted Zip archive. | `false` |
42
+ | `Logfile` | Loglevel for backup.log | `error` |
43
+ | `Create zip archive` | Save backup data in a Zip archive | `No` |
44
+ | `Zip compression Level` | Compression level for zip archive archive | `Copy (no compression)` |
45
+ | `Temporary export path` | The data is first exported into this path before it is copied to the backup `Backup path`. | `` |
46
+ | `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}` |
47
+
48
+ ## Keyboard Shortcuts
49
+
50
+ Under `Options > Keyboard Shortcuts` you can assign a keyboard shortcut for the following commands:
51
+
52
+ - `Create backup`
53
+
54
+ ## What is backed up
55
+
56
+ - Notebooks as JEX export (Empty notebooks are not backed up)
57
+ - The `settings.json` (Joplin settings)
58
+ - The `keymap-desktop.json` (Keyboard shortcuts)
59
+ - The `userchrome.css` (Your Joplin customization)
60
+ - The `userstyle.css` (Your Joplin customization)
61
+ - The `templates` folder (Note templates)
62
+
63
+ ## Restore
64
+
65
+ ### Settings
66
+
67
+ To restore the Settings, copy the desired files from `<Backup Path>\Profile` to the Joplin directory `.config\joplin-desktop`.
68
+ The exact path can be found in Joplin under `Tools > Options > Generla`:
69
+
70
+ <img src=img/joplin_path_in_gui.jpg>
71
+
72
+ ### Notes
73
+
74
+ The notes are imported via `File > Import > JEX - Joplin Export File`.
75
+
76
+ > Individual notes cannot be restored from the JEX file!
77
+
78
+ The notes are imported additionally, no check for duplicates is performed.
79
+ If the folder in which the note was located already exists in you Joplin, than the folder name is extended by one (1).
80
+
81
+ ## Changelog
82
+
83
+ See [CHANGELOG.md](CHANGELOG.md)
84
+
85
+ ## Links
86
+
87
+ - [Joplin - Getting started with plugin development](https://joplinapp.org/api/get_started/plugins/)
88
+ - [Joplin - Plugin API reference](https://joplinapp.org/api/references/plugin_api/classes/joplin.html)
89
+ - [Joplin - Data API reference](https://joplinapp.org/api/references/rest_api/)
90
+ - [Joplin - Plugin examples](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins)