module-replacements 2.1.0-beta.1 → 2.2.0

package/README.md

@@ -1,17 +1,37 @@
 # module-replacements
 
-This project provides two things:
+As part of the community [e18e](https://e18e.dev) effort, this project
+provides a collection of module replacements (i.e. possible alternative
+packages).
 
-- A JS package containing manifests of suggested module replacements
-- Documentation for replacements which are not entirely replaced by native
-functionality
+We provide two things:
+- Manifests (mappings of modules to their possible replacements)
+- Documentation for more complex replacements
 
-## Replacements documentation
+## List of replacements
 
-You can read more about module replacements and browse the list
-[by clicking here](./docs/modules/README.md).
+You can find a list of replacements in the
+[modules readme](./docs/modules/README.md).
 
-## `module-replacements` package
+## Tools
+
+Some tools consume the lists of modules in this repository:
+
+| Name | Description |
+| -- | -- |
+| [eslint-plugin-depend](https://github.com/es-tooling/eslint-plugin-depend) | ESLint plugin to detect possible replacements |
+
+
+## Manifests
+
+The manifests can be used via the `module-replacements` NPM package.
+
+We provide three manifests:
+
+- All (includes every manifest)
+- Native replacements
+- Micro utility replacements
+- Preferred replacements
 
 ### Usage
 
@@ -24,19 +44,13 @@ npm i -S module-replacements
 You can then import the manifest of your choice:
 
 ```ts
-import {NativeReplacements} from 'module-replacements';
+import {nativeReplacements} from 'module-replacements';
 ```
 
-### Manifests
-
-We provide three manifests:
-
-- All (includes every manifest)
-- Native replacements
-- Micro utility replacements
-- Preferred replacements
+The manifests are also available directly in the `manifests/` directory
+of the package (e.g. `node_modules/module-replacements/manifests/native.json`).
 
-#### Native replacements
+### Native replacements (`nativeReplacements`, `native.json`)
 
 These are modules which can now be replaced by native functionality.
 
@@ -46,13 +60,13 @@ platform features can be replaced by their platform equivalents.
 Similarly, features which did not exist at the time but have now existed in
 the platform for many years, so no longer need a dependency.
 
-#### Micro utility replacements
+### Micro utility replacements (`microUtilsReplacements`, `micro-utilities.json`)
 
 This is a more opinionated list of modules considered to be 'micro utilities' -
 very small utilities which could possibly be replaced with native equivalents
 or removed entirely.
 
-#### Preferred replacements
+### Preferred replacements (`preferredReplacements`, `preferred.json`)
 
 This is a very opinionated list of modules with preferred replacements. Often
 these replacements are much lighter or more modern than the modules they are

package/manifests/micro-utilities.json

@@ -1,9 +1,57 @@
 {
   "moduleReplacements": [
+    {
+      "type": "simple",
+      "moduleName": "call-bind",
+      "replacement": "Use Function.call.bind(v)",
+      "category": "micro-utilities"
+    },
+    {
+      "type": "simple",
+      "moduleName": "es-get-iterator",
+      "replacement": "Use v[Symbol.iterator]?.()",
+      "category": "micro-utilities"
+    },
+    {
+      "type": "simple",
+      "moduleName": "es-set-tostringtag",
+      "replacement": "Use Object.defineProperty(target, Symbol.toStringTag, { value, configurable: true })",
+      "category": "micro-utilities"
+    },
+    {
+      "type": "simple",
+      "moduleName": "is-array-buffer",
+      "replacement": "Use v instanceof ArrayBuffer, or if cross-realm, use Object.prototype.toString.call(v) === \"[object ArrayBuffer]\"",
+      "category": "micro-utilities"
+    },
+    {
+      "type": "simple",
+      "moduleName": "is-boolean-object",
+      "replacement": "Use Object.prototype.toString.call(v) === \"[object Boolean]\"",
+      "category": "micro-utilities"
+    },
+    {
+      "type": "simple",
+      "moduleName": "is-date-object",
+      "replacement": "Use v instanceof Date, or if cross-realm, use Object.prototype.toString.call(v) === \"[object Date]\"",
+      "category": "micro-utilities"
+    },
+    {
+      "type": "simple",
+      "moduleName": "is-negative-zero",
+      "replacement": "Use Object.is(v, -0)",
+      "category": "micro-utilities"
+    },
     {
       "type": "simple",
       "moduleName": "is-number",
-      "replacement": "Use typeof v === \"number\"",
+      "replacement": "Use typeof v === \"number\" || (typeof v === \"string\" && Number.isFinite(+v))",
+      "category": "micro-utilities"
+    },
+    {
+      "type": "simple",
+      "moduleName": "is-number-object",
+      "replacement": "Use Object.prototype.toString.call(v) === \"[object Number]\"",
       "category": "micro-utilities"
     },
     {
@@ -24,6 +72,12 @@
       "replacement": "Use v instanceof RegExp, or if cross-realm, use Object.prototype.toString.call(v) === \"[object RegExp]\"",
       "category": "micro-utilities"
     },
+    {
+      "type": "simple",
+      "moduleName": "is-string",
+      "replacement": "Use Object.prototype.toString.call(v) === \"[object String]\"",
+      "category": "micro-utilities"
+    },
     {
       "type": "simple",
       "moduleName": "is-travis",