module-replacements 2.10.1 → 3.0.0-beta.0

package/README.md

@@ -5,6 +5,7 @@ provides a collection of module replacements (i.e. possible alternative
 packages).
 
 We provide two things:
+
 - Manifests (mappings of modules to their possible replacements)
 - Documentation for more complex replacements
 
@@ -17,11 +18,10 @@ You can find a list of replacements in the
 
 Some tools consume the lists of modules in this repository:
 
-| Name | Description |
-| -- | -- |
+| 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.
@@ -82,3 +82,11 @@ 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.
+
+## Sponsors
+
+<p align="center">
+  <a href="https://github.com/sponsors/e18e">
+    <img src="https://e18e.dev/sponsors.svg" alt="e18e community sponsors" />
+  </a>
+</p>

package/dist/commonjs/main.js

@@ -25,9 +25,14 @@ const preferredReplacements = JSON.parse((0, node_fs_1.readFileSync)(`${manifest
 exports.preferredReplacements = preferredReplacements;
 __exportStar(require("./types.js"), exports);
 exports.all = {
-    moduleReplacements: [
-        ...nativeReplacements.moduleReplacements,
-        ...microUtilsReplacements.moduleReplacements,
-        ...preferredReplacements.moduleReplacements
-    ]
+    replacements: {
+        ...nativeReplacements.replacements,
+        ...microUtilsReplacements.replacements,
+        ...preferredReplacements.replacements
+    },
+    mappings: {
+        ...nativeReplacements.mappings,
+        ...microUtilsReplacements.mappings,
+        ...preferredReplacements.mappings
+    }
 };

package/dist/commonjs/manifests-dir.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.manifestsDir = void 0;
 const path = __importStar(require("node:path"));

package/dist/commonjs/types.d.ts

@@ -1,27 +1,55 @@
+export interface EngineConstraint {
+    engine: string;
+    minVersion?: string;
+    maxVersion?: string;
+}
+export interface KnownUrlDescriptor {
+    type: 'mdn' | 'node' | 'e18e';
+    id: string;
+}
+export type KnownUrl = KnownUrlDescriptor | string;
 interface ModuleReplacementLike {
-    type: string;
-    moduleName: string;
-    category?: string;
+    id: string;
+    engines?: EngineConstraint[];
+    preferred?: boolean;
+    url?: KnownUrl;
 }
 export interface DocumentedModuleReplacement extends ModuleReplacementLike {
     type: 'documented';
-    docPath: string;
+    url: KnownUrl;
+    replacementModule: string;
 }
 export interface NativeModuleReplacement extends ModuleReplacementLike {
     type: 'native';
-    mdnPath: string;
-    nodeVersion: string;
-    replacement: string;
+    url: KnownUrl;
+    description?: string;
+    webFeatureId?: {
+        featureId: string;
+        compatKey: string;
+    };
+    nodeFeatureId?: {
+        moduleName: string;
+        exportName?: string;
+    };
 }
 export interface SimpleModuleReplacement extends ModuleReplacementLike {
     type: 'simple';
-    replacement: string;
+    description: string;
+    example?: string;
 }
-export interface NoModuleReplacement extends ModuleReplacementLike {
-    type: 'none';
+export interface RemovalReplacement extends ModuleReplacementLike {
+    type: 'removal';
+    description: string;
+}
+export type ModuleReplacement = DocumentedModuleReplacement | NativeModuleReplacement | SimpleModuleReplacement | RemovalReplacement;
+export interface ModuleReplacementMapping {
+    type: 'module';
+    moduleName: string;
+    replacements: string[];
+    url?: KnownUrl;
 }
-export type ModuleReplacement = DocumentedModuleReplacement | NativeModuleReplacement | SimpleModuleReplacement | NoModuleReplacement;
 export interface ManifestModule {
-    moduleReplacements: ModuleReplacement[];
+    mappings: Record<string, ModuleReplacementMapping>;
+    replacements: Record<string, ModuleReplacement>;
 }
 export {};

package/dist/esm/main.js

@@ -6,9 +6,14 @@ const preferredReplacements = JSON.parse(readFileSync(`${manifestsDir}/preferred
 export * from './types.js';
 export { nativeReplacements, microUtilsReplacements, preferredReplacements };
 export const all = {
-    moduleReplacements: [
-        ...nativeReplacements.moduleReplacements,
-        ...microUtilsReplacements.moduleReplacements,
-        ...preferredReplacements.moduleReplacements
-    ]
+    replacements: {
+        ...nativeReplacements.replacements,
+        ...microUtilsReplacements.replacements,
+        ...preferredReplacements.replacements
+    },
+    mappings: {
+        ...nativeReplacements.mappings,
+        ...microUtilsReplacements.mappings,
+        ...preferredReplacements.mappings
+    }
 };

package/dist/esm/types.d.ts

@@ -1,27 +1,55 @@
+export interface EngineConstraint {
+    engine: string;
+    minVersion?: string;
+    maxVersion?: string;
+}
+export interface KnownUrlDescriptor {
+    type: 'mdn' | 'node' | 'e18e';
+    id: string;
+}
+export type KnownUrl = KnownUrlDescriptor | string;
 interface ModuleReplacementLike {
-    type: string;
-    moduleName: string;
-    category?: string;
+    id: string;
+    engines?: EngineConstraint[];
+    preferred?: boolean;
+    url?: KnownUrl;
 }
 export interface DocumentedModuleReplacement extends ModuleReplacementLike {
     type: 'documented';
-    docPath: string;
+    url: KnownUrl;
+    replacementModule: string;
 }
 export interface NativeModuleReplacement extends ModuleReplacementLike {
     type: 'native';
-    mdnPath: string;
-    nodeVersion: string;
-    replacement: string;
+    url: KnownUrl;
+    description?: string;
+    webFeatureId?: {
+        featureId: string;
+        compatKey: string;
+    };
+    nodeFeatureId?: {
+        moduleName: string;
+        exportName?: string;
+    };
 }
 export interface SimpleModuleReplacement extends ModuleReplacementLike {
     type: 'simple';
-    replacement: string;
+    description: string;
+    example?: string;
 }
-export interface NoModuleReplacement extends ModuleReplacementLike {
-    type: 'none';
+export interface RemovalReplacement extends ModuleReplacementLike {
+    type: 'removal';
+    description: string;
+}
+export type ModuleReplacement = DocumentedModuleReplacement | NativeModuleReplacement | SimpleModuleReplacement | RemovalReplacement;
+export interface ModuleReplacementMapping {
+    type: 'module';
+    moduleName: string;
+    replacements: string[];
+    url?: KnownUrl;
 }
-export type ModuleReplacement = DocumentedModuleReplacement | NativeModuleReplacement | SimpleModuleReplacement | NoModuleReplacement;
 export interface ManifestModule {
-    moduleReplacements: ModuleReplacement[];
+    mappings: Record<string, ModuleReplacementMapping>;
+    replacements: Record<string, ModuleReplacement>;
 }
 export {};