flat-cache - npm Package Compare versions

Comparing version 4.0.0 to 4.0.1

changelog.md

@@ -0,328 +1,278 @@
+# flat-cache - Changelog
 
-# flat-cache - Changelog
 ## v3.0.4
+
 - **Refactoring**
-  - add files by name to the list of exported files - [89a2698]( https://github.com/royriojas/flat-cache/commit/89a2698 ), [Roy Riojas](https://github.com/Roy Riojas), 08/11/2020 02:35:39
+  - add files by name to the list of exported files - [89a2698](https://github.com/royriojas/flat-cache/commit/89a2698), [Roy Riojas](https://github.com/Roy Riojas), 08/11/2020 02:35:39
 
-    
 ## v3.0.3
+
 - **Bug Fixes**
-  - Fix wrong eslint command - [f268e42]( https://github.com/royriojas/flat-cache/commit/f268e42 ), [Roy Riojas](https://github.com/Roy Riojas), 08/11/2020 02:15:04
+  - Fix wrong eslint command - [f268e42](https://github.com/royriojas/flat-cache/commit/f268e42), [Roy Riojas](https://github.com/Roy Riojas), 08/11/2020 02:15:04
 
-    
 ## v3.0.2
+
 - **Refactoring**
-  - Update the files paths - [6983a80]( https://github.com/royriojas/flat-cache/commit/6983a80 ), [Roy Riojas](https://github.com/Roy Riojas), 08/11/2020 01:58:39
 
-    
-  - Move code to src/ - [18ed6e8]( https://github.com/royriojas/flat-cache/commit/18ed6e8 ), [Roy Riojas](https://github.com/Roy Riojas), 08/11/2020 01:57:17
+  - Update the files paths - [6983a80](https://github.com/royriojas/flat-cache/commit/6983a80), [Roy Riojas](https://github.com/Roy Riojas), 08/11/2020 01:58:39
+  - Move code to src/ - [18ed6e8](https://github.com/royriojas/flat-cache/commit/18ed6e8), [Roy Riojas](https://github.com/Roy Riojas), 08/11/2020 01:57:17
+  - Change eslint-cache location - [beed74c](https://github.com/royriojas/flat-cache/commit/beed74c), [Roy Riojas](https://github.com/Roy Riojas), 08/11/2020 01:48:32
 
-    
-  - Change eslint-cache location - [beed74c]( https://github.com/royriojas/flat-cache/commit/beed74c ), [Roy Riojas](https://github.com/Roy Riojas), 08/11/2020 01:48:32
+## v3.0.1
 
-    
-## v3.0.1
 - **Refactoring**
-  - Remove unused deps - [8c6d9dc]( https://github.com/royriojas/flat-cache/commit/8c6d9dc ), [Roy Riojas](https://github.com/Roy Riojas), 08/11/2020 01:43:29
+  - Remove unused deps - [8c6d9dc](https://github.com/royriojas/flat-cache/commit/8c6d9dc), [Roy Riojas](https://github.com/Roy Riojas), 08/11/2020 01:43:29
 
-    
 ## v3.0.0
+
 - **Refactoring**
-  - Fix engines - [52b824c]( https://github.com/royriojas/flat-cache/commit/52b824c ), [Roy Riojas](https://github.com/Roy Riojas), 08/11/2020 01:01:52
-
-    
+  - Fix engines - [52b824c](https://github.com/royriojas/flat-cache/commit/52b824c), [Roy Riojas](https://github.com/Roy Riojas), 08/11/2020 01:01:52
 - **Other changes**
-  - Replace write with combination of mkdir and writeFile ([#49](https://github.com/royriojas/flat-cache/issues/49)) - [ef48276]( https://github.com/royriojas/flat-cache/commit/ef48276 ), [Bogdan Chadkin](https://github.com/Bogdan Chadkin), 08/11/2020 00:17:15
 
+  - Replace write with combination of mkdir and writeFile ([#49](https://github.com/royriojas/flat-cache/issues/49)) - [ef48276](https://github.com/royriojas/flat-cache/commit/ef48276), [Bogdan Chadkin](https://github.com/Bogdan Chadkin), 08/11/2020 00:17:15
+
     Node v10 introduced a great "recursive" option for mkdir which allows to
     get rid from mkdirp package and easily rewrite "write" package usage
     with two function calls.
-    
+
     https://nodejs.org/api/fs.html#fs_fs_mkdir_path_options_callback
-  - Added a testcase for clearAll ([#48](https://github.com/royriojas/flat-cache/issues/48)) - [45b51ca]( https://github.com/royriojas/flat-cache/commit/45b51ca ), [Aaron Chen](https://github.com/Aaron Chen), 21/05/2020 08:40:03
 
-    
-  - requet node>=10 - [a5c482c]( https://github.com/royriojas/flat-cache/commit/a5c482c ), [yumetodo](https://github.com/yumetodo), 10/04/2020 23:14:53
+  - Added a testcase for clearAll ([#48](https://github.com/royriojas/flat-cache/issues/48)) - [45b51ca](https://github.com/royriojas/flat-cache/commit/45b51ca), [Aaron Chen](https://github.com/Aaron Chen), 21/05/2020 08:40:03
+  - requet node>=10 - [a5c482c](https://github.com/royriojas/flat-cache/commit/a5c482c), [yumetodo](https://github.com/yumetodo), 10/04/2020 23:14:53
 
     thanks @SuperITMan
-    
-  - Update README.md - [29fe40b]( https://github.com/royriojas/flat-cache/commit/29fe40b ), [Roy Riojas](https://github.com/Roy Riojas), 10/04/2020 20:08:05
 
-    
-  - reduce vulnerability to 1 - [e9db1b2]( https://github.com/royriojas/flat-cache/commit/e9db1b2 ), [yumetodo](https://github.com/yumetodo), 30/03/2020 11:10:43
+  - Update README.md - [29fe40b](https://github.com/royriojas/flat-cache/commit/29fe40b), [Roy Riojas](https://github.com/Roy Riojas), 10/04/2020 20:08:05
+  - reduce vulnerability to 1 - [e9db1b2](https://github.com/royriojas/flat-cache/commit/e9db1b2), [yumetodo](https://github.com/yumetodo), 30/03/2020 11:10:43
+  - reduce vulnerabilities dependencies to 8 - [b58d196](https://github.com/royriojas/flat-cache/commit/b58d196), [yumetodo](https://github.com/yumetodo), 30/03/2020 10:54:56
+  - use prettier instead of esbeautifier - [03b1db7](https://github.com/royriojas/flat-cache/commit/03b1db7), [yumetodo](https://github.com/yumetodo), 30/03/2020 10:27:14
+  - update proxyquire - [c2f048d](https://github.com/royriojas/flat-cache/commit/c2f048d), [yumetodo](https://github.com/yumetodo), 30/03/2020 10:16:16
+  - update flatted and mocha - [a0e56da](https://github.com/royriojas/flat-cache/commit/a0e56da), [yumetodo](https://github.com/yumetodo), 30/03/2020 09:46:45
 
-    
-  - reduce vulnerabilities dependencies to 8 - [b58d196]( https://github.com/royriojas/flat-cache/commit/b58d196 ), [yumetodo](https://github.com/yumetodo), 30/03/2020 10:54:56
-
-    
-  - use prettier instead of esbeautifier - [03b1db7]( https://github.com/royriojas/flat-cache/commit/03b1db7 ), [yumetodo](https://github.com/yumetodo), 30/03/2020 10:27:14
-
-    
-  - update proxyquire - [c2f048d]( https://github.com/royriojas/flat-cache/commit/c2f048d ), [yumetodo](https://github.com/yumetodo), 30/03/2020 10:16:16
-
-    
-  - update flatted and mocha - [a0e56da]( https://github.com/royriojas/flat-cache/commit/a0e56da ), [yumetodo](https://github.com/yumetodo), 30/03/2020 09:46:45
-
     mocha > mkdirp is updated
     istanble >>> optimist > minimist is not updated
-    
-  - drop support node.js < 10 in develop - [beba691]( https://github.com/royriojas/flat-cache/commit/beba691 ), [yumetodo](https://github.com/yumetodo), 18/03/2020 01:31:09
 
+  - drop support node.js < 10 in develop - [beba691](https://github.com/royriojas/flat-cache/commit/beba691), [yumetodo](https://github.com/yumetodo), 18/03/2020 01:31:09
+
     see mkdirp
-    
-  - npm aufit fix(still remains) - [ce166cb]( https://github.com/royriojas/flat-cache/commit/ce166cb ), [yumetodo](https://github.com/yumetodo), 18/03/2020 01:18:08
 
+  - npm aufit fix(still remains) - [ce166cb](https://github.com/royriojas/flat-cache/commit/ce166cb), [yumetodo](https://github.com/yumetodo), 18/03/2020 01:18:08
+
     37 vulnerabilities required manual review and could not be updated
-    
-  - updtate sinon - [9f2d1b6]( https://github.com/royriojas/flat-cache/commit/9f2d1b6 ), [yumetodo](https://github.com/yumetodo), 18/03/2020 01:17:51
 
-    
-  - apply eslint-plugin-mocha - [07343b5]( https://github.com/royriojas/flat-cache/commit/07343b5 ), [yumetodo](https://github.com/yumetodo), 13/03/2020 22:17:21
+  - updtate sinon - [9f2d1b6](https://github.com/royriojas/flat-cache/commit/9f2d1b6), [yumetodo](https://github.com/yumetodo), 18/03/2020 01:17:51
+  - apply eslint-plugin-mocha - [07343b5](https://github.com/royriojas/flat-cache/commit/07343b5), [yumetodo](https://github.com/yumetodo), 13/03/2020 22:17:21
+  - Less strint version check ([#44](https://github.com/royriojas/flat-cache/issues/44)) - [92aca1c](https://github.com/royriojas/flat-cache/commit/92aca1c), [Wojciech Maj](https://github.com/Wojciech Maj), 13/11/2019 16:18:25
 
-    
-  - Less strint version check ([#44](https://github.com/royriojas/flat-cache/issues/44)) - [92aca1c]( https://github.com/royriojas/flat-cache/commit/92aca1c ), [Wojciech Maj](https://github.com/Wojciech Maj), 13/11/2019 16:18:25
+    - Use ^ version matching for production dependencies
+    - Run npm audit fix
 
-    * Use ^ version matching for production dependencies
-    
-    * Run npm audit fix
-    
 - **Bug Fixes**
-  - update dependencies and use eslint directly - [73fbed2]( https://github.com/royriojas/flat-cache/commit/73fbed2 ), [yumetodo](https://github.com/yumetodo), 18/03/2020 01:17:27
+  - update dependencies and use eslint directly - [73fbed2](https://github.com/royriojas/flat-cache/commit/73fbed2), [yumetodo](https://github.com/yumetodo), 18/03/2020 01:17:27
 
-    
 ## v2.0.1
+
 - **Refactoring**
-  - upgrade node modules to latest versions - [6402ed3]( https://github.com/royriojas/flat-cache/commit/6402ed3 ), [Roy Riojas](https://github.com/Roy Riojas), 08/01/2019 18:47:05
+  - upgrade node modules to latest versions - [6402ed3](https://github.com/royriojas/flat-cache/commit/6402ed3), [Roy Riojas](https://github.com/Roy Riojas), 08/01/2019 18:47:05
 
-    
 ## v2.0.0
+
 - **Bug Fixes**
-  - upgrade package.json lock file - [8d21c7b]( https://github.com/royriojas/flat-cache/commit/8d21c7b ), [Roy Riojas](https://github.com/Roy Riojas), 08/01/2019 17:03:13
 
-    
-  - Use the same versions of node_js that eslint use - [8d23379]( https://github.com/royriojas/flat-cache/commit/8d23379 ), [Roy Riojas](https://github.com/Roy Riojas), 08/01/2019 16:25:11
+  - upgrade package.json lock file - [8d21c7b](https://github.com/royriojas/flat-cache/commit/8d21c7b), [Roy Riojas](https://github.com/Roy Riojas), 08/01/2019 17:03:13
+  - Use the same versions of node_js that eslint use - [8d23379](https://github.com/royriojas/flat-cache/commit/8d23379), [Roy Riojas](https://github.com/Roy Riojas), 08/01/2019 16:25:11
 
-    
 - **Other changes**
-  - Replace circular-json with flatted ([#36](https://github.com/royriojas/flat-cache/issues/36)) - [b93aced]( https://github.com/royriojas/flat-cache/commit/b93aced ), [C. K. Tang](https://github.com/C. K. Tang), 08/01/2019 17:03:01
 
-    
-  - Change JSON parser from circular-json to flatted & 1 more changes ([#37](https://github.com/royriojas/flat-cache/issues/37)) - [745e65a]( https://github.com/royriojas/flat-cache/commit/745e65a ), [Andy Chen](https://github.com/Andy Chen), 08/01/2019 16:17:20
+  - Replace circular-json with flatted ([#36](https://github.com/royriojas/flat-cache/issues/36)) - [b93aced](https://github.com/royriojas/flat-cache/commit/b93aced), [C. K. Tang](https://github.com/C. K. Tang), 08/01/2019 17:03:01
+  - Change JSON parser from circular-json to flatted & 1 more changes ([#37](https://github.com/royriojas/flat-cache/issues/37)) - [745e65a](https://github.com/royriojas/flat-cache/commit/745e65a), [Andy Chen](https://github.com/Andy Chen), 08/01/2019 16:17:20
 
-    * Change JSON parser from circular-json to flatted & 1 more changes
-    
-    * Change JSON parser from circular-json
-    * Audited 2 vulnerabilities
-    
-    * Update package.json
-    
-    * Update Engine require
-    
-    * There's a bunch of dependencies in this pkg requires node >=4, so I changed it to 4
-    
-    * Remove and add node versions
-    
-    * I have seen this pkg is not available with node 0.12 so I removed it
-    * I have added a popular used LTS version of node - 10
-    
+    - Change JSON parser from circular-json to flatted & 1 more changes
+    - Change JSON parser from circular-json
+    - Audited 2 vulnerabilities
+    - Update package.json
+    - Update Engine require
+    - There's a bunch of dependencies in this pkg requires node >=4, so I changed it to 4
+    - Remove and add node versions
+    - I have seen this pkg is not available with node 0.12 so I removed it
+    - I have added a popular used LTS version of node - 10
+
 ## v1.3.4
+
 - **Refactoring**
-  - Add del.js and utils.js to the list of files to be beautified - [9d0ca9b]( https://github.com/royriojas/flat-cache/commit/9d0ca9b ), [Roy Riojas](https://github.com/Roy Riojas), 14/11/2018 12:19:02
+  - Add del.js and utils.js to the list of files to be beautified - [9d0ca9b](https://github.com/royriojas/flat-cache/commit/9d0ca9b), [Roy Riojas](https://github.com/Roy Riojas), 14/11/2018 12:19:02
 
-    
 ## v1.3.3
+
 - **Refactoring**
-  - Make sure package-lock.json is up to date - [a7d2598]( https://github.com/royriojas/flat-cache/commit/a7d2598 ), [Roy Riojas](https://github.com/Roy Riojas), 14/11/2018 11:36:08
-
-    
+  - Make sure package-lock.json is up to date - [a7d2598](https://github.com/royriojas/flat-cache/commit/a7d2598), [Roy Riojas](https://github.com/Roy Riojas), 14/11/2018 11:36:08
 - **Other changes**
-  - Removed the need for del ([#33](https://github.com/royriojas/flat-cache/issues/33)) - [c429012]( https://github.com/royriojas/flat-cache/commit/c429012 ), [S. Gilroy](https://github.com/S. Gilroy), 13/11/2018 13:56:37
 
-    * Removed the need for del
-    
+  - Removed the need for del ([#33](https://github.com/royriojas/flat-cache/issues/33)) - [c429012](https://github.com/royriojas/flat-cache/commit/c429012), [S. Gilroy](https://github.com/S. Gilroy), 13/11/2018 13:56:37
+
+    - Removed the need for del
+
     Removed the need for del as newer versions have broken backwards
     compatibility. del mainly uses rimraf for deleting folders
     and files, replaceing it with rimraf only is a minimal change.
-    
-    * Disable glob on rimraf calls
-    
-    * Added glob disable to wrong call
-    
-    * Wrapped rimraf to simplify solution
-    
+
+    - Disable glob on rimraf calls
+    - Added glob disable to wrong call
+    - Wrapped rimraf to simplify solution
+
 ## v1.3.2
+
 - **Refactoring**
-  - remove yarn.lock file - [704c6c4]( https://github.com/royriojas/flat-cache/commit/704c6c4 ), [Roy Riojas](https://github.com/Roy Riojas), 07/11/2018 15:41:08
-
-    
+  - remove yarn.lock file - [704c6c4](https://github.com/royriojas/flat-cache/commit/704c6c4), [Roy Riojas](https://github.com/Roy Riojas), 07/11/2018 15:41:08
 - **Other changes**
-  - replace circular-json with flatted ([#23](https://github.com/royriojas/flat-cache/issues/23))" - [db12d74]( https://github.com/royriojas/flat-cache/commit/db12d74 ), [Roy Riojas](https://github.com/Roy Riojas), 07/11/2018 15:40:39
 
+  - replace circular-json with flatted ([#23](https://github.com/royriojas/flat-cache/issues/23))" - [db12d74](https://github.com/royriojas/flat-cache/commit/db12d74), [Roy Riojas](https://github.com/Roy Riojas), 07/11/2018 15:40:39
+
     This reverts commit 00f689277a75e85fef28e6a048fad227afc525e6.
-    
+
 ## v1.3.1
+
 - **Refactoring**
-  - upgrade deps to remove some security warnings - [f405719]( https://github.com/royriojas/flat-cache/commit/f405719 ), [Roy Riojas](https://github.com/Roy Riojas), 06/11/2018 12:07:31
-
-    
+  - upgrade deps to remove some security warnings - [f405719](https://github.com/royriojas/flat-cache/commit/f405719), [Roy Riojas](https://github.com/Roy Riojas), 06/11/2018 12:07:31
 - **Bug Fixes**
-  - replace circular-json with flatted ([#23](https://github.com/royriojas/flat-cache/issues/23)) - [00f6892]( https://github.com/royriojas/flat-cache/commit/00f6892 ), [Terry](https://github.com/Terry), 05/11/2018 18:44:16
-
-    
+  - replace circular-json with flatted ([#23](https://github.com/royriojas/flat-cache/issues/23)) - [00f6892](https://github.com/royriojas/flat-cache/commit/00f6892), [Terry](https://github.com/Terry), 05/11/2018 18:44:16
 - **Other changes**
-  - update del to v3.0.0 ([#26](https://github.com/royriojas/flat-cache/issues/26)) - [d42883f]( https://github.com/royriojas/flat-cache/commit/d42883f ), [Patrick Silva](https://github.com/Patrick Silva), 03/11/2018 01:00:44
 
+  - update del to v3.0.0 ([#26](https://github.com/royriojas/flat-cache/issues/26)) - [d42883f](https://github.com/royriojas/flat-cache/commit/d42883f), [Patrick Silva](https://github.com/Patrick Silva), 03/11/2018 01:00:44
+
     Closes <a target="_blank" class="info-link" href="https://github.com/royriojas/flat-cache/issues/25"><span>#25</span></a>
+
 ## v1.3.0
+
 - **Other changes**
-  - Added #all method ([#16](https://github.com/royriojas/flat-cache/issues/16)) - [12293be]( https://github.com/royriojas/flat-cache/commit/12293be ), [Ozair Patel](https://github.com/Ozair Patel), 25/09/2017 14:46:38
 
-    * Added #all method
-    
-    * Added #all method test
-    
-    * Updated readme
-    
-    * Added yarn.lock
-    
-    * Added more keys for #all test
-    
-    * Beautified file
-    
-  - fix changelog title style ([#14](https://github.com/royriojas/flat-cache/issues/14)) - [af8338a]( https://github.com/royriojas/flat-cache/commit/af8338a ), [前端小武](https://github.com/前端小武), 19/12/2016 20:34:48
+  - Added #all method ([#16](https://github.com/royriojas/flat-cache/issues/16)) - [12293be](https://github.com/royriojas/flat-cache/commit/12293be), [Ozair Patel](https://github.com/Ozair Patel), 25/09/2017 14:46:38
 
-    
+    - Added #all method
+    - Added #all method test
+    - Updated readme
+    - Added yarn.lock
+    - Added more keys for #all test
+    - Beautified file
+
+  - fix changelog title style ([#14](https://github.com/royriojas/flat-cache/issues/14)) - [af8338a](https://github.com/royriojas/flat-cache/commit/af8338a), [前端小武](https://github.com/前端小武), 19/12/2016 20:34:48
+
 ## v1.2.2
+
 - **Bug Fixes**
-  - Do not crash if cache file is invalid JSON. ([#13](https://github.com/royriojas/flat-cache/issues/13)) - [87beaa6]( https://github.com/royriojas/flat-cache/commit/87beaa6 ), [Roy Riojas](https://github.com/Roy Riojas), 19/12/2016 18:03:35
 
+  - Do not crash if cache file is invalid JSON. ([#13](https://github.com/royriojas/flat-cache/issues/13)) - [87beaa6](https://github.com/royriojas/flat-cache/commit/87beaa6), [Roy Riojas](https://github.com/Roy Riojas), 19/12/2016 18:03:35
+
     Fixes <a target="_blank" class="info-link" href="https://github.com/royriojas/flat-cache/issues/12"><span>#12</span></a>
-    
+
     Not sure under which situations a cache file might exist that does
     not contain a valid JSON structure, but just in case to cover
     the possibility of this happening a try catch block has been added
-    
+
     If the cache is somehow not valid the cache will be discarded an a
     a new cache will be stored instead
+
 - **Other changes**
-  - Added travis ci support for modern node versions ([#11](https://github.com/royriojas/flat-cache/issues/11)) - [1c2b1f7]( https://github.com/royriojas/flat-cache/commit/1c2b1f7 ), [Amila Welihinda](https://github.com/Amila Welihinda), 10/11/2016 23:47:52
 
-    
-  - Bumping `circular-son` version ([#10](https://github.com/royriojas/flat-cache/issues/10)) - [4d5e861]( https://github.com/royriojas/flat-cache/commit/4d5e861 ), [Andrea Giammarchi](https://github.com/Andrea Giammarchi), 02/08/2016 07:13:52
+  - Added travis ci support for modern node versions ([#11](https://github.com/royriojas/flat-cache/issues/11)) - [1c2b1f7](https://github.com/royriojas/flat-cache/commit/1c2b1f7), [Amila Welihinda](https://github.com/Amila Welihinda), 10/11/2016 23:47:52
+  - Bumping `circular-son` version ([#10](https://github.com/royriojas/flat-cache/issues/10)) - [4d5e861](https://github.com/royriojas/flat-cache/commit/4d5e861), [Andrea Giammarchi](https://github.com/Andrea Giammarchi), 02/08/2016 07:13:52
 
     As mentioned in https://github.com/WebReflection/circular-json/issues/25 `circular-json` wan't rightly implementing the license field.
-    
+
     Latest version bump changed only that bit so that ESLint should now be happy.
+
 ## v1.2.1
+
 - **Bug Fixes**
-  - Add missing utils.js file to the package. closes [#8](https://github.com/royriojas/flat-cache/issues/8) - [ec10cf2]( https://github.com/royriojas/flat-cache/commit/ec10cf2 ), [Roy Riojas](https://github.com/Roy Riojas), 01/08/2016 02:18:57
+  - Add missing utils.js file to the package. closes [#8](https://github.com/royriojas/flat-cache/issues/8) - [ec10cf2](https://github.com/royriojas/flat-cache/commit/ec10cf2), [Roy Riojas](https://github.com/Roy Riojas), 01/08/2016 02:18:57
 
-    
 ## v1.2.0
+
 - **Documentation**
-  - Add documentation about noPrune option - [23e11f9]( https://github.com/royriojas/flat-cache/commit/23e11f9 ), [Roy Riojas](https://github.com/Roy Riojas), 01/08/2016 02:06:49
+  - Add documentation about noPrune option - [23e11f9](https://github.com/royriojas/flat-cache/commit/23e11f9), [Roy Riojas](https://github.com/Roy Riojas), 01/08/2016 02:06:49
 
-    
 ## v1.0.11
+
 - **Features**
-  - Add noPrune option to cache.save() method. closes [#7](https://github.com/royriojas/flat-cache/issues/7) - [2c8016a]( https://github.com/royriojas/flat-cache/commit/2c8016a ), [Roy Riojas](https://github.com/Roy Riojas), 01/08/2016 02:00:29
 
-    
-  - Add json read and write utility based on circular-json - [c31081e]( https://github.com/royriojas/flat-cache/commit/c31081e ), [Jean Ponchon](https://github.com/Jean Ponchon), 28/07/2016 08:58:17
+  - Add noPrune option to cache.save() method. closes [#7](https://github.com/royriojas/flat-cache/issues/7) - [2c8016a](https://github.com/royriojas/flat-cache/commit/2c8016a), [Roy Riojas](https://github.com/Roy Riojas), 01/08/2016 02:00:29
+  - Add json read and write utility based on circular-json - [c31081e](https://github.com/royriojas/flat-cache/commit/c31081e), [Jean Ponchon](https://github.com/Jean Ponchon), 28/07/2016 08:58:17
 
-    
 - **Bug Fixes**
-  - Remove UTF16 BOM stripping - [4a41e22]( https://github.com/royriojas/flat-cache/commit/4a41e22 ), [Jean Ponchon](https://github.com/Jean Ponchon), 29/07/2016 02:18:06
 
-    Since we control both writing and reading of JSON stream, there no needs 
+  - Remove UTF16 BOM stripping - [4a41e22](https://github.com/royriojas/flat-cache/commit/4a41e22), [Jean Ponchon](https://github.com/Jean Ponchon), 29/07/2016 02:18:06
+
+    Since we control both writing and reading of JSON stream, there no needs
     to handle unicode BOM.
-  - Use circular-json to handle circular references (fix [#5](https://github.com/royriojas/flat-cache/issues/5)) - [cd7aeed]( https://github.com/royriojas/flat-cache/commit/cd7aeed ), [Jean Ponchon](https://github.com/Jean Ponchon), 25/07/2016 11:11:59
 
-    
+  - Use circular-json to handle circular references (fix [#5](https://github.com/royriojas/flat-cache/issues/5)) - [cd7aeed](https://github.com/royriojas/flat-cache/commit/cd7aeed), [Jean Ponchon](https://github.com/Jean Ponchon), 25/07/2016 11:11:59
+
 - **Tests Related fixes**
-  - Add missing file from eslint test - [d6fa3c3]( https://github.com/royriojas/flat-cache/commit/d6fa3c3 ), [Jean Ponchon](https://github.com/Jean Ponchon), 29/07/2016 02:15:51
 
-    
-  - Add test for circular json serialization / deserialization - [07d2ddd]( https://github.com/royriojas/flat-cache/commit/07d2ddd ), [Jean Ponchon](https://github.com/Jean Ponchon), 28/07/2016 08:59:36
+  - Add missing file from eslint test - [d6fa3c3](https://github.com/royriojas/flat-cache/commit/d6fa3c3), [Jean Ponchon](https://github.com/Jean Ponchon), 29/07/2016 02:15:51
+  - Add test for circular json serialization / deserialization - [07d2ddd](https://github.com/royriojas/flat-cache/commit/07d2ddd), [Jean Ponchon](https://github.com/Jean Ponchon), 28/07/2016 08:59:36
 
-    
 - **Refactoring**
-  - Remove unused read-json-sync - [2be1c24]( https://github.com/royriojas/flat-cache/commit/2be1c24 ), [Jean Ponchon](https://github.com/Jean Ponchon), 28/07/2016 08:59:18
-
-    
+  - Remove unused read-json-sync - [2be1c24](https://github.com/royriojas/flat-cache/commit/2be1c24), [Jean Ponchon](https://github.com/Jean Ponchon), 28/07/2016 08:59:18
 - **Build Scripts Changes**
-  - travis tests on 0.12 and 4x - [3a613fd]( https://github.com/royriojas/flat-cache/commit/3a613fd ), [royriojas](https://github.com/royriojas), 15/11/2015 14:34:40
+  - travis tests on 0.12 and 4x - [3a613fd](https://github.com/royriojas/flat-cache/commit/3a613fd), [royriojas](https://github.com/royriojas), 15/11/2015 14:34:40
 
-    
 ## v1.0.10
+
 - **Build Scripts Changes**
-  - add eslint-fix task - [fd29e52]( https://github.com/royriojas/flat-cache/commit/fd29e52 ), [royriojas](https://github.com/royriojas), 01/11/2015 15:04:08
 
-    
-  - make sure the test script also verify beautification and linting of files before running tests - [e94e176]( https://github.com/royriojas/flat-cache/commit/e94e176 ), [royriojas](https://github.com/royriojas), 01/11/2015 11:54:48
+  - add eslint-fix task - [fd29e52](https://github.com/royriojas/flat-cache/commit/fd29e52), [royriojas](https://github.com/royriojas), 01/11/2015 15:04:08
+  - make sure the test script also verify beautification and linting of files before running tests - [e94e176](https://github.com/royriojas/flat-cache/commit/e94e176), [royriojas](https://github.com/royriojas), 01/11/2015 11:54:48
 
-    
 - **Other changes**
-  - add clearAll for cacheDir - [97383d9]( https://github.com/royriojas/flat-cache/commit/97383d9 ), [xieyaowu](https://github.com/xieyaowu), 31/10/2015 21:02:18
+  - add clearAll for cacheDir - [97383d9](https://github.com/royriojas/flat-cache/commit/97383d9), [xieyaowu](https://github.com/xieyaowu), 31/10/2015 21:02:18
 
-    
 ## v1.0.9
+
 - **Bug Fixes**
-  - wrong default values for changelogx user repo name - [7bb52d1]( https://github.com/royriojas/flat-cache/commit/7bb52d1 ), [royriojas](https://github.com/royriojas), 11/09/2015 15:59:30
+  - wrong default values for changelogx user repo name - [7bb52d1](https://github.com/royriojas/flat-cache/commit/7bb52d1), [royriojas](https://github.com/royriojas), 11/09/2015 15:59:30
 
-    
 ## v1.0.8
+
 - **Build Scripts Changes**
-  - test against node 4 - [c395b66]( https://github.com/royriojas/flat-cache/commit/c395b66 ), [royriojas](https://github.com/royriojas), 11/09/2015 15:51:39
+  - test against node 4 - [c395b66](https://github.com/royriojas/flat-cache/commit/c395b66), [royriojas](https://github.com/royriojas), 11/09/2015 15:51:39
 
-    
 ## v1.0.7
+
 - **Other changes**
-  - Move dependencies into devDep - [7e47099]( https://github.com/royriojas/flat-cache/commit/7e47099 ), [Bogdan Chadkin](https://github.com/Bogdan Chadkin), 11/09/2015 15:10:57
-
-    
+  - Move dependencies into devDep - [7e47099](https://github.com/royriojas/flat-cache/commit/7e47099), [Bogdan Chadkin](https://github.com/Bogdan Chadkin), 11/09/2015 15:10:57
 - **Documentation**
-  - Add missing changelog link - [f51197a]( https://github.com/royriojas/flat-cache/commit/f51197a ), [royriojas](https://github.com/royriojas), 11/09/2015 14:48:05
+  - Add missing changelog link - [f51197a](https://github.com/royriojas/flat-cache/commit/f51197a), [royriojas](https://github.com/royriojas), 11/09/2015 14:48:05
 
-    
 ## v1.0.6
+
 - **Build Scripts Changes**
-  - Add helpers/code check scripts - [bdb82f3]( https://github.com/royriojas/flat-cache/commit/bdb82f3 ), [royriojas](https://github.com/royriojas), 11/09/2015 14:44:31
+  - Add helpers/code check scripts - [bdb82f3](https://github.com/royriojas/flat-cache/commit/bdb82f3), [royriojas](https://github.com/royriojas), 11/09/2015 14:44:31
 
-    
 ## v1.0.5
+
 - **Documentation**
-  - better description for the module - [436817f]( https://github.com/royriojas/flat-cache/commit/436817f ), [royriojas](https://github.com/royriojas), 11/09/2015 14:35:33
-
-    
+  - better description for the module - [436817f](https://github.com/royriojas/flat-cache/commit/436817f), [royriojas](https://github.com/royriojas), 11/09/2015 14:35:33
 - **Other changes**
-  - Update dependencies - [be88aa3]( https://github.com/royriojas/flat-cache/commit/be88aa3 ), [Bogdan Chadkin](https://github.com/Bogdan Chadkin), 11/09/2015 13:47:41
+  - Update dependencies - [be88aa3](https://github.com/royriojas/flat-cache/commit/be88aa3), [Bogdan Chadkin](https://github.com/Bogdan Chadkin), 11/09/2015 13:47:41
 
-    
 ## v1.0.4
+
 - **Refactoring**
-  - load a cache file using the full filepath - [b8f68c2]( https://github.com/royriojas/flat-cache/commit/b8f68c2 ), [Roy Riojas](https://github.com/Roy Riojas), 30/08/2015 04:19:14
-
-    
+  - load a cache file using the full filepath - [b8f68c2](https://github.com/royriojas/flat-cache/commit/b8f68c2), [Roy Riojas](https://github.com/Roy Riojas), 30/08/2015 04:19:14
 - **Documentation**
-  - Add documentation about `clearAll` and `clearCacheById` - [13947c1]( https://github.com/royriojas/flat-cache/commit/13947c1 ), [Roy Riojas](https://github.com/Roy Riojas), 01/03/2015 23:44:05
-
-    
+  - Add documentation about `clearAll` and `clearCacheById` - [13947c1](https://github.com/royriojas/flat-cache/commit/13947c1), [Roy Riojas](https://github.com/Roy Riojas), 01/03/2015 23:44:05
 - **Features**
-  - Add methods to remove the cache documents created - [af40443]( https://github.com/royriojas/flat-cache/commit/af40443 ), [Roy Riojas](https://github.com/Roy Riojas), 01/03/2015 23:39:27
+  - Add methods to remove the cache documents created - [af40443](https://github.com/royriojas/flat-cache/commit/af40443), [Roy Riojas](https://github.com/Roy Riojas), 01/03/2015 23:39:27
 
-    
 ## v1.0.1
+
 - **Other changes**
-  - Update README.md - [c2b6805]( https://github.com/royriojas/flat-cache/commit/c2b6805 ), [Roy Riojas](https://github.com/Roy Riojas), 26/02/2015 04:28:07
+  - Update README.md - [c2b6805](https://github.com/royriojas/flat-cache/commit/c2b6805), [Roy Riojas](https://github.com/Roy Riojas), 26/02/2015 04:28:07
 
-    
 ## v1.0.0
+
 - **Refactoring**
-  - flat-cache v.1.0.0 - [c984274]( https://github.com/royriojas/flat-cache/commit/c984274 ), [Roy Riojas](https://github.com/Roy Riojas), 26/02/2015 04:11:50
-
-    
+  - flat-cache v.1.0.0 - [c984274](https://github.com/royriojas/flat-cache/commit/c984274), [Roy Riojas](https://github.com/Roy Riojas), 26/02/2015 04:11:50
 - **Other changes**
-  - Initial commit - [d43cccf]( https://github.com/royriojas/flat-cache/commit/d43cccf ), [Roy Riojas](https://github.com/Roy Riojas), 26/02/2015 01:12:16
-
-    
+  - Initial commit - [d43cccf](https://github.com/royriojas/flat-cache/commit/d43cccf), [Roy Riojas](https://github.com/Roy Riojas), 26/02/2015 01:12:16

package.json

 {
   "name": "flat-cache",
-  "version": "4.0.0",
+  "version": "4.0.1",
   "description": "A stupidly simple key/value storage using files to persist some data",
@@ -35,3 +35,4 @@ "repository": "jaredwray/flat-cache",
     "test:ci:cache": "c8 --reporter=lcov mocha -R spec test/specs",
-    "test": "npm run verify --silent"
+    "test": "npm run verify --silent",
+    "format": "prettier --write ."
   },
@@ -47,3 +48,3 @@ "keywords": [
   "devDependencies": {
-    "c8": "^8.0.1",
+    "c8": "^9.1.0",
     "chai": "^4.3.10",
@@ -53,6 +54,7 @@ "eslint": "^8.56.0",
     "eslint-plugin-mocha": "^10.2.0",
-    "eslint-plugin-prettier": "^5.0.1",
     "glob-expand": "^0.2.1",
-    "mocha": "^10.2.0",
-    "prettier": "^3.1.1",
+    "mocha": "^10.3.0",
+    "prettier": "^3.2.4",
+    "rimraf": "^5.0.5",
+    "sinon": "^17.0.1",
     "write": "^2.0.0"
@@ -62,5 +64,4 @@ },
     "flatted": "^3.2.9",
-    "keyv": "^4.5.4",
-    "rimraf": "^5.0.5"
+    "keyv": "^4.5.4"
   }
 }

README.md

 # flat-cache
+
 > A stupidly simple key/value storage using files to persist the data
@@ -18,6 +19,6 @@
 ```js
-var flatCache = require('flat-cache')
+const flatCache = require('flat-cache');
 // loads the cache, if one does not exists for the given
 // Id a new one will be prepared to be created
-var cache = flatCache.load('cacheId');
+const cache = flatCache.load('cacheId');
 
@@ -28,6 +29,6 @@ // sets a key on the cache
 // get a key from the cache
-cache.getKey('key') // { foo: 'var' }
+cache.getKey('key'); // { foo: 'var' }
 
 // fetch the entire persisted object
-cache.all() // { 'key': { foo: 'var' } }
+cache.all(); // { 'key': { foo: 'var' } }
 
@@ -43,7 +44,7 @@ // remove a key
 // not exists for the given Id a new one will be prepared to be created
-var cache = flatCache.load('cacheId', path.resolve('./path/to/folder'));
+const cache = flatCache.load('cacheId', path.resolve('./path/to/folder'));
 
 // The following methods are useful to clear the cache
 // delete a given cache
-flatCache.clearCacheById('cacheId') // removes the cacheId document if one exists.
+flatCache.clearCacheById('cacheId'); // removes the cacheId document if one exists.
 
@@ -62,2 +63,3 @@ // delete all cache
 ## Important notes
+
 - If no directory is especified when the `load` method is called, a folder named `.cache` will be created
@@ -64,0 +66,0 @@ inside the module directory when `cache.save` is called. If you're committing your `node_modules` to any vcs, you

src/cache.js

@@ -1,9 +0,8 @@
-var path = require('path');
-var fs = require('fs');
-var Keyv = require('keyv');
-var utils = require('./utils');
-var del = require('./del');
-var writeJSON = utils.writeJSON;
+const path = require('path');
+const fs = require('fs');
+const Keyv = require('keyv');
+const { writeJSON, tryParse } = require('./utils');
+const { del } = require('./del');
 
-var cache = {
+const cache = {
   /**
@@ -19,4 +18,3 @@ * Load a cache identified by the given Id. If the element does not exists, then initialize an empty
   load: function (docId, cacheDir) {
-    var me = this;
-
+    const me = this;
     me.keyv = new Keyv();
@@ -26,6 +24,7 @@
     me.__persisted = {};
+
     me._pathToFile = cacheDir ? path.resolve(cacheDir, docId) : path.resolve(__dirname, '../.cache/', docId);
 
     if (fs.existsSync(me._pathToFile)) {
-      me._persisted = utils.tryParse(me._pathToFile, {});
+      me._persisted = tryParse(me._pathToFile, {});
     }
@@ -40,3 +39,2 @@ },
     this.__persisted = value;
-    this.keyv.set('persisted', value);
   },
@@ -50,3 +48,2 @@
     this.__visited = value;
-    this.keyv.set('visited', value);
   },
@@ -60,5 +57,5 @@
   loadFile: function (pathToFile) {
-    var me = this;
-    var dir = path.dirname(pathToFile);
-    var fName = path.basename(pathToFile);
+    const me = this;
+    const dir = path.dirname(pathToFile);
+    const fName = path.basename(pathToFile);
 
@@ -117,6 +114,6 @@ me.load(fName, dir);
   _prune: function () {
-    var me = this;
-    var obj = {};
+    const me = this;
+    const obj = {};
 
-    var keys = Object.keys(me._visited);
+    const keys = Object.keys(me._visited);
 
@@ -143,4 +140,3 @@ // no keys visited for either get or set value
   save: function (noPrune) {
-    var me = this;
-
+    const me = this;
     !noPrune && me._prune();
@@ -163,3 +159,3 @@ writeJSON(me._pathToFile, me._persisted);
   destroy: function () {
-    var me = this;
+    const me = this;
     me._visited = {};
@@ -195,3 +191,3 @@ me._persisted = {};
   create: function (docId, cacheDir) {
-    var obj = Object.create(cache);
+    const obj = Object.create(cache);
     obj.load(docId, cacheDir);
@@ -202,3 +198,3 @@ return obj;
   createFromFile: function (filePath) {
-    var obj = Object.create(cache);
+    const obj = Object.create(cache);
     obj.loadFile(filePath);
@@ -216,3 +212,3 @@ return obj;
   clearCacheById: function (docId, cacheDir) {
-    var filePath = cacheDir ? path.resolve(cacheDir, docId) : path.resolve(__dirname, '../.cache/', docId);
+    const filePath = cacheDir ? path.resolve(cacheDir, docId) : path.resolve(__dirname, '../.cache/', docId);
     return del(filePath);
@@ -226,5 +222,5 @@ },
   clearAll: function (cacheDir) {
-    var filePath = cacheDir ? path.resolve(cacheDir) : path.resolve(__dirname, '../.cache/');
+    const filePath = cacheDir ? path.resolve(cacheDir) : path.resolve(__dirname, '../.cache/');
     return del(filePath);
   },
 };

src/del.js

@@ -1,13 +0,30 @@
-var rimraf = require('rimraf').sync;
-var fs = require('fs');
+const fs = require('fs');
+const path = require('path');
 
-module.exports = function del(file) {
-  if (fs.existsSync(file)) {
-    //if rimraf doesn't throw then the file has been deleted or didn't exist
-    rimraf(file, {
-      glob: false,
-    });
+function del(targetPath) {
+  if (!fs.existsSync(targetPath)) {
+    return false;
+  }
+
+  try {
+    if (fs.statSync(targetPath).isDirectory()) {
+      // If it's a directory, delete its contents first
+      fs.readdirSync(targetPath).forEach(file => {
+        const curPath = path.join(targetPath, file);
+
+        if (fs.statSync(curPath).isFile()) {
+          fs.unlinkSync(curPath); // Delete file
+        }
+      });
+      fs.rmdirSync(targetPath); // Delete the now-empty directory
+    } else {
+      fs.unlinkSync(targetPath); // If it's a file, delete it directly
+    }
+
     return true;
+  } catch (error) {
+    console.error(`Error while deleting ${targetPath}: ${error.message}`);
   }
-  return false;
-};
+}
+
+module.exports = { del };

src/utils.js

@@ -1,44 +0,42 @@
-var fs = require('fs');
-var path = require('path');
-var flatted = require('flatted');
+const fs = require('fs');
+const path = require('path');
+const flatted = require('flatted');
 
-module.exports = {
-  tryParse: function (filePath, defaultValue) {
-    var result;
-    try {
-      result = this.readJSON(filePath);
-    } catch (ex) {
-      result = defaultValue;
-    }
-    return result;
-  },
+function tryParse(filePath, defaultValue) {
+  let result;
+  try {
+    result = readJSON(filePath);
+  } catch (ex) {
+    result = defaultValue;
+  }
+  return result;
+}
 
-  /**
-   * Read json file synchronously using flatted
-   *
-   * @method readJSON
-   * @param  {String} filePath Json filepath
-   * @returns {*} parse result
-   */
-  readJSON: function (filePath) {
-    return flatted.parse(
-      fs.readFileSync(filePath, {
-        encoding: 'utf8',
-      })
-    );
-  },
+/**
+ * Read json file synchronously using flatted
+ *
+ * @param  {String} filePath Json filepath
+ * @returns {*} parse result
+ */
+function readJSON(filePath) {
+  return flatted.parse(
+    fs.readFileSync(filePath, {
+      encoding: 'utf8',
+    })
+  );
+}
 
-  /**
-   * Write json file synchronously using circular-json
-   *
-   * @method writeJSON
-   * @param  {String} filePath Json filepath
-   * @param  {*} data Object to serialize
-   */
-  writeJSON: function (filePath, data) {
-    fs.mkdirSync(path.dirname(filePath), {
-      recursive: true,
-    });
-    fs.writeFileSync(filePath, flatted.stringify(data));
-  },
-};
+/**
+ * Write json file synchronously using circular-json
+ *
+ * @param  {String} filePath Json filepath
+ * @param  {*} data Object to serialize
+ */
+function writeJSON(filePath, data) {
+  fs.mkdirSync(path.dirname(filePath), {
+    recursive: true,
+  });
+  fs.writeFileSync(filePath, flatted.stringify(data));
+}
+
+module.exports = { tryParse, readJSON, writeJSON };

No alert changes

Improved metrics

Dependency count

2

decreased by-33.33%

Lines of code

254

increased by2.83%

Number of lines in readme file

78

increased by2.63%

Worsened metrics

Total package byte prevSize

29321

decreased by-0.64%

Dev dependency count

11

increased by10%

Dependency changes

• - Removedrimraf@^5.0.5

• - Removed@isaacs/cliui@8.0.2(transitive)

• - Removed@pkgjs/parseargs@0.11.0(transitive)

• - Removedansi-regex@5.0.16.0.1(transitive)

• - Removedansi-styles@4.3.06.2.1(transitive)

• - Removedbalanced-match@1.0.2(transitive)

• - Removedbrace-expansion@2.0.1(transitive)

• - Removedcolor-convert@2.0.1(transitive)

• - Removedcolor-name@1.1.4(transitive)

• - Removedeastasianwidth@0.2.0(transitive)

• - Removedemoji-regex@8.0.09.2.2(transitive)

• - Removedforeground-child@3.1.1(transitive)

• - Removedglob@10.3.12(transitive)

• - Removedis-fullwidth-code-point@3.0.0(transitive)

• - Removedjackspeak@2.3.6(transitive)

• - Removedlru-cache@10.2.1(transitive)

• - Removedminimatch@9.0.4(transitive)

• - Removedminipass@7.0.4(transitive)

• - Removedpath-scurry@1.10.2(transitive)

• - Removedrimraf@5.0.5(transitive)

• - Removedstring-width@4.2.35.1.2(transitive)

• - Removedstrip-ansi@6.0.17.1.0(transitive)

• - Removedwrap-ansi@7.0.08.1.0(transitive)