refactor: result-code types for cmd-functions (#70)

The cmd functions currently always only return 0 or 1. Add types to express this in their signature. Every function gets their own type in preparation for potentially more codes that are not shared between functions.

Co-authored-by: Favo Yang <favoyang@gmail.com>

src/cmd-add.ts

@@ -30,11 +30,11 @@ export type AddOptions = CmdOptions<{
   force?: boolean;
 }>;
 
-type ResultCode = 0 | 1;
+type AddResultCode = 0 | 1;
 
 type AddResult = {
   dirty: boolean;
-  code: ResultCode;
+  code: AddResultCode;
 };
 
 /**
@@ -43,7 +43,7 @@ type AddResult = {
 export const add = async function (
   pkgs: PackageReference | PackageReference[],
   options: AddOptions
-): Promise<ResultCode> {
+): Promise<AddResultCode> {
   if (!Array.isArray(pkgs)) pkgs = [pkgs];
   // parse env
   const env = await parseEnv(options, true);

src/cmd-deps.ts

@@ -9,6 +9,8 @@ import {
 } from "./types/package-reference";
 import { CmdOptions } from "./types/options";
 
+type DepsResultCode = 0 | 1;
+
 export type DepsOptions = CmdOptions<{
   deep?: boolean;
 }>;
@@ -19,7 +21,7 @@ export type DepsOptions = CmdOptions<{
 export const deps = async function (
   pkg: PackageReference,
   options: DepsOptions
-) {
+): Promise<DepsResultCode> {
   // parse env
   const env = await parseEnv(options, false);
   if (env === null) return 1;

src/cmd-login.ts

@@ -28,10 +28,14 @@ export type LoginOptions = CmdOptions<{
   alwaysAuth?: boolean;
 }>;
 
+type LoginResultCode = 0 | 1;
+
 /**
  * @throws Error An unhandled error occurred
  */
-export const login = async function (options: LoginOptions) {
+export const login = async function (
+  options: LoginOptions
+): Promise<LoginResultCode> {
   // parse env
   const env = await parseEnv(options, false);
   if (env === null) return 1;
@@ -75,6 +79,8 @@ export const login = async function (options: LoginOptions) {
     options._global.registry as RegistryUrl,
     token
   );
+
+  return 0;
 };
 
 /**

src/cmd-remove.ts

@@ -15,16 +15,25 @@ import { CmdOptions } from "./types/options";
 
 export type RemoveOptions = CmdOptions;
 
+type RemoveResultCode = 0 | 1;
+
+type RemoveResult = {
+  code: RemoveResultCode;
+  dirty: boolean;
+};
+
 export const remove = async function (
   pkgs: PackageReference[] | PackageReference,
   options: RemoveOptions
-) {
+): Promise<RemoveResultCode> {
   if (!Array.isArray(pkgs)) pkgs = [pkgs];
   // parse env
   const env = await parseEnv(options, true);
   if (env === null) return 1;
 
-  const removeSingle = async function (pkg: PackageReference) {
+  const removeSingle = async function (
+    pkg: PackageReference
+  ): Promise<RemoveResult> {
     // dirty flag
     let dirty = false;
     // parse name
@@ -73,7 +82,7 @@ export const remove = async function (
   // remove
   const results = [];
   for (const pkg of pkgs) results.push(await removeSingle(pkg));
-  const result = {
+  const result: RemoveResult = {
     code: results.filter((x) => x.code != 0).length > 0 ? 1 : 0,
     dirty: results.filter((x) => x.dirty).length > 0,
   };

src/cmd-search.ts

@@ -16,6 +16,8 @@ type DateString = string;
 
 type TableRow = [DomainName, SemanticVersion, DateString, ""];
 
+type SearchResultCode = 0 | 1;
+
 export type SearchOptions = CmdOptions;
 
 export type SearchedPkgInfo = Omit<PkgInfo, "versions"> & {
@@ -116,7 +118,10 @@ const getTableRow = function (pkg: SearchedPkgInfo): TableRow {
   return [name, version, date, ""];
 };
 
-export async function search(keyword: string, options: SearchOptions) {
+export async function search(
+  keyword: string,
+  options: SearchOptions
+): Promise<SearchResultCode> {
   // parse env
   const env = await parseEnv(options, false);
   if (env === null) return 1;

src/cmd-view.ts

@@ -14,10 +14,12 @@ import { CmdOptions } from "./types/options";
 
 export type ViewOptions = CmdOptions;
 
+type ViewResultCode = 0 | 1;
+
 export const view = async function (
   pkg: PackageReference,
   options: ViewOptions
-) {
+): Promise<ViewResultCode> {
   // parse env
   const env = await parseEnv(options, false);
   if (env === null) return 1;