Don't import core-js by default

dumbmatter · Nov 15, 2019 · c8ff75c · c8ff75c
1 parent c80e706
commit c8ff75c
Show file tree

Hide file tree

Showing 18 changed files with 25 additions and 19 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+# 3.0.0 (2019-11-15)
+
+* Stop including core-js by default. This means that, for people using fake-indexeddb in really old environments like PhantomJS, they will now need to import core-js like `require("core-js/stable");` (or something similar) before importing fake-indexeddb.
+
 # 2.1.1 (2019-06-05)
 
 * #30 - Fixed typo in the name of the `Event.timeStamp` property.

diff --git a/README.md b/README.md
@@ -65,6 +65,15 @@ var IDBKeyRange = require("fake-indexeddb/lib/FDBKeyRange");
 
 When importing individual classes directly (like `var IDBKeyRange = require("fake-indexeddb/lib/FDBKeyRange");` above), file names of all the objects are like the normal IndexedDB ones except with F replacing I, e.g. `FDBIndex` instead of `IDBIndex`.
 
+#### PhantomJS and other really old environments
+
+PhantomJS (and other really old environments) are missing tons of modern JavaScript features. In fact, that may be why you use fake-indexeddb in such an environment! Prior to v3.0.0, fake-indexeddb imported core-js and automatically applied its polyfills. However, since most fake-indexeddb users are not using really old environments, I got rid of that runtime dependency in v3.0.0. To work around that, you can import core-js yourself before you import fake-indexeddb, like:
+
+```js
+require("core-js/stable");
+var indexedDB = require("fake-indexeddb");
+```
+
 ## Quality
 
 Here's a comparison of fake-indexeddb and real browser IndexedDB implementations on [the W3C IndexedDB test suite](https://github.com/w3c/web-platform-tests/tree/master/IndexedDB) as of March 18, 2019:

diff --git a/auto.js b/auto.js
@@ -1,4 +1,3 @@
-require("core-js/shim");
 var fakeIndexedDB = require("./build/fakeIndexedDB").default;
 var FDBCursor = require("./build/FDBCursor").default;
 var FDBCursorWithValue = require("./build/FDBCursorWithValue").default;
@@ -17,10 +16,10 @@ var globalVar =
     typeof window !== "undefined"
         ? window
         : typeof WorkerGlobalScope !== "undefined"
-            ? self
-            : typeof global !== "undefined"
-                ? global
-                : Function("return this;")();
+        ? self
+        : typeof global !== "undefined"
+        ? global
+        : Function("return this;")();
 
 globalVar.indexedDB = fakeIndexedDB;
 globalVar.IDBCursor = FDBCursor;

diff --git a/lib/FDBCursor.js b/lib/FDBCursor.js
@@ -2,5 +2,4 @@
 // <https://github.com/Microsoft/TypeScript/issues/2719> and <http://stackoverflow.com/q/30302747/786644>. It should not
 // be used internally, only externally.
 
-require("core-js/shim");
 module.exports = require("../build/FDBCursor").default;
diff --git a/lib/FDBCursorWithValue.js b/lib/FDBCursorWithValue.js
@@ -2,5 +2,4 @@
 // <https://github.com/Microsoft/TypeScript/issues/2719> and <http://stackoverflow.com/q/30302747/786644>. It should not
 // be used internally, only externally.
 
-require("core-js/shim");
 module.exports = require("../build/FDBCursorWithValue").default;
diff --git a/lib/FDBDatabase.js b/lib/FDBDatabase.js
@@ -2,5 +2,4 @@
 // <https://github.com/Microsoft/TypeScript/issues/2719> and <http://stackoverflow.com/q/30302747/786644>. It should not
 // be used internally, only externally.
 
-require("core-js/shim");
 module.exports = require("../build/FDBDatabase").default;
diff --git a/lib/FDBFactory.js b/lib/FDBFactory.js
@@ -2,5 +2,4 @@
 // <https://github.com/Microsoft/TypeScript/issues/2719> and <http://stackoverflow.com/q/30302747/786644>. It should not
 // be used internally, only externally.
 
-require("core-js/shim");
 module.exports = require("../build/FDBFactory").default;
diff --git a/lib/FDBIndex.js b/lib/FDBIndex.js
@@ -2,5 +2,4 @@
 // <https://github.com/Microsoft/TypeScript/issues/2719> and <http://stackoverflow.com/q/30302747/786644>. It should not
 // be used internally, only externally.
 
-require("core-js/shim");
 module.exports = require("../build/FDBIndex").default;
diff --git a/lib/FDBKeyRange.js b/lib/FDBKeyRange.js
@@ -2,5 +2,4 @@
 // <https://github.com/Microsoft/TypeScript/issues/2719> and <http://stackoverflow.com/q/30302747/786644>. It should not
 // be used internally, only externally.
 
