Merge pull request #10 from CodeLit/development

Development

README.md

@@ -47,22 +47,34 @@ docker-compose up
 ## Advanced configuration
 
 You can also exclude files and folders from backup. Use **filter** option
-with [predefined patterns](https://www.npmjs.com/package/maximatch).
+with [patterns](https://www.npmjs.com/package/maximatch).
 
-```js
-const backup_config_json = {
+Example of backups-config.json:
+
+```json
+{
    "type": "local-storage",
+   "copies": {
+      "daily": 1
+   },
    "filter": [
-      "/node_modules/**", // exclude node_modules folder recursively
-      "!**/*.bin", // exclude .bin files from filter
-      "/data/logs/**",
-      "/package.lock",
-      "/(?<=\\/).*(\n?=\\.log)/", // filtering .log files using regular expression
-      "**" // exclude all files
+      "node_modules/**",
+      "**/*.log",
+      "data/folder/*",
+      "package.lock",
+      "**/*_fileending.*"
    ]
 }
 ```
 
+Options above is:
+
+- Exclude files inside **node_modules** folder recursively
+- Exclude all **.log** files recursively
+- Exclude all inside **data/folder** not-recursively
+- Exclude **package.lock**
+- Exclude files recursively by ending **_fileending**
+
 ## Mega Online Cloud storage integration
 
 [Link to official mega website](https://mega.nz/)
@@ -75,10 +87,7 @@ Config example:
   "email": "email-name@mail.me",
   "password": "!test24passWord",
   "copies": {
-    "daily": 1,
-    "weekly": 1,
-    "monthly": 1,
-    "annually": 1
+    "daily": 1
   }
 }
 ```

src/backups.js

@@ -37,6 +37,13 @@ async function handeBackup(
 
   // https://www.npmjs.com/package/maximatch
   backup.filter = backupJsonData.filter || [];
+
+  // Add ! at the beginning of each pattern to exclude it
+  backup.filter = backup.filter.map((element) => '!' + element);
+
+  // Adding ** at the beginning of filter to match all files recursively
+  backup.filter.unshift('**');
+
   if (backupJsonData.copies.daily)
     await backup.daily(backupJsonData.copies.daily);
   if (backupJsonData.copies.weekly)

tests/projects/single-project/backups-config.json

@@ -7,8 +7,8 @@
     "annually": 1
   },
   "filter": [
-    "**",
-    "!**/*.jar",
-    "/(?<=\\/).*(\n?=\\.jar)/"
+    "**/*.bak",
+    "**/excluded_file.txt",
+    "excluded_folder/**"
   ]
 }

tests/projects/single-project/excluded_extension.bak

@@ -0,0 +1 @@
+Test file content.

tests/projects/single-project/excluded_file.txt

@@ -0,0 +1 @@
+Test file content.

tests/projects/single-project/excluded_folder/file_inside.txt

@@ -0,0 +1 @@
+Test file content

tests/projects/single-project/excluded_folder/subfolder_inside/file_inside.txt

@@ -0,0 +1 @@
+Test file content.

tests/projects/single-project/src/excluded_extension.bak

@@ -0,0 +1 @@
+Test file content.

tests/projects/single-project/src/excluded_file.txt

@@ -0,0 +1 @@
+Test file content.

tests/projects/test-project/backups-config.json

@@ -7,8 +7,9 @@
     "annually": 2
   },
   "filter": [
-    "**",
-    "!**/*.jar",
-    "/(?<=\\/).*(\n?=\\.jar)/"
+    "**/*.bak",
+    "*_filename.bkp",
+    "**/excluded_file.txt",
+    "excluded_folder/**"
   ]
 }

tests/projects/test-project/excluded_extension.bak

@@ -0,0 +1 @@
+Test file content.

tests/projects/test-project/excluded_file.txt

@@ -0,0 +1 @@
+Test file content.

tests/projects/test-project/excluded_folder/file_inside.txt

@@ -0,0 +1 @@
+Test file content.

tests/projects/test-project/excluded_folder/subfolder_inside/file_inside.txt

@@ -0,0 +1 @@
+Test file content.

tests/projects/test-project/src/excluded_extension.bak

@@ -0,0 +1 @@
+Test file content.

tests/projects/test-project/src/excluded_filename.bkp

@@ -0,0 +1 @@
+Test file content.