@mf-toolkit/shared-inspector 0.1.0

package/dist/types.d.ts

@@ -0,0 +1,179 @@
+export interface SharedDepConfig {
+    singleton?: boolean;
+    eager?: boolean;
+    requiredVersion?: string;
+}
+export interface PackageOccurrence {
+    package: string;
+    /** File where the package was observed */
+    file: string;
+    /** 'direct' = explicit import/require; 'reexport' = found via barrel re-export chain */
+    via: 'direct' | 'reexport';
+}
+export type ParserStrategy = 'regex' | 'typescript';
+export interface CollectorOptions {
+    /** Project name (written into the manifest) */
+    name: string;
+    /** Directories to scan for source files */
+    sourceDirs: string[];
+    /**
+     * Scan depth.
+     * - 'direct': regex-scan imports/requires only (fast, shallow)
+     * - 'local-graph': + recursive local module traversal to find packages behind barrel re-exports
+     * @default 'local-graph'
+     */
+    depth?: 'direct' | 'local-graph';
+    /** Shared config from Module Federation */
+    sharedConfig?: Record<string, SharedDepConfig>;
+    /** Project role. @default 'unknown' */
+    kind?: 'host' | 'remote' | 'unknown';
+    /** Path to package.json. @default './package.json' */
+    packageJsonPath?: string;
+    /** File extensions to scan. @default ['.ts', '.tsx', '.js', '.jsx'] */
+    extensions?: string[];
+    /** Packages to exclude from scan results (supports glob: '@company/*') */
+    ignore?: string[];
+    /**
+     * Path to tsconfig.json for resolving TypeScript path aliases (e.g. '@app/*').
+     * When provided, aliased imports are followed during local-graph traversal
+     * just like relative imports — packages behind aliases become visible.
+     * @default undefined (aliases not resolved)
+     */
+    tsconfigPath?: string;
+    /**
+     * Local workspace package names to treat as internal (not external packages).
+     * Imports matching these names are excluded from resolvedPackages.
+     * Supports exact names and '@scope/*' globs.
+     * @example ['@my-org/design-system', '@my-org/*']
+     */
+    workspacePackages?: string[];
+    /** Parser strategy. @default 'regex' */
+    parser?: ParserStrategy;
+}
+export interface ProjectManifest {
+    schemaVersion: 1;
+    generatedAt: string;
+    project: {
+        name: string;
+        root: string;
+        kind?: 'host' | 'remote' | 'unknown';
+    };
+    source: {
+        /** Depth at which facts were collected — determines what is observable in this manifest */
+        depth: 'direct' | 'local-graph';
+        sourceDirs: string[];
+        filesScanned: number;
+    };
+    usage: {
+        /** Packages found via direct import/require declarations */
+        directPackages: string[];
+        /**
+         * Full package list including packages reachable via local module chains.
+         * Equals directPackages when depth === 'direct'.
+         */
+        resolvedPackages: string[];
+        /**
+         * Per-package details.
+         * importCount = number of unique files from which the package is observed (= files.length).
+         */
+        packageDetails: Array<{
+            package: string;
+            importCount: number;
+            files: string[];
+            via: 'direct' | 'reexport';
+        }>;
+    };
+    shared: {
+        /** Normalised shared config from webpack/rspack */
+        declared: Record<string, {
+            singleton?: boolean;
+            eager?: boolean;
+            requiredVersion?: string;
+        }>;
+        source: 'explicit' | 'extracted-from-plugin';
+    };
+    versions: {
+        /** From package.json dependencies + devDependencies */
+        declared: Record<string, string>;
+        /**
+         * From node_modules/<pkg>/package.json.
+         * Empty object when node_modules is not accessible — mismatch checks are skipped
+         * for packages absent from this map.
+         */
+        installed: Record<string, string>;
+    };
+}
+export interface AnalysisOptions {
+    /**
+     * Packages that will never appear in the `unused` list.
+     * Useful for packages consumed transitively (JSX Transform, UI-kit peer deps).
+     * @default ['react', 'react-dom']
+     */
+    alwaysShared?: string[];
+    /**
+     * Additional packages to add to the built-in share-candidates list.
+     */
+    additionalCandidates?: string[];
+    /**
+     * Additional packages to add to the built-in singleton-risk list.
+     */
+    additionalSingletonRisks?: string[];
+}
+export interface UnusedEntry {
+    package: string;
+    singleton: boolean;
+}
+export interface CandidateEntry {
+    package: string;
+    importCount: number;
+    files: string[];
+    via: 'direct' | 'reexport';
+}
+export interface MismatchedEntry {
+    package: string;
+    configured: string;
+    installed: string;
+}
+export interface SingletonRiskEntry {
+    package: string;
+}
+export interface EagerRiskEntry {
+    /** Package declared with eager: true but without singleton: true.
+     *  Eager-loading without singleton can cause duplicate module instances
+     *  when multiple MFs load the same package before negotiation completes. */
+    package: string;
+}
+export interface ProjectReport {
+    /** Packages in shared config not observed in resolvedPackages */
+    unused: UnusedEntry[];
+    /** Observed packages not in shared config that are typically shared */
+    candidates: CandidateEntry[];
+    /** requiredVersion does not satisfy installed version */
+    mismatched: MismatchedEntry[];
+    /** Packages with global state shared without singleton: true */
+    singletonRisks: SingletonRiskEntry[];
+    /** Packages declared with eager: true but without singleton: true */
+    eagerRisks: EagerRiskEntry[];
+    summary: {
+        totalShared: number;
+        usedShared: number;
+        unusedCount: number;
+        candidatesCount: number;
+        mismatchedCount: number;
+        singletonRisksCount: number;
+        eagerRisksCount: number;
+    };
+}
+export interface WebpackPluginOptions extends Omit<CollectorOptions, 'name'> {
+    /** Policy options for the analyzer */
+    analysis?: AnalysisOptions;
+    /** Print warnings to console. @default true */
+    warn?: boolean;
+    /** Fail the build when these findings are present */
+    failOn?: 'mismatch' | 'unused' | 'any';
+    /** Write project-manifest.json to outputDir. @default false */
+    writeManifest?: boolean;
+    /** Output directory for manifest file. @default '.' */
+    outputDir?: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,eAAe;IAC9B,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAID,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,0CAA0C;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb,wFAAwF;IACxF,GAAG,EAAE,QAAQ,GAAG,UAAU,CAAC;CAC5B;AAED,MAAM,MAAM,cAAc,GAAG,OAAO,GAAG,YAAY,CAAC;AAEpD,MAAM,WAAW,gBAAgB;IAC/B,+CAA+C;IAC/C,IAAI,EAAE,MAAM,CAAC;IACb,2CAA2C;IAC3C,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,QAAQ,GAAG,aAAa,CAAC;IACjC,2CAA2C;IAC3C,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAC/C,uCAAuC;IACvC,IAAI,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAC;IACrC,sDAAsD;IACtD,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,uEAAuE;IACvE,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,0EAA0E;IAC1E,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B,wCAAwC;IACxC,MAAM,CAAC,EAAE,cAAc,CAAC;CACzB;AAID,MAAM,WAAW,eAAe;IAC9B,aAAa,EAAE,CAAC,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IAEpB,OAAO,EAAE;QACP,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAC;KACtC,CAAC;IAEF,MAAM,EAAE;QACN,2FAA2F;QAC3F,KAAK,EAAE,QAAQ,GAAG,aAAa,CAAC;QAChC,UAAU,EAAE,MAAM,EAAE,CAAC;QACrB,YAAY,EAAE,MAAM,CAAC;KACtB,CAAC;IAEF,KAAK,EAAE;QACL,4DAA4D;QAC5D,cAAc,EAAE,MAAM,EAAE,CAAC;QACzB;;;WAGG;QACH,gBAAgB,EAAE,MAAM,EAAE,CAAC;QAC3B;;;WAGG;QACH,cAAc,EAAE,KAAK,CAAC;YACpB,OAAO,EAAE,MAAM,CAAC;YAChB,WAAW,EAAE,MAAM,CAAC;YACpB,KAAK,EAAE,MAAM,EAAE,CAAC;YAChB,GAAG,EAAE,QAAQ,GAAG,UAAU,CAAC;SAC5B,CAAC,CAAC;KACJ,CAAC;IAEF,MAAM,EAAE;QACN,mDAAmD;QACnD,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE;YACvB,SAAS,CAAC,EAAE,OAAO,CAAC;YACpB,KAAK,CAAC,EAAE,OAAO,CAAC;YAChB,eAAe,CAAC,EAAE,MAAM,CAAC;SAC1B,CAAC,CAAC;QACH,MAAM,EAAE,UAAU,GAAG,uBAAuB,CAAC;KAC9C,CAAC;IAEF,QAAQ,EAAE;QACR,uDAAuD;QACvD,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACjC;;;;WAIG;QACH,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KACnC,CAAC;CACH;AAID,MAAM,WAAW,eAAe;IAC9B;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAChC;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,EAAE,CAAC;CACrC;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,GAAG,EAAE,QAAQ,GAAG,UAAU,CAAC;CAC5B;AAED,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,cAAc;IAC7B;;gFAE4E;IAC5E,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,aAAa;IAC5B,iEAAiE;IACjE,MAAM,EAAE,WAAW,EAAE,CAAC;IACtB,uEAAuE;IACvE,UAAU,EAAE,cAAc,EAAE,CAAC;IAC7B,yDAAyD;IACzD,UAAU,EAAE,eAAe,EAAE,CAAC;IAC9B,gEAAgE;IAChE,cAAc,EAAE,kBAAkB,EAAE,CAAC;IACrC,qEAAqE;IACrE,UAAU,EAAE,cAAc,EAAE,CAAC;IAC7B,OAAO,EAAE;QACP,WAAW,EAAE,MAAM,CAAC;QACpB,UAAU,EAAE,MAAM,CAAC;QACnB,WAAW,EAAE,MAAM,CAAC;QACpB,eAAe,EAAE,MAAM,CAAC;QACxB,eAAe,EAAE,MAAM,CAAC;QACxB,mBAAmB,EAAE,MAAM,CAAC;QAC5B,eAAe,EAAE,MAAM,CAAC;KACzB,CAAC;CACH;AAID,MAAM,WAAW,oBAAqB,SAAQ,IAAI,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAC1E,sCAAsC;IACtC,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B,+CAA+C;IAC/C,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,qDAAqD;IACrD,MAAM,CAAC,EAAE,UAAU,GAAG,QAAQ,GAAG,KAAK,CAAC;IACvC,+DAA+D;IAC/D,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,uDAAuD;IACvD,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB"}

package/dist/types.js

@@ -0,0 +1,3 @@
+// ─── Shared config ───────────────────────────────────────────────────────────
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,gFAAgF"}

package/dist/webpack.d.ts

@@ -0,0 +1,3 @@
+export { MfSharedInspectorPlugin } from './plugins/webpack.js';
+export type { WebpackPluginOptions } from './types.js';
+//# sourceMappingURL=webpack.d.ts.map

package/dist/webpack.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webpack.d.ts","sourceRoot":"","sources":["../src/webpack.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,YAAY,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC"}

package/dist/webpack.js

@@ -0,0 +1,2 @@
+export { MfSharedInspectorPlugin } from './plugins/webpack.js';
+//# sourceMappingURL=webpack.js.map

package/dist/webpack.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"webpack.js","sourceRoot":"","sources":["../src/webpack.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAC"}

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@mf-toolkit/shared-inspector",
+  "version": "0.1.0",
+  "description": "Build-time shared dependency analyzer for Module Federation.",
+  "author": "Vitaly Zheltko",
+  "license": "MIT",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./webpack": {
+      "types": "./dist/plugins/webpack.d.ts",
+      "default": "./dist/plugins/webpack.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest run",
+    "lint": "tsc --noEmit"
+  },
+  "keywords": [
+    "microfrontend",
+    "module-federation",
+    "shared",
+    "webpack",
+    "analyzer"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/zvitaly7/mf-toolkit",
+    "directory": "packages/shared-inspector"
+  },
+  "dependencies": {
+    "semver": "^7.6.0"
+  },
+  "peerDependencies": {
+    "typescript": ">=4.7"
+  },
+  "peerDependenciesMeta": {
+    "typescript": { "optional": true }
+  },
+  "devDependencies": {
+    "@types/semver": "^7.5.8",
+    "@types/node": "^25.4.0",
+    "typescript": "^5.9.3"
+  }
+}