-require("core-js/shim");
 module.exports = require("../build/FDBKeyRange").default;
diff --git a/lib/FDBObjectStore.js b/lib/FDBObjectStore.js
@@ -2,5 +2,4 @@
 // <https://github.com/Microsoft/TypeScript/issues/2719> and <http://stackoverflow.com/q/30302747/786644>. It should not
 // be used internally, only externally.
 
-require("core-js/shim");
 module.exports = require("../build/FDBObjectStore").default;
diff --git a/lib/FDBOpenDBRequest.js b/lib/FDBOpenDBRequest.js
@@ -2,5 +2,4 @@
 // <https://github.com/Microsoft/TypeScript/issues/2719> and <http://stackoverflow.com/q/30302747/786644>. It should not
 // be used internally, only externally.
 
-require("core-js/shim");
 module.exports = require("../build/FDBOpenDBRequest").default;
diff --git a/lib/FDBRequest.js b/lib/FDBRequest.js
@@ -2,5 +2,4 @@
 // <https://github.com/Microsoft/TypeScript/issues/2719> and <http://stackoverflow.com/q/30302747/786644>. It should not
 // be used internally, only externally.
 
-require("core-js/shim");
 module.exports = require("../build/FDBRequest").default;
diff --git a/lib/FDBTransaction.js b/lib/FDBTransaction.js
@@ -2,5 +2,4 @@
 // <https://github.com/Microsoft/TypeScript/issues/2719> and <http://stackoverflow.com/q/30302747/786644>. It should not
 // be used internally, only externally.
 
-require("core-js/shim");
 module.exports = require("../build/FDBTransaction").default;
diff --git a/lib/FDBVersionChangeEvent.js b/lib/FDBVersionChangeEvent.js
@@ -2,5 +2,4 @@
 // <https://github.com/Microsoft/TypeScript/issues/2719> and <http://stackoverflow.com/q/30302747/786644>. It should not
 // be used internally, only externally.
 
-require("core-js/shim");
 module.exports = require("../build/FDBVersionChangeEvent").default;
diff --git a/package.json b/package.json
@@ -40,14 +40,14 @@
         "lib"
     ],
     "dependencies": {
-        "core-js": "^2.6.10",
         "realistic-structured-clone": "^2.0.1",
         "setimmediate": "^1.0.5"
     },
     "devDependencies": {
         "@types/mocha": "^5.2.7",
         "@types/node": "^12.12.7",
         "browserify": "^16.5.0",
+        "core-js": "^3.4.1",
         "glob": "^7.1.6",
         "husky": "^3.0.9",
         "lint-staged": "^9.4.3",

diff --git a/src/index.ts b/src/index.ts
@@ -1,4 +1,3 @@
-import "core-js/shim";
 import fakeIndexedDB from "./fakeIndexedDB";
 
 module.exports = fakeIndexedDB;
diff --git a/src/test/indexedDBmock/exports-qunit-bundle.js b/src/test/indexedDBmock/exports-qunit-bundle.js
@@ -1,2 +1,3 @@
+require("core-js/stable");
 window.indexedDBmock = require("../..");
 window.IDBKeyRangemock = require("../../FDBKeyRange").default;
diff --git a/yarn.lock b/yarn.lock
@@ -600,11 +600,16 @@ convert-source-map@~1.1.0:
   resolved "https://registry.yarnpkg.com/convert-source-map/-/convert-source-map-1.1.3.tgz#4829c877e9fe49b3161f3bf3673888e204699860"
   integrity sha1-SCnId+n+SbMWHzvzZziI4gRpmGA=
 
-core-js@^2.5.3, core-js@^2.6.10:
+core-js@^2.5.3:
   version "2.6.10"
   resolved "https://registry.yarnpkg.com/core-js/-/core-js-2.6.10.tgz#8a5b8391f8cc7013da703411ce5b585706300d7f"
   integrity sha512-I39t74+4t+zau64EN1fE5v2W31Adtc/REhzWN+gWRRXg6WH5qAsZm62DHpQ1+Yhe4047T55jvzz7MUqF/dBBlA==
 
+core-js@^3.4.1:
+  version "3.4.1"
+  resolved "https://registry.yarnpkg.com/core-js/-/core-js-3.4.1.tgz#76dd6828412900ab27c8ce0b22e6114d7ce21b18"
+  integrity sha512-KX/dnuY/J8FtEwbnrzmAjUYgLqtk+cxM86hfG60LGiW3MmltIc2yAmDgBgEkfm0blZhUrdr1Zd84J2Y14mLxzg==
+
 core-util-is@1.0.2, core-util-is@~1.0.0:
   version "1.0.2"
   resolved "https://registry.yarnpkg.com/core-util-is/-/core-util-is-1.0.2.tgz#b5fd54220aa2bc5ab57aab7140c940754503c1a7"