flat-cache 4.0.1 → 5.0.0

package/README.md

@@ -70,8 +70,5 @@ storage was needed and Bam! this module was born.
 
 ## License
 
-MIT
+[MIT](LISCENCE) © [Jared Wray](https://jaredwray.com)
 
-## Changelog
-
-[changelog](./changelog.md)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flat-cache",
-  "version": "4.0.1",
+  "version": "5.0.0",
   "description": "A stupidly simple key/value storage using files to persist some data",
   "repository": "jaredwray/flat-cache",
   "license": "MIT",
@@ -15,25 +15,18 @@
     "src/utils.js"
   ],
   "engines": {
-    "node": ">=16"
+    "node": ">=18"
   },
   "precommit": [
-    "npm run verify --silent"
+    "npm run test"
   ],
   "prepush": [
-    "npm run verify --silent"
+    "npm run test"
   ],
   "scripts": {
-    "eslint": "eslint --cache --cache-location=node_modules/.cache/ ./src/**/*.js ./test/**/*.js",
     "clean": "rimraf ./node_modules ./package-lock.json ./yarn.lock ./coverage",
-    "eslint-fix": "npm run eslint -- --fix",
-    "autofix": "npm run eslint-fix",
-    "check": "npm run eslint",
-    "verify": "npm run eslint && npm run test:cache",
-    "test:cache": "c8 mocha -R spec test/specs",
-    "test:ci:cache": "c8 --reporter=lcov mocha -R spec test/specs",
-    "test": "npm run verify --silent",
-    "format": "prettier --write ."
+    "test:ci": "xo && c8 --reporter=lcov mocha -R spec test/specs",
+    "test": "xo --fix && c8 mocha -R spec test/specs"
   },
   "keywords": [
     "json cache",
@@ -46,18 +39,23 @@
   "devDependencies": {
     "c8": "^9.1.0",
     "chai": "^4.3.10",
-    "eslint": "^8.56.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-mocha": "^10.2.0",
     "glob-expand": "^0.2.1",
-    "mocha": "^10.3.0",
-    "prettier": "^3.2.4",
-    "rimraf": "^5.0.5",
-    "sinon": "^17.0.1",
-    "write": "^2.0.0"
+    "mocha": "^10.4.0",
+    "rimraf": "^5.0.7",
+    "sinon": "^18.0.0",
+    "webpack": "^5.91.0",
+    "write": "^2.0.0",
+    "xo": "^0.58.0"
   },
   "dependencies": {
-    "flatted": "^3.2.9",
+    "flatted": "^3.3.1",
     "keyv": "^4.5.4"
+  },
+  "xo": {
+    "rules": {
+      "unicorn/prefer-module": "off",
+      "n/prefer-global/process": "off",
+      "unicorn/prevent-abbreviations": "off"
+    }
   }
 }

package/src/cache.js

@@ -1,11 +1,12 @@
-const path = require('path');
-const fs = require('fs');
+/* eslint-disable unicorn/no-this-assignment, no-unused-expressions */
+const path = require('node:path');
+const fs = require('node:fs');
 const Keyv = require('keyv');
