Release version v1.0.3

Author: mdeboer

README.md

@@ -34,31 +34,39 @@ npm install @cloudstek/cache
 
 ## Development
 
-Clone this repository to get started.
+Clone this repository to get started. You can replace `yarn` in the commands below with `npm` if you use NPM.
+
+### Build code and watch for changes
+
+During development you can build the code once and have typescript watch for changes and recompile automatically.
+
+```sh
+yarn run watch
+```
 
 ### Checking code for style
 
 To check the code for style correctness run:
 
 ```sh
-yarn lint
+yarn run lint
 ```
 
 ### Running tests
 
 Tests are run using [Ava](https://github.com/avajs/ava) and coverage is generated using [Istanbul](https://istanbul.js.org/). To run the tests run:
 
 ```sh
-yarn test
+yarn run build
+yarn run test
 ```
 
 ### Building the code for release
 
 To build the code for release (e.g. npm publish), run:
 
 ```sh
-yarn run clean
-yarn build
+yarn run build:dist
 ```
 
 ## Also check out

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudstek/cache",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Simple key/value (cache) store.",
   "author": "Maarten de Boer <maarten@cloudstek.nl>",
   "license": "MIT",
@@ -14,12 +14,12 @@
     "moment": "^2.24.0"
   },
   "devDependencies": {
-    "@types/fs-extra": "^7.0.0",
+    "@types/fs-extra": "^8.0.0",
     "@types/mockdate": "^2.0.0",
     "@types/node": "^12.0.2",
-    "ava": "^1.4.1",
+    "ava": "^2.2.0",
     "coveralls": "^3.0.3",
-    "del-cli": "^1.1.0",
+    "del-cli": "^2.0.0",
     "mockdate": "^2.0.2",
     "npm-run-all": "^4.1.5",
     "nyc": "^14.1.1",
@@ -35,13 +35,12 @@
     "clean:dist": "del-cli dist",
     "clean:test": "del-cli build",
     "clean:coverage": "del-cli coverage .nyc_output",
-    "build": "tsc",
-    "build:test": "tsc --outDir build --declaration false --sourceMap true",
-    "build:dist": "npm-run-all -s clean build",
-    "test": "npm-run-all clean:test clean:coverage build:test test:run clean:test",
-    "test:run": "nyc ava",
-    "test:ci": "npm-run-all -p clean:* -s build:test && nyc -s ava && nyc report --reporter=text-lcov | coveralls",
-    "lint": "npm-run-all -l -p lint:src lint:test",
+    "build": "npm-run-all -p clean:test clean:coverage && tsc",
+    "watch": "npm-run-all -p clean:test clean:coverage && tsc --watch",
+    "build:dist": "npm-run-all -s clean:dist && tsc -p tsconfig.dist.json",
+    "test": "npm-run-all -s clean:coverage && nyc ava",
+    "test:ci": "npm-run-all -p clean:* -s build && nyc -s ava && nyc report --reporter=text-lcov | coveralls",
+    "lint": "npm-run-all -l -p lint:*",
     "lint:src": "tslint src/**/*.ts",
     "lint:test": "tslint test/**/*.ts"
   },

test/expiration.ts

