projen 0.99.28 → 0.99.30

package/lib/javascript/node-package.d.ts

@@ -133,7 +133,8 @@ export interface NodePackageOptions {
     /**
      * The Node Package Manager used to execute scripts
      *
-     * @default NodePackageManager.YARN_CLASSIC
+     * @default - Detected from the calling process or `YARN_CLASSIC` if detection fails.
+     * @pjnew $PACKAGE_MANAGER
      */
     readonly packageManager?: NodePackageManager;
     /**
@@ -304,6 +305,81 @@ export interface NodePackageOptions {
      * @default - Yarn Berry v4 with all default options
      */
     readonly yarnBerryOptions?: YarnBerryOptions;
+    /**
+     * Configure the `devEngines` field in `package.json`.
+     *
+     * The `devEngines.packageManager` field is automatically populated based on
+     * the resolved `packageManager` value. Any fields provided here are merged
+     * with the auto-populated `packageManager` entry.
+     *
+     * @see https://docs.npmjs.com/cli/v10/configuring-npm/package-json#devengines
+     */
+    readonly devEngines?: DevEngines;
+    /**
+     * Automatically add the resolved `packageManager` to `devEngines.packageManager`
+     * in `package.json`.
+     *
+     * @default true
+     */
+    readonly addPackageManagerToDevEngines?: boolean;
+    /**
+     * Automatically delete lockfiles from package managers that are not the
+     * active one. Only triggered when the lockfile for the configured package
+     * manager already exists.
+     *
+     * This is useful when migrating between package managers to avoid conflicts.
+     *
+     * @default true
+     */
+    readonly deleteOrphanedLockFiles?: boolean;
+}
+/**
+ * A dependency entry for the `devEngines` field in `package.json`.
+ */
+export interface DevEngineDependency {
+    /**
+     * The name of the dependency.
+     */
+    readonly name: string;
+    /**
+     * The version range for the dependency.
+     *
+     * @default "*"
+     */
+    readonly version?: string;
+    /**
+     * What action to take if validation fails.
+     *
+     * @default "error"
+     */
+    readonly onFail?: "ignore" | "warn" | "error" | "download";
+}
+/**
+ * The `devEngines` field in `package.json`.
+ *
+ * @see https://docs.npmjs.com/cli/v10/configuring-npm/package-json#devengines
+ */
+export interface DevEngines {
+    /**
+     * Supported operating systems.
+     */
+    readonly os?: DevEngineDependency | DevEngineDependency[];
+    /**
+     * Supported CPU architectures.
+     */
+    readonly cpu?: DevEngineDependency | DevEngineDependency[];
+    /**
+     * Supported C standard libraries.
+     */
+    readonly libc?: DevEngineDependency | DevEngineDependency[];
+    /**
+     * Supported JavaScript runtimes.
+     */
+    readonly runtime?: DevEngineDependency | DevEngineDependency[];
+    /**
+     * Supported package managers.
+     */
+    readonly packageManager?: DevEngineDependency | DevEngineDependency[];
 }
 /**
  * Options for authorizing requests to a AWS CodeArtifact npm repository.
@@ -487,6 +563,7 @@ export declare class NodePackage extends Component {
     private readonly peerDependencyOptions;
     private readonly _prev?;
     private _renderedDeps?;
+    private readonly _packageManagerExplicit;
     constructor(project: Project, options?: NodePackageOptions);
     /**
      * Defines normal dependencies.
@@ -642,6 +719,8 @@ export declare class NodePackage extends Component {
     private renderPublishConfig;
     private renderKeywords;
     private renderEngines;
+    private renderDevEngines;
+    private deleteOrphanedLockFiles;
     private autoDiscoverBinaries;
     private renderAuthor;
     private renderBin;