feat(deps): Update dependencies 2023.06.21 (#86)

JoseLion · web-flow · commit d79c98ccdfc0 · 2023-06-30T12:58:38.000-05:00
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -22,14 +22,16 @@
     "@typescript-eslint",
     "eslint-plugin-import",
     "eslint-plugin-jsdoc",
-    "etc"
+    "etc",
+    "sonarjs"
   ],
   "extends": [
     "eslint:recommended",
     "plugin:@typescript-eslint/recommended",
     "plugin:@typescript-eslint/recommended-requiring-type-checking",
     "plugin:etc/recommended",
-    "plugin:import/typescript"
+    "plugin:import/typescript",
+    "plugin:sonarjs/recommended"
   ],
   "overrides": [{
     "files": "*.ts?(x)",
@@ -153,7 +155,10 @@
     "func-style": ["error", "declaration", { "allowArrowFunctions": true }],
     "import/newline-after-import": "error",
     "import/no-absolute-path": "error",
-    "import/no-cycle": ["error", { "ignoreExternal": true }],
+    "import/no-cycle": ["error", {
+      "allowUnsafeDynamicCyclicDependency": true,
+      "ignoreExternal": true
+    }],
     "import/no-duplicates": "error",
     "import/no-import-module-exports": "error",
     "import/no-namespace": "error",
@@ -170,8 +175,7 @@
     }],
     "jsdoc/check-alignment": "error",
     "jsdoc/check-indentation": ["error", { "excludeTags": ["example", "param", "returns"] }],
-    "jsdoc/newline-after-description": "error",
-    "jsx-quotes": "error",
+    "jsdoc/tag-lines": ["error", "any", { "startLines": 1 }],
     "keyword-spacing": "error",
     "linebreak-style": "error",
     "max-classes-per-file": ["error", 1],
@@ -212,6 +216,9 @@
     "radix": "error",
     "rest-spread-spacing": "error",
     "semi-spacing": "error",
+    "sonarjs/cognitive-complexity": "off",
+    "sonarjs/no-duplicate-string": "off",
+    "sonarjs/no-inverted-boolean-check": "error",
     "sort-keys": "error",
     "space-before-blocks": "error",
     "space-in-parens": "error",
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -26,6 +26,7 @@ jobs:
           - 17
           - 18
           - 19
+          - 20
 
     steps:
       - uses: actions/checkout@v3
diff --git a/.nvmrc b/.nvmrc
@@ -1 +1 @@
-19.6.0
+20.3.1
diff --git a/.yarn/plugins/@yarnpkg/plugin-interactive-tools.cjs b/.yarn/plugins/@yarnpkg/plugin-interactive-tools.cjs
diff --git a/.yarn/releases/yarn-3.4.1.cjs b/.yarn/releases/yarn-3.4.1.cjs
diff --git a/.yarn/releases/yarn-3.6.0.cjs b/.yarn/releases/yarn-3.6.0.cjs
diff --git a/.yarnrc.yml b/.yarnrc.yml
@@ -6,4 +6,4 @@ plugins:
   - path: .yarn/plugins/@yarnpkg/plugin-engines.cjs
     spec: "https://github.com/devoto13/yarn-plugin-engines/main/bundles/%40yarnpkg/plugin-engines.js"
 
-yarnPath: .yarn/releases/yarn-3.4.1.cjs
+yarnPath: .yarn/releases/yarn-3.6.0.cjs
diff --git a/examples/jest/package.json b/examples/jest/package.json
@@ -8,11 +8,11 @@
   "devDependencies": {
     "@examples/symbol-plugin": "workspace:^",
     "@stackbuilders/assertive-ts": "workspace:^",
-    "@types/jest": "^29.4.0",
-    "@types/node": "^18.14.2",
-    "jest": "^29.4.3",
-    "ts-jest": "^29.0.5",
+    "@types/jest": "^29.5.2",
+    "@types/node": "^20.3.2",
+    "jest": "^29.5.0",
+    "ts-jest": "^29.1.0",
     "ts-node": "^10.9.1",
-    "typescript": "^4.9.5"
+    "typescript": "^5.1.6"
   }
 }