-const { writeJSON, tryParse } = require('./utils');
-const { del } = require('./del');
+const {writeJSON, tryParse} = require('./utils.js');
+const {del} = require('./del.js');
 
 const cache = {
-  /**
+	/**
    * Load a cache identified by the given Id. If the element does not exists, then initialize an empty
    * cache storage. If specified `cacheDir` will be used as the directory to persist the data to. If omitted
    * then the cache module directory `./cache` will be used instead
@@ -14,151 +15,151 @@ const cache = {
    * @param docId {String} the id of the cache, would also be used as the name of the file cache
    * @param [cacheDir] {String} directory for the cache entry
    */
-  load: function (docId, cacheDir) {
-    const me = this;
-    me.keyv = new Keyv();
+	load(documentId, cacheDir) {
+		const me = this;
+		me.keyv = new Keyv();
 
-    me.__visited = {};
-    me.__persisted = {};
+		me.__visited = {};
+		me.__persisted = {};
 
-    me._pathToFile = cacheDir ? path.resolve(cacheDir, docId) : path.resolve(__dirname, '../.cache/', docId);
+		me._pathToFile = cacheDir ? path.resolve(cacheDir, documentId) : path.resolve(__dirname, '../.cache/', documentId);
 
-    if (fs.existsSync(me._pathToFile)) {
-      me._persisted = tryParse(me._pathToFile, {});
-    }
-  },
+		if (fs.existsSync(me._pathToFile)) {
+			me._persisted = tryParse(me._pathToFile, {});
+		}
+	},
 
-  get _persisted() {
-    return this.__persisted;
-  },
+	get _persisted() {
+		return this.__persisted;
+	},
 
-  set _persisted(value) {
-    this.__persisted = value;
-  },
+	set _persisted(value) {
+		this.__persisted = value;
+	},
 
-  get _visited() {
-    return this.__visited;
-  },
+	get _visited() {
+		return this.__visited;
+	},
 
-  set _visited(value) {
-    this.__visited = value;
-  },
+	set _visited(value) {
+		this.__visited = value;
+	},
 
-  /**
+	/**
    * Load the cache from the provided file
    * @method loadFile
    * @param  {String} pathToFile the path to the file containing the info for the cache
    */
-  loadFile: function (pathToFile) {
-    const me = this;
-    const dir = path.dirname(pathToFile);
-    const fName = path.basename(pathToFile);
+	loadFile(pathToFile) {
+		const me = this;
+		const dir = path.dirname(pathToFile);
+		const fName = path.basename(pathToFile);
 
-    me.load(fName, dir);
-  },
+		me.load(fName, dir);
+	},
 
-  /**
+	/**
    * Returns the entire persisted object
    * @method all
    * @returns {*}
    */
-  all: function () {
-    return this._persisted;
-  },
-
-  keys: function () {
-    return Object.keys(this._persisted);
-  },
-  /**
-   * sets a key to a given value
+	all() {
+		return this._persisted;
+	},
+
+	keys() {
+		return Object.keys(this._persisted);
+	},
+	/**
+   * Sets a key to a given value
    * @method setKey
    * @param key {string} the key to set
    * @param value {object} the value of the key. Could be any object that can be serialized with JSON.stringify
    */
-  setKey: function (key, value) {
-    this._visited[key] = true;
-    this._persisted[key] = value;
-  },
-  /**
-   * remove a given key from the cache
+	setKey(key, value) {
+		this._visited[key] = true;
+		this._persisted[key] = value;
+	},
+	/**
+   * Remove a given key from the cache
    * @method removeKey
    * @param key {String} the key to remove from the object
    */
-  removeKey: function (key) {
-    delete this._visited[key]; // esfmt-ignore-line
-    delete this._persisted[key]; // esfmt-ignore-line
-  },
-  /**
+	removeKey(key) {
+		delete this._visited[key]; // Esfmt-ignore-line
+		delete this._persisted[key]; // Esfmt-ignore-line
+	},
+	/**
    * Return the value of the provided key
    * @method getKey
    * @param key {String} the name of the key to retrieve
    * @returns {*} the value from the key
    */
-  getKey: function (key) {
-    this._visited[key] = true;
-    return this._persisted[key];
-  },
+	getKey(key) {
+		this._visited[key] = true;
+		return this._persisted[key];
+	},
 
-  /**
+	/**
    * Remove keys that were not accessed/set since the
    * last time the `prune` method was called.
    * @method _prune
    * @private
    */
-  _prune: function () {
-    const me = this;
-    const obj = {};
+	_prune() {
+		const me = this;
+		const object = {};
 
-    const keys = Object.keys(me._visited);
+		const keys = Object.keys(me._visited);
 
-    // no keys visited for either get or set value
-    if (keys.length === 0) {
-      return;
-    }
+		// No keys visited for either get or set value
+		if (keys.length === 0) {
+			return;
+		}
 
-    keys.forEach(function (key) {
-      obj[key] = me._persisted[key];
-    });
+		for (const key of keys) {
+			object[key] = me._persisted[key];
+		}
 
-    me._visited = {};
-    me._persisted = obj;
-  },
+		me._visited = {};
+		me._persisted = object;
+	},
 
-  /**
+	/**
    * Save the state of the cache identified by the docId to disk
    * as a JSON structure
    * @param [noPrune=false] {Boolean} whether to remove from cache the non visited files
    * @method save
    */
-  save: function (noPrune) {
-    const me = this;
-    !noPrune && me._prune();
-    writeJSON(me._pathToFile, me._persisted);
-  },
-
-  /**
-   * remove the file where the cache is persisted
+	save(noPrune) {
+		const me = this;
+		!noPrune && me._prune();
+		writeJSON(me._pathToFile, me._persisted);
+	},
+
+	/**
+   * Remove the file where the cache is persisted
    * @method removeCacheFile
    * @return {Boolean} true or false if the file was successfully deleted
    */
-  removeCacheFile: function () {
-    return del(this._pathToFile);
-  },
-  /**
+	removeCacheFile() {
+		return del(this._pathToFile);
+	},
+	/**
    * Destroy the file cache and cache content.
    * @method destroy
    */
-  destroy: function () {
-    const me = this;
-    me._visited = {};
-    me._persisted = {};
+	destroy() {
+		const me = this;
+		me._visited = {};
+		me._persisted = {};
 
-    me.removeCacheFile();
-  },
+		me.removeCacheFile();
+	},
 };
 
 module.exports = {
-  /**
+	/**
    * Alias for create. Should be considered depreacted. Will be removed in next releases
    *
    * @method load
@@ -166,11 +167,11 @@ module.exports = {
    * @param [cacheDir] {String} directory for the cache entry
    * @returns {cache} cache instance
    */
-  load: function (docId, cacheDir) {
-    return this.create(docId, cacheDir);
-  },
+	load(documentId, cacheDir) {
+		return this.create(documentId, cacheDir);
+	},
 
-  /**
+	/**
    * Load a cache identified by the given Id. If the element does not exists, then initialize an empty
    * cache storage.
    *
@@ -179,18 +180,18 @@ module.exports = {
    * @param [cacheDir] {String} directory for the cache entry
    * @returns {cache} cache instance
    */
-  create: function (docId, cacheDir) {
-    const obj = Object.create(cache);
-    obj.load(docId, cacheDir);
-    return obj;
-  },
-
-  createFromFile: function (filePath) {
-    const obj = Object.create(cache);
-    obj.loadFile(filePath);
-    return obj;
-  },
-  /**
+	create(documentId, cacheDir) {
+		const object = Object.create(cache);
+		object.load(documentId, cacheDir);
+		return object;
+	},
+
+	createFromFile(filePath) {
+		const object = Object.create(cache);
+		object.loadFile(filePath);
+		return object;
+	},
+	/**
    * Clear the cache identified by the given id. Caches stored in a different cache directory can be deleted directly
    *
    * @method clearCache
@@ -198,17 +199,17 @@ module.exports = {
    * @param cacheDir {String} the directory where the cache file was written
    * @returns {Boolean} true if the cache folder was deleted. False otherwise
    */
-  clearCacheById: function (docId, cacheDir) {
-    const filePath = cacheDir ? path.resolve(cacheDir, docId) : path.resolve(__dirname, '../.cache/', docId);
-    return del(filePath);
-  },
-  /**
+	clearCacheById(documentId, cacheDir) {
+		const filePath = cacheDir ? path.resolve(cacheDir, documentId) : path.resolve(__dirname, '../.cache/', documentId);
+		return del(filePath);
+	},
+	/**
    * Remove all cache stored in the cache directory
    * @method clearAll
    * @returns {Boolean} true if the cache folder was deleted. False otherwise
    */
-  clearAll: function (cacheDir) {
-    const filePath = cacheDir ? path.resolve(cacheDir) : path.resolve(__dirname, '../.cache/');
-    return del(filePath);
-  },
+	clearAll(cacheDir) {
+		const filePath = cacheDir ? path.resolve(cacheDir) : path.resolve(__dirname, '../.cache/');
+		return del(filePath);
+	},
 };