@@ -19,7 +19,7 @@ test.before((t) => {
 test.beforeEach((t) => {
     const dir = util.randomString();
 
-    MockDate.set(moment.utc("2019-01-01T14:00:00").valueOf());
+    MockDate.set(moment.utc("2019-01-01T14:00:00").toDate());
 
     t.context.dirs.push(dir);
     t.context.options = {
@@ -46,7 +46,7 @@ test("check expiration on new item", (t) => {
 
     t.is(c.keys.length, 3);
 
-    MockDate.set(moment().add(30, "minutes"));
+    MockDate.set(moment().add(30, "minutes").toDate());
 
     t.true(c.has("apple"));
     t.true(c.has("strawberry"));
@@ -58,7 +58,7 @@ test("check expiration on new item", (t) => {
 
     t.is(c.keys.length, 3);
 
-    MockDate.set(moment().add(1, "hour"));
+    MockDate.set(moment().add(1, "hour").toDate());
 
     t.true(c.has("apple"));
     t.false(c.has("strawberry"));
@@ -70,7 +70,7 @@ test("check expiration on new item", (t) => {
 
     t.is(c.keys.length, 1);
 
-    MockDate.set(moment().add(2, "hours"));
+    MockDate.set(moment().add(2, "hours").toDate());
 
     t.false(c.has("apple"));
     t.is(c.get("foo"), undefined);
@@ -106,7 +106,7 @@ test("check expiration on new item with autocommit", (t) => {
     t.true(util.pathExists(t.context.options.dir, "cache.json"));
     t.snapshot(fs.readFileSync(path.join(t.context.options.dir, "cache.json"), "utf8"));
 
-    MockDate.set(moment().add(30, "minutes"));
+    MockDate.set(moment().add(30, "minutes").toDate());
 
     t.true(c.has("apple"));
     t.true(c.has("strawberry"));
@@ -119,7 +119,7 @@ test("check expiration on new item with autocommit", (t) => {
     t.is(c.keys.length, 3);
     t.snapshot(fs.readFileSync(path.join(t.context.options.dir, "cache.json"), "utf8"));
 
-    MockDate.set(moment().add(1, "hour"));
+    MockDate.set(moment().add(1, "hour").toDate());
 
     t.true(c.has("apple"));
     t.false(c.has("strawberry"));
@@ -132,7 +132,7 @@ test("check expiration on new item with autocommit", (t) => {
     t.is(c.keys.length, 1);
     t.snapshot(fs.readFileSync(path.join(t.context.options.dir, "cache.json"), "utf8"));
 
-    MockDate.set(moment().add(2, "hours"));
+    MockDate.set(moment().add(2, "hours").toDate());
 
     t.false(c.has("apple"));
     t.is(c.get("foo"), undefined);
@@ -175,7 +175,7 @@ test("check expiration on init", (t) => {
     // Contents of file should not have changed with autoCommit disabled
     t.deepEqual(fs.readJsonSync(path.join(t.context.options.dir, "cache.json")), contents);
 
-    MockDate.set(moment().add(30, "minutes"));
+    MockDate.set(moment().add(30, "minutes").toDate());
 
     t.true(c.has("apple"));
     t.true(c.has("strawberry"));
@@ -189,7 +189,7 @@ test("check expiration on init", (t) => {
     // Contents of file should not have changed with autoCommit disabled
     t.deepEqual(fs.readJsonSync(path.join(t.context.options.dir, "cache.json")), contents);
 
-    MockDate.set(moment().add(1, "hour"));
+    MockDate.set(moment().add(1, "hour").toDate());
 
     t.true(c.has("apple"));
     t.false(c.has("strawberry"));
@@ -203,7 +203,7 @@ test("check expiration on init", (t) => {
     // Contents of file should not have changed with autoCommit disabled
     t.deepEqual(fs.readJsonSync(path.join(t.context.options.dir, "cache.json")), contents);
 
-    MockDate.set(moment().add(2, "hours"));
+    MockDate.set(moment().add(2, "hours").toDate());
 
     t.false(c.has("apple"));
     t.is(c.get("foo"), undefined);
@@ -250,7 +250,7 @@ test("check expiration on init with autocommit", (t) => {
     t.is(c.keys.length, 3);
     t.snapshot(fs.readFileSync(path.join(t.context.options.dir, "cache.json"), "utf8"));
 
-    MockDate.set(moment().add(30, "minutes"));
+    MockDate.set(moment().add(30, "minutes").toDate());
 
     t.true(c.has("apple"));
     t.true(c.has("strawberry"));
@@ -263,7 +263,7 @@ test("check expiration on init with autocommit", (t) => {
     t.is(c.keys.length, 3);
     t.snapshot(fs.readFileSync(path.join(t.context.options.dir, "cache.json"), "utf8"));
 
-    MockDate.set(moment().add(1, "hour"));
+    MockDate.set(moment().add(1, "hour").toDate());
 
     t.true(c.has("apple"));
     t.false(c.has("strawberry"));
@@ -276,7 +276,7 @@ test("check expiration on init with autocommit", (t) => {
     t.is(c.keys.length, 1);
     t.snapshot(fs.readFileSync(path.join(t.context.options.dir, "cache.json"), "utf8"));
 
-    MockDate.set(moment().add(2, "hours"));
+    MockDate.set(moment().add(2, "hours").toDate());
 
     t.false(c.has("apple"));
     t.is(c.get("foo"), undefined);
@@ -295,7 +295,7 @@ test("check never expiring item", (t) => {
     t.is(c.keys.length, 1);
     t.is(c.get("foo"), value);
 
-    MockDate.set(moment().add(1, "year"));
+    MockDate.set(moment().add(1, "year").toDate());
 
     t.true(c.has("foo"));
     t.is(c.keys.length, 1);

test/in-memory.ts

@@ -15,7 +15,7 @@ test.before((t) => {
 });
 
 test.beforeEach(() => {
-    MockDate.set(moment.utc("2019-01-01T14:00:00").valueOf());
+    MockDate.set(moment.utc("2019-01-01T14:00:00").toDate());
 });
 
 // Undefined / null dir and name

test/init.ts

@@ -17,7 +17,7 @@ test.before((t) => {
 });
 
 test.beforeEach(() => {
-    MockDate.set(moment.utc("2019-01-01T14:00:00").valueOf());
+    MockDate.set(moment.utc("2019-01-01T14:00:00").toDate());
 });
 
 // Defaults

test/iteration.ts

@@ -17,7 +17,7 @@ test.before((t) => {
 test.beforeEach((t) => {
     const dir = util.randomString();
 
-    MockDate.set(moment.utc("2019-01-01T14:00:00").valueOf());
+    MockDate.set(moment.utc("2019-01-01T14:00:00").toDate());
 
     t.context.dirs.push(dir);
     t.context.options = {
@@ -58,7 +58,7 @@ test("iterate over some expired items using all", (t) => {
 
     t.snapshot(allBeforeExpiration);
 
-    MockDate.set(moment().add(1, "hour"));
+    MockDate.set(moment().add(1, "hour").toDate());
 
     const allAfterExpiration = c.all();
 
@@ -110,7 +110,7 @@ test("iterate over some expired items using iterator", (t) => {
     t.deepEqual(itemsBeforeExpiration, c.all());
     t.snapshot(itemsBeforeExpiration);
 
-    MockDate.set(moment().add(1, "hour"));
+    MockDate.set(moment().add(1, "hour").toDate());
 
     t.is(c.keys.length, 2);
     t.is(c.length, c.keys.length);

tsconfig.dist.json

@@ -0,0 +1,13 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "sourceMap": false,
+    "outDir": "dist",
+  },
+  "include": [
+    "src/**/*"
+  ],
+  "exclude": [
+    "test/**/*"
+  ]
+}

tsconfig.json

@@ -7,9 +7,9 @@
     "noImplicitAny": true,
     "declaration": true,
     "declarationMap": false,
-    "sourceMap": false,
+    "sourceMap": true,
     "esModuleInterop": true,
-    "outDir": "dist",
+    "outDir": "build",
   },
   "include": [
     "src/**/*",