diff --git a/examples/mocha/package.json b/examples/mocha/package.json
@@ -9,9 +9,9 @@
     "@examples/symbol-plugin": "workspace:^",
     "@stackbuilders/assertive-ts": "workspace:^",
     "@types/mocha": "^10.0.1",
-    "@types/node": "^18.14.2",
+    "@types/node": "^20.3.2",
     "mocha": "^10.2.0",
     "ts-node": "^10.9.1",
-    "typescript": "^4.9.5"
+    "typescript": "^5.1.6"
   }
 }
diff --git a/examples/symbolPlugin/package.json b/examples/symbolPlugin/package.json
@@ -9,7 +9,7 @@
   },
   "devDependencies": {
     "@stackbuilders/assertive-ts": "workspace:^",
-    "typescript": "^4.9.5"
+    "typescript": "^5.1.6"
   },
   "peerDependencies": {
     "@stackbuilders/assertive-ts": "*"
diff --git a/package.json b/package.json
@@ -6,9 +6,9 @@
   "author": "Stack Builders <info@stackbuilders.com>",
   "license": "MIT",
   "engines": {
-    "node": ">=16 <=19"
+    "node": ">=16"
   },
-  "packageManager": "yarn@3.4.1",
+  "packageManager": "yarn@3.6.0",
   "workspaces": [
     "package/",
     "examples/*"
@@ -23,14 +23,15 @@
     "test": "turbo run test"
   },
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^5.54.0",
-    "@typescript-eslint/parser": "^5.54.0",
-    "eslint": "^8.35.0",
-    "eslint-import-resolver-typescript": "^3.5.3",
-    "eslint-plugin-etc": "^2.0.2",
+    "@typescript-eslint/eslint-plugin": "^5.60.1",
+    "@typescript-eslint/parser": "^5.60.1",
+    "eslint": "^8.43.0",
+    "eslint-import-resolver-typescript": "^3.5.5",
+    "eslint-plugin-etc": "^2.0.3",
     "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-jsdoc": "^40.0.0",
-    "turbo": "^1.8.3",
-    "typescript": "^4.9.5"
+    "eslint-plugin-jsdoc": "^46.4.2",
+    "eslint-plugin-sonarjs": "^0.19.0",
+    "turbo": "^1.10.6",
+    "typescript": "^5.1.6"
   }
 }
diff --git a/package/package.json b/package/package.json
@@ -34,17 +34,17 @@
   },
   "devDependencies": {
     "@types/mocha": "^10.0.1",
-    "@types/node": "^18.14.2",
-    "@types/sinon": "^10.0.13",
-    "all-contributors-cli": "^6.24.0",
+    "@types/node": "^20.3.2",
+    "@types/sinon": "^10.0.15",
+    "all-contributors-cli": "^6.26.0",
     "cross-env": "^7.0.3",
     "mocha": "^10.2.0",
-    "semantic-release": "^20.1.0",
-    "sinon": "^15.0.1",
+    "semantic-release": "^21.0.6",
+    "sinon": "^15.2.0",
     "ts-node": "^10.9.1",
-    "typedoc": "^0.23.26",
-    "typedoc-plugin-markdown": "^3.14.0",
-    "typedoc-plugin-merge-modules": "^4.0.1",
-    "typescript": "^4.9.5"
+    "typedoc": "^0.24.8",
+    "typedoc-plugin-markdown": "^3.15.3",
+    "typedoc-plugin-merge-modules": "^5.0.1",
+    "typescript": "^5.1.6"
   }
 }
diff --git a/package/src/lib/Assertion.ts b/package/src/lib/Assertion.ts
@@ -1,6 +1,6 @@
 import { UnsupportedOperationError } from "./errors/UnsupportedOperationError";
 import { type TypeFactory } from "./helpers/TypeFactories";
-import { isJSObject, isKeyOf } from "./helpers/guards";
+import { isStruct, isKeyOf } from "./helpers/guards";
 import { prettify } from "./helpers/messages";
 
 import { AssertionError } from "assert";
@@ -366,7 +366,10 @@ export class Assertion<T> {
         return this.actual.getTime() === expected.getTime();
       }
 
