feat: support includePrerelease option

Author: motea927

src/checkPeerDependencies/peerDependencies.spec.ts

@@ -175,6 +175,7 @@ describe("findSolutions", () => {
     const { resolutionsWithSolutions, nosolution } = findSolutions(
       mockProblems,
       mockAllNestedPeerDependencies,
+      { ...DEFAULT_VALUE },
     );
 
     expect(resolutionsWithSolutions).toEqual([mockResolutions[0]]);

src/checkPeerDependencies/peerDependencies.ts

@@ -48,11 +48,13 @@ export function getAllNestedPeerDependencies(
 export function findSolutions(
   problems: Dependency[],
   allNestedPeerDependencies: Dependency[],
+  options: CliOptions,
 ): { resolutionsWithSolutions: Resolution[]; nosolution: Resolution[] } {
   printSearchMessage(problems.length);
   const resolutions: Resolution[] = findPossibleResolutions(
     problems,
     allNestedPeerDependencies,
+    options,
   );
   const resolutionsWithSolutions = getResolutionsWithSolutions(resolutions);
   const nosolution = getNoSolutionResolutions(resolutions);
@@ -129,6 +131,7 @@ export function checkPeerDependencies(options: CliOptions): void {
     const { nosolution, resolutionsWithSolutions } = findSolutions(
       problems,
       allNestedPeerDependencies,
+      options,
     );
     const commandLines = getCommandLines(resolutionsWithSolutions);
 
@@ -139,6 +142,7 @@ export function checkPeerDependencies(options: CliOptions): void {
     const { resolutionsWithSolutions } = findSolutions(
       problems,
       allNestedPeerDependencies,
+      options,
     );
     const commandLines = getCommandLines(resolutionsWithSolutions);
 

src/constants.ts

@@ -11,4 +11,5 @@ export const DEFAULT_VALUE = Object.freeze({
   runOnlyOnRootDependencies: false,
   findSolutions: false,
   install: false,
+  includePrerelease: true,
 });

src/index.ts

@@ -67,10 +67,12 @@ export function getCliArgv() {
         description: "Install missing or incorrect peerDependencies",
       },
     })
-    // .option({
-    //   includePrerelease: { type: "boolean", default: false },
-    // })
-
+    .option({
+      includePrerelease: {
+        type: "boolean",
+        default: DEFAULT_VALUE.includePrerelease,
+      },
+    })
     .parseSync();
   return argv satisfies CliOptions;
 }

src/solution/solution.spec.ts

@@ -1,4 +1,5 @@
 import { describe, it, expect, vi } from "vitest";
+import { DEFAULT_VALUE } from "../constants";
 import type { Dependency } from "../packageUtils";
 import {
   getUniqueProblems,
@@ -151,17 +152,36 @@ describe("semverReverseSort", () => {
 });
 
 describe("findPossibleResolution", () => {
-  it("should find a possible resolution for a package", () => {
+  it("should find a possible resolution for a package with pre-release", () => {
     const packageName = "dep1";
     const allPeerDeps: Dependency[] = [defaultDependency];
 
     vi.mocked(mocks.execSync).mockReturnValueOnce(
-      JSON.stringify(["2.0.1", "1.0.0", "3.0.0", "1.5.2"]),
+      JSON.stringify(["2.0.1", "1.0.0", "3.0.0", "1.5.2-beta.1"]),
     );
 
-    const resolution = findPossibleResolution(packageName, allPeerDeps);
+    const resolution = findPossibleResolution(packageName, allPeerDeps, {
+      ...DEFAULT_VALUE,
+      includePrerelease: true,
+    });
 
-    expect(resolution).toBe("1.5.2");
+    expect(resolution).toBe("1.5.2-beta.1");
+  });
+
+  it("should find a possible resolution for a package without pre-release", () => {
+    const packageName = "dep1";
+    const allPeerDeps: Dependency[] = [defaultDependency];
+
+    vi.mocked(mocks.execSync).mockReturnValueOnce(
+      JSON.stringify(["2.0.1", "1.0.0", "3.0.0", "1.5.2-beta.1"]),
+    );
+
+    const resolution = findPossibleResolution(packageName, allPeerDeps, {
+      ...DEFAULT_VALUE,
+      includePrerelease: false,
+    });
+
+    expect(resolution).toBe("1.0.0");
   });
 });
 

src/solution/solution.ts

@@ -1,6 +1,7 @@
 import { execSync } from "node:child_process";
 import semver from "semver";
 import type { Dependency } from "../packageUtils/types";
+import type { CliOptions } from "../types";
 import type { Resolution } from "./types";
 
 export function getUniqueProblems(problems: Dependency[]): Dependency[] {
@@ -39,6 +40,7 @@ export function semverReverseSort(a: string, b: string) {
 export function findPossibleResolution(
   packageName: string,
   allPeerDeps: Dependency[],
+  options: CliOptions,
 ) {
   const requiredPeerVersions = allPeerDeps.filter(
     (dep) => dep.name === packageName,
@@ -56,7 +58,7 @@ export function findPossibleResolution(
     return availableVersions.find((ver: string) =>
       requiredPeerVersions.every((peerVer) => {
         return semver.satisfies(ver, peerVer.version, {
-          includePrerelease: true,
+          includePrerelease: options.includePrerelease,
         });
       }),
     );
@@ -72,8 +74,9 @@ export function findPossibleResolution(
 export function determineResolutionVersion(
   problem: Dependency,
   allPeerDependencies: Dependency[],
+  options: CliOptions,
 ): string {
-  return findPossibleResolution(problem.name, allPeerDependencies);
+  return findPossibleResolution(problem.name, allPeerDependencies, options);
 }
 
 export function formatResolution(
@@ -86,6 +89,7 @@ export function formatResolution(
 export function findPossibleResolutions(
   problems: Dependency[],
   allPeerDependencies: Dependency[],
+  options: CliOptions,
 ): Resolution[] {
   const uniqProblems = getUniqueProblems(problems);
 
@@ -94,6 +98,7 @@ export function findPossibleResolutions(
     const resolutionVersion = determineResolutionVersion(
       problem,
       allPeerDependencies,
+      options,
     );
     const resolution = formatResolution(problem, resolutionVersion);
     return { problem, resolution, resolutionType } as Resolution;

src/types.ts

@@ -11,4 +11,5 @@ export interface CliOptions {
   orderBy: OrderBy;
   findSolutions: boolean;
   install: boolean;
+  includePrerelease: boolean;
 }