package/src/del.js

@@ -1,30 +1,31 @@
-const fs = require('fs');
-const path = require('path');
+const fs = require('node:fs');
+const path = require('node:path');
 
 function del(targetPath) {
-  if (!fs.existsSync(targetPath)) {
-    return false;
-  }
+	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);
+	try {
+		if (fs.statSync(targetPath).isDirectory()) {
+			// If it's a directory, delete its contents first
+			for (const file of fs.readdirSync(targetPath)) {
+				const currentPath = 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
-    }
+				if (fs.statSync(currentPath).isFile()) {
+					fs.unlinkSync(currentPath); // Delete file
+				}
+			}
 
-    return true;
-  } catch (error) {
-    console.error(`Error while deleting ${targetPath}: ${error.message}`);
-  }
+			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}`);
+	}
 }
 
-module.exports = { del };
+module.exports = {del};

package/src/utils.js

@@ -1,15 +1,16 @@
-const fs = require('fs');
-const path = require('path');
+const fs = require('node:fs');
+const path = require('node:path');
 const flatted = require('flatted');
 
 function tryParse(filePath, defaultValue) {
-  let result;
-  try {
-    result = readJSON(filePath);
-  } catch (ex) {
-    result = defaultValue;
-  }
-  return result;
+	let result;
+	try {
+		result = readJSON(filePath);
+	} catch {
+		result = defaultValue;
+	}
+
+	return result;
 }
 
 /**
@@ -19,11 +20,11 @@ function tryParse(filePath, defaultValue) {
  * @returns {*} parse result
  */
 function readJSON(filePath) {
-  return flatted.parse(
-    fs.readFileSync(filePath, {
-      encoding: 'utf8',
-    })
-  );
+	return flatted.parse(
+		fs.readFileSync(filePath, {
+			encoding: 'utf8',
+		}),
+	);
 }
 
 /**
@@ -33,10 +34,10 @@ function readJSON(filePath) {
  * @param  {*} data Object to serialize
  */
 function writeJSON(filePath, data) {
-  fs.mkdirSync(path.dirname(filePath), {
-    recursive: true,
-  });
-  fs.writeFileSync(filePath, flatted.stringify(data));
+	fs.mkdirSync(path.dirname(filePath), {
+		recursive: true,
+	});
+	fs.writeFileSync(filePath, flatted.stringify(data));
 }
 
-module.exports = { tryParse, readJSON, writeJSON };
+module.exports = {tryParse, readJSON, writeJSON};

package/changelog.md

@@ -1,278 +0,0 @@
-# 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
-
-## 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
-
-## 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
-  - 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
-
-- **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
-
-## 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
-- **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
-
-    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
-
-    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
-  - 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
-
-    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
-
-    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
-  - 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
-
-- **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
-
-## 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
-
-## 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
-
-- **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
-
-    - 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
-
-## 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
-- **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 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
-
-## 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
-- **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
-
-    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
-- **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
-- **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
-
-    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
-
-## 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
-
-    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
-
-    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
-
-## 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
-
-## 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
-
-- **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
-    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
-
-- **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
-
-- **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
-- **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
-
-## 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
-
-- **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
-
-## 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
-
-## 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
-
-## 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
-- **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
-
-## 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
-
-## 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
-- **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
-
-## 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
-- **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
-- **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
-
-## 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
-
-## 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
-- **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