-      if (isJSObject(this.actual) && isJSObject(expected)) {
+      if (
+        (isStruct(this.actual) && isStruct(expected))
+        || (Array.isArray(this.actual) && Array.isArray(expected))
+      ) {
         const actualKeys = Object.keys(this.actual);
         const expectedKeys = Object.keys(expected);
         const sizeMatch = actualKeys.length === expectedKeys.length;
@@ -375,7 +378,7 @@ export class Assertion<T> {
         return sizeMatch && valuesMatch;
       }
 
-      return false;
+      return Object.is(this.actual, expected);
     };
 
     const areBothNaN = typeof this.actual === "number"
diff --git a/package/src/lib/FunctionAssertion.ts b/package/src/lib/FunctionAssertion.ts
@@ -8,6 +8,12 @@ import { isDeepStrictEqual } from "util";
 
 export type AnyFunction = (...args: unknown[]) => unknown;
 
+/**
+ * Helper symbol used to indicate that no error was captured during
+ * the assertion.
+ *
+ * @hidden
+ */
 const NoThrow = Symbol("NoThrow");
 
 /**
diff --git a/package/src/lib/ObjectAssertion.ts b/package/src/lib/ObjectAssertion.ts
@@ -1,28 +1,25 @@
 import { Assertion } from "./Assertion";
 import { prettify } from "./helpers/messages";
+import { Entry, Struct } from "./helpers/types";
 
 import { AssertionError } from "assert";
 import { isDeepStrictEqual } from "util";
 
-export type JSObject = Record<keyof unknown, unknown>;
-
-export type Entry<T, K = keyof T> = K extends keyof T
-  ? [K, T[K]]
-  : never;
-
 /**
  * Encapsulates assertion methods applicable to objects.
  *
  * @param T the object's definition type
  */
-export class ObjectAssertion<T extends JSObject> extends Assertion<T> {
+export class ObjectAssertion<T extends Struct> extends Assertion<T> {
 
   public constructor(actual: T) {
     super(actual);
   }
 
-  private hasOwnProp(prop: PropertyKey): boolean {
-    return Object.prototype.hasOwnProperty.call(this.actual, prop);
+  private hasOwnProp(prop: PropertyKey | undefined): boolean {
+    return prop !== undefined
+      ? Object.prototype.hasOwnProperty.call(this.actual, prop)
+      : false;
   }
 
   /**
diff --git a/package/src/lib/expect.ts b/package/src/lib/expect.ts
@@ -5,11 +5,12 @@ import { DateAssertion } from "./DateAssertion";
 import { ErrorAssertion } from "./ErrorAssertion";
 import { AnyFunction, FunctionAssertion } from "./FunctionAssertion";
 import { NumberAssertion } from "./NumberAssertion";
-import { JSObject, ObjectAssertion } from "./ObjectAssertion";
+import { ObjectAssertion } from "./ObjectAssertion";
 import { PromiseAssertion } from "./PromiseAssertion";
 import { StringAssertion } from "./StringAssertion";
 import { config } from "./config/Config";
-import { isAnyFunction, isJSObject, isPromise } from "./helpers/guards";
+import { isAnyFunction, isStruct, isPromise } from "./helpers/guards";
+import { Struct } from "./helpers/types";
 
 export interface Expect {
   (actual: boolean): BooleanAssertion;
@@ -20,7 +21,7 @@ export interface Expect {
   <T>(actual: Promise<T>): PromiseAssertion<T>;
   <T extends AnyFunction>(actual: T): FunctionAssertion<T>;
   <T extends Error>(actual: T): ErrorAssertion<T>;
-  <T extends JSObject>(actual: T): ObjectAssertion<T>;
+  <T extends Struct>(actual: T): ObjectAssertion<T>;
   <T>(actual: T): Assertion<T>;
 }
 
@@ -61,7 +62,7 @@ function expectMatcher<T>(actual: T): ReturnType<Expect> {
     return new plugin.Assertion(actual);
   }
 
-  if (isJSObject(actual)) {
+  if (isStruct(actual)) {
     return new ObjectAssertion(actual);
   }
 
diff --git a/package/src/lib/helpers/TypeFactories.ts b/package/src/lib/helpers/TypeFactories.ts
@@ -4,10 +4,11 @@ import { BooleanAssertion } from "../BooleanAssertion";
 import { DateAssertion } from "../DateAssertion";
 import { type AnyFunction, FunctionAssertion } from "../FunctionAssertion";
 import { NumberAssertion } from "../NumberAssertion";
-import { JSObject, ObjectAssertion } from "../ObjectAssertion";
+import { ObjectAssertion } from "../ObjectAssertion";
 import { StringAssertion } from "../StringAssertion";
 
-import { isJSObject } from "./guards";
+import { isStruct } from "./guards";
+import { Struct } from "./types";
 
 export type AssertionFactory<S, A extends Assertion<S>> = new(actual: S) => A;
 
@@ -99,7 +100,7 @@ export interface StaticTypeFactories {
    * ```
    * @typeParam T the type of the object
    */
-  object<T extends JSObject>(): TypeFactory<T, ObjectAssertion<T>>;
+  object<T extends Struct>(): TypeFactory<T, ObjectAssertion<T>>;
 }
 
 export const TypeFactories: Readonly<StaticTypeFactories> = {
@@ -145,10 +146,10 @@ export const TypeFactories: Readonly<StaticTypeFactories> = {
       typeName: type.name,
     };
   },
-  object<T extends JSObject>() {
+  object<T extends Struct>() {
     return {
       Factory: ObjectAssertion,
-      predicate: (value): value is T => isJSObject(value),
+      predicate: (value): value is T => isStruct(value),
       typeName: "object",
     };
   },
diff --git a/package/src/lib/helpers/guards.ts b/package/src/lib/helpers/guards.ts
@@ -6,10 +6,12 @@ import type {
   LowInclusiveBetweenOptions,
 } from "../NumberAssertion";
 
-export function isJSObject<T>(value: T): value is { [K in keyof T]: T[K] } {
-  return value !== null
-    && typeof value === "object"
-    && typeof value !== "function";
+import { Struct } from "./types";
+
+export function isStruct<T>(value: T): value is { [K in keyof T]: T[K] } & Struct {
+  return typeof value === "object"
+    && value !== null
+    && !Array.isArray(value);
 }
 
 export function isKeyOf<T extends object>(target: T, key: unknown): key is keyof T {
diff --git a/package/src/lib/helpers/types.ts b/package/src/lib/helpers/types.ts
@@ -0,0 +1,19 @@
+/**
+ * Backwards compatibility alias of the `Struct` type.
+ *
+ * @deprecated in favor of {@link Struct}
+ */
+export type JSObject = Struct;
+
+/**
+ * Utility type that represents any kind of structured object.
+ */
+export type Struct = Record<keyof unknown, unknown>;
+
+/**
+ * Mapped type which transforms an structured object `<T>` to entries., i.e. a
+ * key-value tuples.
+ *
+ * @param T an structured object which extends {@link Struct}
+ */
+export type Entry<T extends Struct> = { [K in keyof T]: [K, T[K]]; }[keyof T];
diff --git a/package/test/lib/helpers/guards.test.ts b/package/test/lib/helpers/guards.test.ts
diff --git a/package/typedoc.json b/package/typedoc.json
diff --git a/yarn.lock b/yarn.lock

-Original file line number
+Diff line change
           - 17
           - 18
           - 19
 +          - 20
     steps:
       - uses: actions/checkout@v3
Original file line number	Diff line number	Diff line change
`@@ -9,9 +9,9 @@`
`9`	`9`	`"@examples/symbol-plugin": "workspace:^",`
`10`	`10`	`"@stackbuilders/assertive-ts": "workspace:^",`
`11`	`11`	`"@types/mocha": "^10.0.1",`
`12`		`- "@types/node": "^18.14.2",`
	`12`	`+ "@types/node": "^20.3.2",`
`13`	`13`	`"mocha": "^10.2.0",`
`14`	`14`	`"ts-node": "^10.9.1",`
`15`		`- "typescript": "^4.9.5"`
	`15`	`+ "typescript": "^5.1.6"`
`16`	`16`	`}`
`17`	`17`	`}`