Package org.openrewrite.javascript.internal

Class LockFileRegeneration

java.lang.Object

org.openrewrite.javascript.internal.LockFileRegeneration

public final class LockFileRegeneration
extends Object

Regenerate a JavaScript project's lock file by running the package manager in a temp directory seeded with the package.json and (optionally) the existing lock file plus config files such as .npmrc.

Pre-configured instances are provided for each NodeResolutionResult.PackageManager; forPackageManager(PackageManager) dispatches to the right one. The install args are preserved verbatim from the TypeScript implementation in rewrite-javascript/rewrite/src/javascript/package-manager.ts.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LockFileRegeneration.Result

Field Summary

Fields

Modifier and Type	Field	Description
static final LockFileRegeneration	BUN
static final LockFileRegeneration	NPM
static final LockFileRegeneration	PNPM
static final LockFileRegeneration	YARN_BERRY
static final LockFileRegeneration	YARN_CLASSIC

Method Summary

Modifier and Type	Method	Description
static @Nullable LockFileRegeneration	forPackageManager(@Nullable NodeResolutionResult.PackageManager pm)
String	getLockFile()
LockFileRegeneration.Result	regenerate(String packageJsonContent)
LockFileRegeneration.Result	regenerate(String packageJsonContent, @Nullable String existingLockContent)
LockFileRegeneration.Result	regenerate(String packageJsonContent, @Nullable String existingLockContent, @Nullable Map<String,String> configFiles)	Regenerate the lock file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NPM

public static final LockFileRegeneration NPM

YARN_CLASSIC

public static final LockFileRegeneration YARN_CLASSIC

YARN_BERRY

public static final LockFileRegeneration YARN_BERRY

PNPM

public static final LockFileRegeneration PNPM

BUN

public static final LockFileRegeneration BUN

Method Details

forPackageManager

public static @Nullable LockFileRegeneration forPackageManager(@Nullable NodeResolutionResult.PackageManager pm)

getLockFile

public String getLockFile()

regenerate

public LockFileRegeneration.Result regenerate(String packageJsonContent)

regenerate

public LockFileRegeneration.Result regenerate(String packageJsonContent,
 @Nullable String existingLockContent)

regenerate

public LockFileRegeneration.Result regenerate(String packageJsonContent,
 @Nullable String existingLockContent,
 @Nullable Map<String,String> configFiles)

Regenerate the lock file. Optional inputs:

• existingLockContent — when present, seeded into the temp dir so the package manager performs a minimal update rather than a full re-resolve.
• configFiles — extra files to seed into the temp dir (typically {".npmrc": "..."}).