chronokinesis 6.0.0 → 7.0.0

package/README.md

@@ -1,5 +1,5 @@
-chronokinesis
-=============
+# chronokinesis
+
 [![Build](https://github.com/paed01/chronokinesis/actions/workflows/build.yaml/badge.svg)](https://github.com/paed01/chronokinesis/actions/workflows/build.yaml) [![Coverage Status](https://coveralls.io/repos/github/paed01/chronokinesis/badge.svg?branch=master)](https://coveralls.io/github/paed01/chronokinesis?branch=master)
 
 Mock time and date for traveling and freezing. Inspired and borrowed from [timekeeper](https://github.com/vesln/timekeeper).
@@ -43,6 +43,35 @@ setTimeout(() => {
 }, 2000);
 ```
 
+With arguments:
+
+```javascript
+import * as ck from 'chronokinesis';
+import assert from 'node:assert';
+
+ck.freeze(1980, 0, 1);
+
+assert.equal(true, ck.isKeepingTime());
+assert.deepEqual(new Date(), new Date(1980, 0, 1));
+
+ck.reset();
+```
+
+or use with [`luxon`](https://moment.github.io/luxon):
+
+```javascript
+import { DateTime } from 'luxon';
+import * as ck from 'chronokinesis';
+
+ck.travel(DateTime.now().plus({ year: 1 }).toMillis());
+
+setTimeout(() => {
+  console.log('Traveled with Luxon DateTime one year and some', new Date());
+
+  ck.reset();
+}, 2000);
+```
+
 or use with [`moment`](http://momentjs.com):
 
 ```javascript
@@ -52,8 +81,7 @@ import * as ck from 'chronokinesis';
 ck.travel(moment().add(1, 'year'));
 
 setTimeout(() => {
-  // Date traveled one year and some
-  console.log(new Date());
+  console.log('Traveled with Moment Date one year and some', new Date());
 
   ck.reset();
 }, 2000);
@@ -92,7 +120,7 @@ let date = new Date(2018, 0, 31);
 
 ck.travel(date);
 
-setTimeout(function() {
+setTimeout(function () {
   console.log(new Date());
   ck.reset();
 }, 1500);
@@ -110,7 +138,7 @@ ck.freeze(date);
 
 ck.travel(moment().add(1, 'year'));
 
-setTimeout(function() {
+setTimeout(function () {
   console.log(`Still frozen but one year ahead ${new Date()}`);
 
   ck.reset();
@@ -148,12 +176,12 @@ Resets Date to current glory.
 import * as ck from 'chronokinesis';
 
 ck.freeze(2060, 0, 1);
-console.log(`end of time is reached at ${new Date()} according to Newton`)
+console.log(`end of time is reached at ${new Date()} according to Newton`);
 
 ck.reset();
 
 // Today
-console.log(new Date())
+console.log(new Date());
 ```
 
 ## `isKeepingTime()`
@@ -166,6 +194,8 @@ import * as ck from 'chronokinesis';
 console.log(ck.isKeepingTime() ? 'Is' : 'Not', 'keeping time');
 ck.travel(1893448800000);
 console.log(ck.isKeepingTime() ? 'Is' : 'Not', 'keeping time');
+
+ck.reset();
 ```
 
 ## `timezone(timeZone[, ...args])`
@@ -180,12 +210,15 @@ Returns [`TimeZoneTraveller` api](#new-timezonetravellertimezone)
 ```javascript
 import * as ck from 'chronokinesis';
 
+ck.reset();
+
 const tz = ck.timezone('Asia/Shanghai');
 
-// Now in Shanghai
-console.log(new Date())
+console.log('Now in Shanghai', new Date());
 
 tz.freeze();
+
+ck.reset();
 ```
 
 ## `new TimeZoneTraveller(timeZone)`
@@ -193,11 +226,13 @@ tz.freeze();
 Time zone traveller api.
 
 ```javascript
-import {TimeZoneTraveller} from 'chronokinesis';
+import { TimeZoneTraveller, reset } from 'chronokinesis';
 
 const timezone = new TimeZoneTraveller('Asia/Shanghai');
 
 timezone.freeze();
+
+reset();
 ```
 
 ### `timezone.freeze([...args])`

package/dist/chronokinesis.cjs

@@ -10,7 +10,9 @@
    * Veselin Todorov <hi@vesln.com>
    * MIT License.
    */
-  const NativeDate = Date;
+  const kNativeDate = Symbol.for('chronokinesis native date');
+
+  const NativeDate = Date[kNativeDate] || Date;
   const nativeGetTimezoneOffset = NativeDate.prototype.getTimezoneOffset;
 
   let freezedAt = null;
@@ -41,6 +43,8 @@
     return dt;
   }
 
+  FakeDate[kNativeDate] = NativeDate;
+
   FakeDate.UTC = NativeDate.UTC;
   FakeDate.parse = NativeDate.parse;
 
@@ -146,11 +150,11 @@
   }
 
   function useFakeDate() {
-    Date = FakeDate; // eslint-disable-line no-global-assign
+    Date = FakeDate;
   }
 
   function useNativeDate() {
-    Date = NativeDate; // eslint-disable-line no-global-assign
+    Date = FakeDate[kNativeDate];
   }
 
   function time() {
@@ -166,7 +170,7 @@
   function toUTC(formatter, dt) {
     let year, month, day, hour, minute, second;
 
-    for (const {type, value} of formatter.formatToParts(dt)) {
+    for (const { type, value } of formatter.formatToParts(dt)) {
       switch (type) {
         case 'year':
           year = parseInt(value);
@@ -192,6 +196,7 @@
     return NativeDate.UTC(year, month, day, hour, minute, second, dt.getMilliseconds());
   }
 
+  exports.FakeDate = FakeDate;
   exports.TimeZoneTraveller = TimeZoneTraveller;
   exports.defrost = defrost;
   exports.freeze = freeze;

package/dist/index.cjs

@@ -6,7 +6,9 @@
  * Veselin Todorov <hi@vesln.com>
  * MIT License.
  */
-const NativeDate = Date;
+const kNativeDate = Symbol.for('chronokinesis native date');
+
+const NativeDate = Date[kNativeDate] || Date;
 const nativeGetTimezoneOffset = NativeDate.prototype.getTimezoneOffset;
 
 let freezedAt = null;
@@ -37,6 +39,8 @@ function FakeDate(...args) {
   return dt;
 }
 
+FakeDate[kNativeDate] = NativeDate;
+
 FakeDate.UTC = NativeDate.UTC;
 FakeDate.parse = NativeDate.parse;
 
@@ -142,11 +146,11 @@ function timezone(timeZone, ...args) {
 }
 
 function useFakeDate() {
-  Date = FakeDate; // eslint-disable-line no-global-assign
+  Date = FakeDate;
 }
 
 function useNativeDate() {
-  Date = NativeDate; // eslint-disable-line no-global-assign
+  Date = FakeDate[kNativeDate];
 }
 
 function time() {
@@ -162,7 +166,7 @@ function instantiate(type, args) {
 function toUTC(formatter, dt) {
   let year, month, day, hour, minute, second;
 
-  for (const {type, value} of formatter.formatToParts(dt)) {
+  for (const { type, value } of formatter.formatToParts(dt)) {
     switch (type) {
       case 'year':
         year = parseInt(value);
@@ -188,6 +192,7 @@ function toUTC(formatter, dt) {
   return NativeDate.UTC(year, month, day, hour, minute, second, dt.getMilliseconds());
 }
 
+exports.FakeDate = FakeDate;
 exports.TimeZoneTraveller = TimeZoneTraveller;
 exports.defrost = defrost;
 exports.freeze = freeze;

package/index.d.ts

@@ -22,6 +22,11 @@ export function reset(): void;
  */
 export function isKeepingTime(): boolean;
 
+/**
+ * Fake date
+ */
+export class FakeDate extends Date {}
+
 /**
  * Timezone traveling
  */

package/index.js

@@ -4,7 +4,9 @@
  * Veselin Todorov <hi@vesln.com>
  * MIT License.
  */
-const NativeDate = Date;
+const kNativeDate = Symbol.for('chronokinesis native date');
+
+const NativeDate = Date[kNativeDate] || Date;
 const nativeGetTimezoneOffset = NativeDate.prototype.getTimezoneOffset;
 
 let freezedAt = null;
@@ -12,7 +14,7 @@ let traveledTo = null;
 let started = null;
 let iana = null;
 
-function FakeDate(...args) {
+export function FakeDate(...args) {
   const length = args.length;
   if (!length) {
     if (freezedAt) args = [freezedAt];
@@ -35,6 +37,8 @@ function FakeDate(...args) {
   return dt;
 }
 
+FakeDate[kNativeDate] = NativeDate;
+
 FakeDate.UTC = NativeDate.UTC;
 FakeDate.parse = NativeDate.parse;
 
@@ -140,11 +144,11 @@ export function timezone(timeZone, ...args) {
 }
 
 function useFakeDate() {
-  Date = FakeDate; // eslint-disable-line no-global-assign
+  Date = FakeDate;
 }
 
 function useNativeDate() {
-  Date = NativeDate; // eslint-disable-line no-global-assign
+  Date = FakeDate[kNativeDate];
 }
 
 function time() {
@@ -160,7 +164,7 @@ function instantiate(type, args) {
 function toUTC(formatter, dt) {
   let year, month, day, hour, minute, second;
 
-  for (const {type, value} of formatter.formatToParts(dt)) {
+  for (const { type, value } of formatter.formatToParts(dt)) {
     switch (type) {
       case 'year':
         year = parseInt(value);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chronokinesis",
-  "version": "6.0.0",
+  "version": "7.0.0",
   "description": "Module for testing time-dependent code",
   "author": {
     "name": "Pål Edman",
@@ -15,15 +15,20 @@
   "sideEffects": true,
   "repository": {
     "type": "git",
-    "url": "git://github.com/paed01/chronokinesis"
+    "url": "git://github.com/paed01/chronokinesis.git"
+  },
+  "exports": {
+    "import": "./index.js",
+    "require": "./dist/index.cjs",
+    "types": "./index.d.ts"
   },
   "scripts": {
     "toc": "node generate-api-toc.cjs",
     "test": "mocha",
-    "lint": "eslint . --cache",
+    "lint": "eslint . --cache && prettier . --check --cache",
     "test:lcov": "c8 -r lcov -r text mocha && npm run lint",
     "cov:html": "c8 mocha -R dot && c8 report --reporter html",
-    "posttest": "npm run lint && npm run dist",
+    "posttest": "npm run lint && npm run dist && texample -g",
     "prepack": "npm run dist",
     "dist": "npm run toc && rollup -c"
   },
@@ -49,14 +54,17 @@
     "fake now"
   ],
   "devDependencies": {
-    "@rollup/plugin-commonjs": "^25.0.3",
-    "c8": "^8.0.1",
-    "chai": "^4.3.7",
-    "eslint": "^8.46.0",
+    "@rollup/plugin-commonjs": "^28.0.2",
+    "c8": "^10.1.2",
+    "chai": "^5.1.0",
+    "eslint": "^9.3.0",
     "lodash.clonedeep": "^4.5.0",
+    "luxon": "^3.7.1",
     "markdown-toc": "^1.2.0",
-    "mocha": "^10.1.0",
-    "moment": "^2.29.4",
-    "rollup": "^3.27.2"
+    "mocha": "^11.0.1",
+    "moment": "^2.30.1",
+    "prettier": "^3.2.5",
+    "rollup": "^4.12.1",
+    "texample": "^0.0.8"
   }
 }