Class PlatformCompatPhase

Phase F — Detects and patches cross-platform incompatibilities in npm scripts.

Example

const platform = new PlatformCompatPhase();
const result = await platform.Run({
  Dir: '/path/to/install',
  DetectedOS: 'windows',
  Emitter: emitter,
});
console.log(`Patched ${result.ScriptsPatched.length} file(s)`);

Index

Constructors

constructor

Methods

Run

Constructors

constructor

new PlatformCompatPhase(): PlatformCompatPhase
Returns PlatformCompatPhase

Methods

Run

Run(context: PlatformCompatContext): Promise<PlatformCompatResult>
Execute the platform compatibility phase.

Scans all package.json files in the workspace for platform-specific script issues and patches them on Windows. Also emits a heap size advisory for Node >= 24.
Parameters
- context: PlatformCompatContext
  Platform compat input with directory, detected OS, and emitter.
Returns Promise<PlatformCompatResult>
List of patched files and whether cross-env was added.
- Defined in packages/MJInstaller/src/phases/PlatformCompatPhase.ts:144

Class PlatformCompatPhase

Example

Index

Constructors

Methods

Constructors

constructor

Returns PlatformCompatPhase

Methods

Run

Parameters

Returns Promise<PlatformCompatResult>

Settings

On This Page