BREAKING(semver): remove SemVerComparator (#4109)

denoland · Jan 5, 2024 · 5351ef3 · 5351ef3
1 parent 98766d1
commit 5351ef3
Show file tree

Hide file tree

Showing 9 changed files with 25 additions and 49 deletions.
diff --git a/semver/comparator_format.ts b/semver/comparator_format.ts
@@ -1,5 +1,5 @@
 // Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
-import type { SemVerComparator } from "./types.ts";
+import type { Comparator } from "./types.ts";
 import { format } from "./format.ts";
 
 /**
@@ -8,7 +8,7 @@ import { format } from "./format.ts";
  * @param comparator
  * @returns A string representation of the comparator
  */
-export function comparatorFormat(comparator: SemVerComparator): string {
+export function comparatorFormat(comparator: Comparator): string {
   const { semver, operator } = comparator;
   return `${operator}${format(semver)}`;
 }
diff --git a/semver/comparator_intersects.ts b/semver/comparator_intersects.ts
@@ -1,5 +1,5 @@
 // Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
-import type { SemVerComparator } from "./types.ts";
+import type { Comparator } from "./types.ts";
 import { gte } from "./gte.ts";
 import { lte } from "./lte.ts";
 import { comparatorMin } from "./comparator_min.ts";
@@ -11,8 +11,8 @@ import { comparatorMax } from "./comparator_max.ts";
  * @returns True if any part of the comparators intersect
  */
 export function comparatorIntersects(
-  c0: SemVerComparator,
-  c1: SemVerComparator,
+  c0: Comparator,
+  c1: Comparator,
 ): boolean {
   const l0 = comparatorMin(c0.semver, c0.operator);
   const l1 = comparatorMax(c0.semver, c0.operator);

diff --git a/semver/constants.ts b/semver/constants.ts
@@ -1,5 +1,5 @@
 // Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
-import type { SemVer, SemVerComparator } from "./types.ts";
+import type { Comparator, SemVer } from "./types.ts";
 
 /**
  * MAX is a sentinel value used by some range calculations.
@@ -65,19 +65,15 @@ export const ANY: SemVer = {
 /**
  * A comparator which will span all valid semantic versions
  */
-export const ALL: SemVerComparator = {
+export const ALL: Comparator = {
   operator: "",
   semver: ANY,
-  min: MIN,
-  max: MAX,
 };
 
 /**
  * A comparator which will not span any semantic versions
  */
-export const NONE: SemVerComparator = {
+export const NONE: Comparator = {
   operator: "<",
   semver: MIN,
-  min: MAX,
-  max: MIN,
 };
diff --git a/semver/outside.ts b/semver/outside.ts
@@ -4,7 +4,7 @@ import { gte } from "./gte.ts";
 import { lte } from "./lte.ts";
 import { lt } from "./lt.ts";
 import { ALL, ANY } from "./constants.ts";
-import type { SemVer, SemVerComparator, SemVerRange } from "./types.ts";
+import type { Comparator, SemVer, SemVerRange } from "./types.ts";
 import { testRange } from "./test_range.ts";
 
 /**
@@ -40,8 +40,8 @@ export function outside(
   }
 
   for (const comparators of range.ranges) {
-    let high: SemVerComparator | undefined = undefined;
-    let low: SemVerComparator | undefined = undefined;
+    let high: Comparator | undefined = undefined;
+    let low: Comparator | undefined = undefined;
     for (let comparator of comparators) {
       if (comparator.semver === ANY) {
         comparator = ALL;

diff --git a/semver/parse_comparator.ts b/semver/parse_comparator.ts
@@ -1,13 +1,11 @@
 // Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
-import type { Operator, SemVerComparator } from "./types.ts";
+import type { Comparator, Operator } from "./types.ts";
 import {
   COMPARATOR_REGEXP,
   parseBuild,
   parseNumber,
   parsePrerelease,
 } from "./_shared.ts";
-import { comparatorMin } from "./comparator_min.ts";
-import { comparatorMax } from "./comparator_max.ts";
 import { ANY, NONE } from "./constants.ts";
 
 type REGEXP_GROUPS = {
@@ -20,11 +18,11 @@ type REGEXP_GROUPS = {
 };
 
 /**
- * Parses a comparator string into a valid SemVerComparator.
+ * Parses a comparator string into a valid Comparator.
  * @param comparator
- * @returns A valid SemVerComparator
+ * @returns A valid Comparator
  */
-export function parseComparator(comparator: string): SemVerComparator {
+export function parseComparator(comparator: string): Comparator {
   const match = comparator.match(COMPARATOR_REGEXP);
   const groups = match?.groups;
 
@@ -47,8 +45,5 @@ export function parseComparator(comparator: string): SemVerComparator {
     }
     : ANY;
 
-  const min = comparatorMin(semver, operator);
-  const max = comparatorMax(semver, operator);
-
-  return { operator, semver, min, max };
+  return { operator, semver };
 }
diff --git a/semver/range_intersects.ts b/semver/range_intersects.ts
@@ -1,6 +1,6 @@
 // Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
 import { comparatorIntersects } from "./comparator_intersects.ts";
-import type { SemVerComparator, SemVerRange } from "./types.ts";
+import type { Comparator, SemVerRange } from "./types.ts";
 
 function rangesSatisfiable(ranges: SemVerRange[]): boolean {
   return ranges.every((r) => {
@@ -9,7 +9,7 @@ function rangesSatisfiable(ranges: SemVerRange[]): boolean {
   });
 }
 
-function comparatorsSatisfiable(comparators: SemVerComparator[]): boolean {
+function comparatorsSatisfiable(comparators: Comparator[]): boolean {
   // Comparators are satisfiable if they all intersect with each other
   for (let i = 0; i < comparators.length - 1; i++) {
     const c0 = comparators[i];

diff --git a/semver/test_comparator.ts b/semver/test_comparator.ts
@@ -1,5 +1,5 @@
 // Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
-import type { SemVer, SemVerComparator } from "./types.ts";
+import type { Comparator, SemVer } from "./types.ts";
 import { cmp } from "./cmp.ts";
 
 /**
@@ -11,7 +11,7 @@ import { cmp } from "./cmp.ts";
  */
 export function testComparator(
   version: SemVer,
-  comparator: SemVerComparator,
+  comparator: Comparator,
 ): boolean {
   return cmp(version, comparator.operator, comparator.semver);
 }
diff --git a/semver/try_parse_comparator.ts b/semver/try_parse_comparator.ts
@@ -1,15 +1,15 @@
 // Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
 
-import { SemVerComparator } from "./types.ts";
+import { Comparator } from "./types.ts";
 import { parseComparator } from "./parse_comparator.ts";
 /**
- * Parses a comparator string into a valid SemVerComparator or returns undefined if not valid.
+ * Parses a comparator string into a valid Comparator or returns undefined if not valid.
  * @param comparator
- * @returns A valid SemVerComparator or undefined
+ * @returns A valid Comparator or undefined
  */
 export function tryParseComparator(
   comparator: string,
-): SemVerComparator | undefined {
+): Comparator | undefined {
   try {
     return parseComparator(comparator);
   } catch {

diff --git a/semver/types.ts b/semver/types.ts
@@ -43,21 +43,6 @@ export interface Comparator {
   operator: Operator;
   semver: SemVer;
 }
-/**
- * @deprecated (will be removed in 0.212.0) Use {@linkcode Comparator} instead.
- */
-export interface SemVerComparator {
-  operator: Operator;
-  semver: SemVer;
-  /**
-   * @deprecated (will be removed in 0.212.0) use {@linkcode comparatorMin} instead.
-   */
-  min: SemVer;
-  /**
-   * @deprecated (will be removed in 0.212.0) use {@linkcode comparatorMin} instead.
-   */
-  max: SemVer;
-}
 
 /**
  * A SemVer object parsed into its constituent parts.
@@ -70,7 +55,7 @@ export interface SemVer {
   build?: string[];
 }
 
-type SemVerRangeAnd = SemVerComparator[];
+type SemVerRangeAnd = Comparator[];
 type SemVerRangeOr = SemVerRangeAnd[];
 
 /**