refactor: rename type

Shorten version-name type name to just version, since it no longer conflicts with version-info
openupm · Oct 25, 2023 · b54c937 · b54c937
1 parent ebfa04b
commit b54c937
Show file tree

Hide file tree

Showing 7 changed files with 25 additions and 28 deletions.
diff --git a/lib/cmd-add.ts b/lib/cmd-add.ts
@@ -12,7 +12,7 @@ import {
   parseName,
   saveManifest,
 } from "./core";
-import { isUrlVersion } from "./utils/version-name";
+import { isUrlVersion } from "./utils/version";
 
 export type AddOptions = {
   test: boolean;

diff --git a/lib/cmd-deps.ts b/lib/cmd-deps.ts
@@ -23,7 +23,7 @@ const _deps = async function ({
   deep,
 }: {
   name: PkgName;
-  version: PkgVersionName | undefined;
+  version: PkgVersion | undefined;
   deep: boolean;
 }) {
   // eslint-disable-next-line no-unused-vars

diff --git a/lib/cmd-search.ts b/lib/cmd-search.ts
@@ -9,7 +9,7 @@ import assert from "assert";
 
 type DateString = string;
 
-type TableRow = [PkgName, PkgVersionName, DateString, ""];
+type TableRow = [PkgName, PkgVersion, DateString, ""];
 
 export type SearchOptions = {
   _global: GlobalOptions;

diff --git a/lib/core.ts b/lib/core.ts
@@ -159,7 +159,7 @@ export const parseEnv = async function (
 // Parse name to {name, version}
 export const parseName = function (pkg: PkgName): {
   name: ReverseDomainName;
-  version: PkgVersionName | undefined;
+  version: PkgVersion | undefined;
 } {
   const segs = pkg.split("@");
   const name = segs[0];
@@ -211,7 +211,7 @@ export const fetchPackageDependencies = async function ({
   deep,
 }: {
   name: PkgName;
-  version: PkgVersionName | undefined;
+  version: PkgVersion | undefined;
   deep: boolean;
 }): Promise<[Dependency[], Dependency[]]> {
   log.verbose("dependency", `fetch: ${name}@${version} deep=${deep}`);
@@ -225,7 +225,7 @@ export const fetchPackageDependencies = async function ({
   const depsInvalid = [];
   // cached dict: {pkg-name: pkgInfo}
   const cachedPacakgeInfoDict: Record<
-    PkgVersionName,
+    PkgVersion,
     { pkgInfo: PkgInfo; upstream: boolean }
   > = {};
   while (pendingList.length > 0) {
@@ -304,7 +304,7 @@ export const fetchPackageDependencies = async function ({
         if (depObj.self || deep) {
           const deps: NameVersionPair[] = _.toPairs(
             pkgInfo.versions[entry.version]["dependencies"]
-          ).map((x: [PkgName, PkgVersionName]): NameVersionPair => {
+          ).map((x: [PkgName, PkgVersion]): NameVersionPair => {
             return { name: x[0], version: x[1] };
           });
           deps.forEach((x) => pendingList.push(x));
@@ -325,7 +325,7 @@ export const fetchPackageDependencies = async function ({
 // Get latest version from package info
 export const getLatestVersion = function (
   pkgInfo: PkgInfo
-): PkgVersionName | undefined {
+): PkgVersion | undefined {
   if (pkgInfo["dist-tags"]?.["latest"] !== undefined)
     return pkgInfo["dist-tags"]["latest"];
   else if (pkgInfo.version) return pkgInfo.version;

diff --git a/lib/types/global.d.ts b/lib/types/global.d.ts
@@ -1,11 +1,11 @@
 import { NpmAuth } from "another-npm-registry-client";
 
 declare global {
-  type PkgVersionName = string;
+  type PkgVersion = string;
 
   type ReverseDomainName = string;
 
-  type PkgName = ReverseDomainName | `${ReverseDomainName}@${PkgVersionName}`;
+  type PkgName = ReverseDomainName | `${ReverseDomainName}@${PkgVersion}`;
 
   type Region = "us" | "cn";
 
@@ -48,7 +48,7 @@ declare global {
   type PkgVersionInfo = {
     unity?: string;
     unityRelease: string;
-    dependencies: Record<PkgName, PkgVersionName>;
+    dependencies: Record<PkgName, PkgVersion>;
     license?: string;
     displayName: string;
     description?: string;
@@ -59,23 +59,23 @@ declare global {
 
   type PkgInfo = {
     name: PkgName;
-    versions: Record<PkgVersionName, PkgVersionInfo>;
-    "dist-tags": { latest?: PkgVersionName };
-    version?: PkgVersionName;
+    versions: Record<PkgVersion, PkgVersionInfo>;
+    "dist-tags": { latest?: PkgVersion };
+    version?: PkgVersion;
     description?: string;
     keywords?: string[];
-    time: Record<"created" | "modified" | PkgVersionName, string>;
+    time: Record<"created" | "modified" | PkgVersion, string>;
     date?: Date;
   };
 
   type NameVersionPair = {
     name: PkgName;
-    version: PkgVersionName | undefined;
+    version: PkgVersion | undefined;
   };
 
   type Dependency = {
     name: PkgName;
-    version: PkgVersionName | undefined;
+    version: PkgVersion | undefined;
     upstream: boolean;
     self: boolean;
     internal: boolean;
@@ -90,7 +90,7 @@ declare global {
   };
 
   type PkgManifest = {
-    dependencies: Record<PkgName, PkgVersionName>;
+    dependencies: Record<PkgName, PkgVersion>;
     scopedRegistries: ScopedRegistry[];
     testables: string[];
   };

diff --git a/lib/utils/version-name.ts b/lib/utils/version-name.ts
diff --git a/lib/utils/version.ts b/lib/utils/version.ts
@@ -0,0 +1,7 @@
+const isGit = (version: PkgVersion): boolean => version.startsWith("git");
+const isHttp = (version: PkgVersion): boolean => version.startsWith("http");
+
+const isLocal = (version: PkgVersion): boolean => version.startsWith("file");
+
+export const isUrlVersion = (version: PkgVersion): boolean =>
+  isGit(version) || isHttp(version) || isLocal(version);