Merge pull request #1 from gmaxlev/feature_tsguarder

feat: delegated type checking to the external package tsguarder

package.json

@@ -77,6 +77,7 @@
   },
   "dependencies": {
     "temp": "^0.9.4",
+    "tsguarder": "^1.0.1",
     "type-fest": "^3.6.1"
   }
 }

src/api/native/index.ts

@@ -1,18 +1,13 @@
 import fsp from "fs/promises";
+import { isString, isUndefined, isBoolean, isRecord } from "tsguarder";
 import { ModelSource, isModelSource } from "./types";
 import type { CallPictOptions } from "./../../common/pict";
-import {
-  isString,
-  isUndefined,
-  isPositiveNumber,
-  isBoolean,
-} from "./../../common/utils";
+import { isPositiveNumber } from "./../../common/utils";
 import {
   PictCliOptions,
   isRandomOption,
   isModelSeparator,
 } from "../../common/types";
-import { isRecord } from "../../common/utils";
 import { callPict, pictEntries } from "../../common/pict";
 
 interface NativeOptions {

src/api/native/types.ts

@@ -1,5 +1,4 @@
-import { isRecord, isString } from "./../../common/utils";
-import { createTypeGuard, TypeGuard } from "../../common/utils";
+import { createTypeGuard, TypeGuard, isRecord, isString } from "tsguarder";
 
 export interface ModelFileSource {
   file: string;

src/api/pict/ValuesIdMap.ts

@@ -1,5 +1,5 @@
 import type { PictModelId } from "../../common/types";
-import { isString } from "../../common/utils";
+import { isString } from "tsguarder";
 
 type ParameterValueToIdMap = Map<unknown, PictModelId>;
 

src/api/pict/index.ts

@@ -1,3 +1,4 @@
+import { isArray, isRecord, isUndefined } from "tsguarder";
 import {
   isInputSeed,
   isRandomOption,
@@ -8,12 +9,7 @@ import {
 } from "../../common/types";
 import type { PictTypedModel } from "./types";
 import { callPict, CallPictOptions } from "../../common/pict";
-import {
-  isArray,
-  isPositiveNumber,
-  isRecord,
-  isUndefined,
-} from "../../common/utils";
+import { isPositiveNumber } from "../../common/utils";
 import { createModel } from "./model";
 import { createSeed } from "./seed";
 import { parseResult } from "./parse";

src/api/pict/seed.ts

@@ -1,4 +1,4 @@
-import { isArray } from "../../common/utils";
+import { isArray } from "tsguarder";
 import { SeedBuilder } from "../../common/SeedBuilder";
 import type { ValuesIdMap } from "./ValuesIdMap";
 import type { PictTypedModel } from "./types";

src/api/pict/types.ts

@@ -1,9 +1,5 @@
-import {
-  createTypeGuard,
-  isPropertyKey,
-  isRecord,
-  TypeGuard,
-} from "../../common/utils";
+import { createTypeGuard, isRecord, TypeGuard } from "tsguarder";
+import { isPropertyKey } from "../../common/utils";
 import type { PictModel } from "../../common/types";
 
 export type PictTypedModel = PictModel<PropertyKey, unknown>;

src/api/strings/index.ts

@@ -1,3 +1,4 @@
+import { isArray, isRecord, isUndefined, isBoolean } from "tsguarder";
 import {
   isInputSeed,
   isRandomOption,
@@ -9,13 +10,7 @@ import {
   InputSubModel,
 } from "../../common/types";
 import { callPict, CallPictOptions } from "../../common/pict";
-import {
-  isArray,
-  isRecord,
-  isUndefined,
-  isPositiveNumber,
-  isBoolean,
-} from "../../common/utils";
+import { isPositiveNumber } from "../../common/utils";
 import { createStringModel } from "./model";
 import { createSeed } from "./seed";
 import { parseResult } from "./parse";

src/api/strings/model.ts

@@ -1,9 +1,9 @@
+import { isString, isArray } from "tsguarder";
 import {
   isPictStringModel,
   PictStringModel,
   CreateModelOptions,
 } from "./types";
-import { isString, isArray } from "../../common/utils";
 import { ModelBuilder, ModelBuilderOptions } from "../../common/ModelBuilder";
 import { isAliasOperator } from "../../common/operators/alias";
 import { isNegativeOperator } from "../../common/operators/negative";

src/api/strings/seed.ts

@@ -1,8 +1,8 @@
+import { isArray, isString } from "tsguarder";
 import type { PictModel } from "./../../common/types";
 import { SeedBuilder } from "../../common/SeedBuilder";
 import type { InputSeed } from "../../common/types";
 import type { PictStringModel } from "./types";
-import { isArray, isString } from "../../common/utils";
 
 export function createSeed<
   S extends InputSeed<ReadonlyArray<PictModel>>,

src/api/strings/types.ts

@@ -1,14 +1,14 @@
-import type { WeightOperatorObject } from "./../../common/operators/weight";
-import type { NegativeOperatorObject } from "./../../common/operators/negative";
-import type { AliasOperatorObject } from "./../../common/operators/alias";
-import type { InputSubModel, PictModel } from "../../common/types";
 import {
+  createTypeGuard,
+  TypeGuard,
   isString,
   isArray,
   isRecord,
-  createTypeGuard,
-  TypeGuard,
-} from "../../common/utils";
+} from "tsguarder";
+import type { WeightOperatorObject } from "./../../common/operators/weight";
+import type { NegativeOperatorObject } from "./../../common/operators/negative";
+import type { AliasOperatorObject } from "./../../common/operators/alias";
+import type { InputSubModel, PictModel } from "../../common/types";
 
 export interface CreateModelOptions<M extends ReadonlyArray<PictStringModel>> {
   models: M;

src/common/ModelBuilder.ts

@@ -1,4 +1,4 @@
-import { isNumber, isRecord, isString, isUndefined } from "./utils";
+import { isNumber, isRecord, isString, isUndefined } from "tsguarder";
 import { EOL } from "os";
 
 type ModelBuilderConstraint = string;

src/common/SeedBuilder.ts

@@ -1,4 +1,4 @@
-import { isString, isUndefined } from "./utils";
+import { isString, isUndefined } from "tsguarder";
 import { EOL } from "os";
 
 /**

src/common/operators/alias.ts

@@ -1,4 +1,4 @@
-import { isRecord } from "../utils";
+import { isRecord } from "tsguarder";
 
 export const ALIAS_OPERATOR: unique symbol = Symbol("ALIAS_OPERATOR");
 

src/common/operators/negative.ts

@@ -1,4 +1,4 @@
-import { isRecord } from "../utils";
+import { isRecord } from "tsguarder";
 
 export const NEGATIVE_OPERATOR: unique symbol = Symbol("NEGATIVE_OPERATOR");
 

src/common/operators/weight.ts

@@ -1,4 +1,5 @@
-import { isRecord, isPositiveNumber } from "../utils";
+import { isRecord } from "tsguarder";
+import { isPositiveNumber } from "../utils";
 
 export const WEIGHT_OPERATOR: unique symbol = Symbol("WEIGHT_OPERATOR");
 

src/common/pict.ts

@@ -1,13 +1,8 @@
 import { IS_WIN, IS_TEST } from "./../env";
 import type { PictCliOptions, PickPictCliOptions } from "./types";
 import { execSync } from "child_process";
-import {
-  isBoolean,
-  isNumber,
-  isString,
-  isUndefined,
-  writeTempFile,
-} from "./utils";
+import { writeTempFile } from "./utils";
+import { isBoolean, isNumber, isString, isUndefined } from "tsguarder";
 import path from "path";
 import { EOL } from "os";
 import url from "url";

src/common/types.ts

@@ -4,13 +4,13 @@ import type { WeightOperatorObject } from "./operators/weight";
 import type { UnionToIntersection } from "type-fest";
 import {
   createTypeGuard,
-  isNumber,
-  isPositiveNumber,
+  TypeGuard,
   isRecord,
   isString,
   isUndefined,
-  TypeGuard,
-} from "./utils";
+  isNumber,
+} from "tsguarder";
+import { isPositiveNumber } from "./utils";
 
 export interface PictCliOptions {
   order: number;

src/common/utils.ts

@@ -1,5 +1,6 @@
 import fsp from "fs/promises";
 import * as temp from "temp";
+import { createTypeGuard, TypeGuard, isNumber } from "tsguarder";
 
 /**
  * Creates a temporary file and writes the content to it.
@@ -13,40 +14,6 @@ export async function writeTempFile(content: string) {
   return file;
 }
 
-export type TypeGuard<T> = {
-  (value: unknown): value is T;
-  assert: (value: unknown, before?: string) => asserts value is T;
-};
-
-export function createTypeGuard<T>(
-  description: string,
-  guard: (value: unknown) => value is T
-) {
-  function check(value: unknown) {
-    return guard(value);
-  }
-
-  check.assert = function (
-    value: unknown,
-    before?: string
-  ): asserts value is T {
-    if (!guard(value)) {
-      const message = before ? `${before}: ${description}` : description;
-      throw new TypeError(message);
-    }
-  };
-
-  return check as TypeGuard<T>;
-}
-
-export const isRecord: TypeGuard<Record<PropertyKey, unknown>> =
-  createTypeGuard("must be an object", function (value): value is Record<
-    PropertyKey,
-    unknown
-  > {
-    return typeof value === "object" && value !== null && !Array.isArray(value);
-  });
-
 export const isPropertyKey: TypeGuard<PropertyKey> = createTypeGuard(
   "must be a string, number or symbol",
   (value): value is PropertyKey => {
@@ -58,51 +25,16 @@ export const isPropertyKey: TypeGuard<PropertyKey> = createTypeGuard(
   }
 );
 
-export const isNumber: TypeGuard<number> = createTypeGuard(
-  "must be a number",
-  (value): value is number => {
-    return typeof value === "number";
-  }
-);
-
 export const isPositiveNumber: TypeGuard<number> = createTypeGuard(
   "must be a positive number",
   (value): value is number => {
     return isNumber(value) && value > 0;
   }
 );
 
-export const isBoolean: TypeGuard<boolean> = createTypeGuard(
-  "must be a boolean",
-  (value): value is boolean => {
-    return typeof value === "boolean";
-  }
-);
-
-export const isString: TypeGuard<string> = createTypeGuard(
-  "must be a string",
-  (value): value is string => {
-    return typeof value === "string";
-  }
-);
-
-export const isUndefined: TypeGuard<undefined> = createTypeGuard(
-  "must be undefined",
-  (value): value is undefined => {
-    return typeof value === "undefined";
-  }
-);
-
 export const isBuffer: TypeGuard<Buffer> = createTypeGuard(
   "must be a Buffer",
   (value): value is Buffer => {
     return value instanceof Buffer;
   }
 );
-
-export const isArray: TypeGuard<Array<unknown>> = createTypeGuard(
-  "must be an array",
-  (value): value is Array<unknown> => {
-    return Array.isArray(value);
-  }
-);

src/test/native.spec.ts

@@ -19,7 +19,7 @@ describe("native()", () => {
         const result = expect(act);
 
         await result.rejects.toThrowError(
-          "the first argument: must be an object"
+          "the first argument: must be a record"
         );
       }
     });
@@ -34,7 +34,7 @@ describe("native()", () => {
 
         const result = expect(act);
 
-        await result.rejects.toThrowError('"options": must be an object');
+        await result.rejects.toThrowError('"options": must be a record');
       }
     });
     test('Should throw an error if "options.order" is not a positive number', async () => {
@@ -92,7 +92,7 @@ describe("native()", () => {
         const result = expect(act);
 
         await result.rejects.toThrowError(
-          '"options.caseSensitive": must be a boolean'
+          '"options.caseSensitive": must be boolean'
         );
       }
     });

src/test/pict.spec.ts

@@ -19,7 +19,7 @@ describe("pict()", () => {
         const act = async () => await pict(notRecord);
         const result = expect(act);
         await result.rejects.toThrowError(
-          "the first argument: must be an object"
+          "the first argument: must be a record"
         );
       }
     });
@@ -42,7 +42,7 @@ describe("pict()", () => {
         const result = expect(act);
 
         await result.rejects.toThrowError(
-          "the second argument: must be an object"
+          "the second argument: must be a record"
         );
       }
     });