refactor(semver): remove isOperator() and cleanup isComparator() (#…

…4038) refactor: remove `semver.isOperator()`
denoland · Dec 30, 2023 · c9f4020 · c9f4020
1 parent 756ddf3
commit c9f4020
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 62 deletions.
diff --git a/semver/_constants.ts b/semver/_constants.ts
@@ -0,0 +1,14 @@
+// Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
+
+export const OPERATORS = [
+  "",
+  "=",
+  "==",
+  "===",
+  "!==",
+  "!=",
+  ">",
+  ">=",
+  "<",
+  "<=",
+] as const;
diff --git a/semver/_shared.ts b/semver/_shared.ts
@@ -1,7 +1,5 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
 
-import { Operator } from "./types.ts";
-
 export function compareNumber(
   a: number,
   b: number,
@@ -186,30 +184,6 @@ export function isValidString(value: unknown): value is string {
   );
 }
 
-export const operators = [
-  "",
-  "=",
-  "==",
-  "===",
-  "!==",
-  "!=",
-  ">",
-  ">=",
-  "<",
-  "<=",
-] as const;
-
-/**
- * Checks to see if the value is a valid Operator string.
- *
- * Adds a type assertion if true.
- * @param value The value to check
- * @returns True if the value is a valid Operator string otherwise false.
- */
-export function isOperator(value: unknown): value is Operator {
-  return operators.includes(value as Operator);
-}
-
 const NUMERIC_IDENTIFIER_REGEXP = new RegExp(`^(${NUMERIC_IDENTIFIER})$`);
 export function parsePrerelease(prerelease: string) {
   return prerelease

diff --git a/semver/is_comparator.ts b/semver/is_comparator.ts
@@ -1,6 +1,6 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
 import { isSemVer } from "./is_semver.ts";
-import { isOperator } from "./_shared.ts";
+import { OPERATORS } from "./_constants.ts";
 import type { Comparator } from "./types.ts";
 import { ALL, NONE } from "./constants.ts";
 
@@ -15,14 +15,14 @@ import { ALL, NONE } from "./constants.ts";
  * @returns True if the object is a Comparator otherwise false
  */
 export function isComparator(value: unknown): value is Comparator {
-  if (value === null || value === undefined) return false;
-  if (value === NONE) return true;
-  if (value === ALL) return true;
-  if (Array.isArray(value)) return false;
-  if (typeof value !== "object") return false;
+  if (
+    value === null || value === undefined || Array.isArray(value) ||
+    typeof value !== "object"
+  ) return false;
+  if (value === NONE || value === ALL) return true;
   const { operator, semver } = value as Comparator;
   return (
-    isOperator(operator) &&
+    OPERATORS.includes(operator) &&
     isSemVer(semver)
   );
 }
diff --git a/semver/is_valid_operator_test.ts b/semver/is_valid_operator_test.ts
diff --git a/semver/types.ts b/semver/types.ts
@@ -1,6 +1,6 @@
 // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
 
-import { operators } from "./_shared.ts";
+import { OPERATORS } from "./_constants.ts";
 
 /**
  * The possible release types are used as an operator for the
@@ -19,7 +19,7 @@ export type ReleaseType =
 /**
  * SemVer comparison operators.
  */
-export type Operator = typeof operators[number];
+export type Operator = typeof OPERATORS[number];
 
 /**
  * The style to use when formatting a SemVer object into a string