module-replacements 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 James Garbutt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,59 @@
+# module-replacements
+
+This package provides a set of manifests which each define a mapping of
+JS modules to their suggested replacements.
+
+## Usage
+
+You can install this package via NPM:
+
+```sh
+npm i -S module-replacements
+```
+
+You can then import the manifest of your choice:
+
+```ts
+import {NativeReplacements} from 'module-replacements';
+```
+
+## Manifests
+
+We provide three manifests:
+
+- All (includes every manifest)
+- Native replacements (modules which can be replaced by native equivalents)
+- Optimisation replacements (modules which can be replaced by leaner or
+closer-to-the-platform equivalents)
+
+### Native replacements
+
+These are modules which can now be replaced by native functionality.
+
+For example, pseudo-polyfills which provide functionality of widely available
+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.
+
+### Optimisation replacements
+
+These are modules which have more optimal replacements.
+
+For example, some modules have arguably unnecessarily deep dependencies trees,
+or rely on functionality themselves which fit into the "Native replacements"
+category. These should likely be replaced by leaner alternatives.
+
+Another example - modules which are too granularly modularised, leading to
+unnecessarily large amounts of small dependencies (aka "micro dependencies").
+
+Due to this being a one-to-many mapping (there are often many possible
+replacements), this list can contain multiple replacements per module.
+
+# Contributing
+
+If you would like to add a replacement mapping to one of the manifests, please
+open an issue where this can be discussed.
+
+Keep in mind, very newly available native features are unlikely to join the
+list since they are not widely available yet.

package/dist/commonjs/main.d.ts

@@ -0,0 +1,18 @@
+export interface ManifestModule {
+    id: string;
+    replacements: string[];
+}
+export interface ManifestReplacement {
+    id: string;
+    native?: boolean;
+    example: string;
+    url: string;
+}
+export interface Manifest {
+    modules: ManifestModule[];
+    replacements: ManifestReplacement[];
+}
+declare const nativeReplacements: Manifest;
+declare const optimisationReplacements: Manifest;
+export { nativeReplacements, optimisationReplacements };
+export declare const all: Manifest;

package/dist/commonjs/main.js

@@ -0,0 +1,16 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.all = exports.optimisationReplacements = exports.nativeReplacements = void 0;
+const native_json_1 = __importDefault(require("../manifests/native.json"));
+const optimisation_json_1 = __importDefault(require("../manifests/optimisation.json"));
+const nativeReplacements = native_json_1.default;
+exports.nativeReplacements = nativeReplacements;
+const optimisationReplacements = optimisation_json_1.default;
+exports.optimisationReplacements = optimisationReplacements;
+exports.all = {
+    modules: [...native_json_1.default.modules, ...optimisation_json_1.default.modules],
+    replacements: [...native_json_1.default.replacements, ...optimisation_json_1.default.replacements]
+};

package/dist/commonjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/dist/esm/main.d.ts

@@ -0,0 +1,18 @@
+export interface ManifestModule {
+    id: string;
+    replacements: string[];
+}
+export interface ManifestReplacement {
+    id: string;
+    native?: boolean;
+    example: string;
+    url: string;
+}
+export interface Manifest {
+    modules: ManifestModule[];
+    replacements: ManifestReplacement[];
+}
+declare const nativeReplacements: Manifest;
+declare const optimisationReplacements: Manifest;
+export { nativeReplacements, optimisationReplacements };
+export declare const all: Manifest;

package/dist/esm/main.js

@@ -0,0 +1,9 @@
+import native from '../manifests/native.json';
+import optimisation from '../manifests/optimisation.json';
+const nativeReplacements = native;
+const optimisationReplacements = optimisation;
+export { nativeReplacements, optimisationReplacements };
+export const all = {
+    modules: [...native.modules, ...optimisation.modules],
+    replacements: [...native.replacements, ...optimisation.replacements]
+};

package/dist/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "module-replacements",
+  "description": "This package provides a set of manifests which each define a mapping of JS modules to their suggested replacements.",
+  "version": "1.0.0",
+  "main": "./dist/commonjs/main.js",
+  "scripts": {
+    "clean": "rimraf dist main.js",
+    "prepare": "tshy",
+    "format": "prettier --write \"./src/**/*.ts\" \"./manifests/**/*.json\"",
+    "build:types": "tsc --noEmit",
+    "build:bundle": "esbuild src/main.ts --format=esm --outfile=main.js --bundle",
+    "build": "npm run clean && npm run build:bundle && npm run build:types"
+  },
+  "tshy": {
+    "exports": {
+      ".": "./src/main.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "!dist/node_modules"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/es-tooling/module-replacements.git"
+  },
+  "author": "James Garbutt (https://github.com/43081j)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/es-tooling/module-replacements/issues"
+  },
+  "homepage": "https://github.com/es-tooling/module-replacements#readme",
+  "devDependencies": {
+    "esbuild": "^0.20.0",
+    "prettier": "^3.2.4",
+    "rimraf": "^5.0.5",
+    "tshy": "^1.11.0",
+    "typescript": "^5.3.3"
+  },
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/esm/main.d.ts",
+        "default": "./dist/esm/main.js"
+      },
+      "require": {
+        "types": "./dist/commonjs/main.d.ts",
+        "default": "./dist/commonjs/main.js"
+      }
+    }
+  },
+  "types": "./dist/commonjs/main.d.ts",
+  "type": "module"
+}