@kensio/smartass 1.9.0 → 1.10.0

package/README.md

@@ -3,6 +3,14 @@
 TypeScript-first test assertion functions with precise type narrowing via
 assertion signatures.
 
+## Installation
+
+```bash
+npm install @kensio/smartass
+```
+
+## Type narrowing with assertion signatures
+
 See
 [TypeScript assertion functions / assertion signatures](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-7.html#assertion-functions)
 
@@ -13,7 +21,7 @@ This library provides assertion functions with assertion signatures so that you
 can benefit from the extra type information.
 
 ```typescript
-import { assertNonNullable } from '@kensio/smartass';
+import { assertNonNullable } from "@kensio/smartass";
 
 const user: { name: string } | undefined = getUser();
 assertNonNullable(user);
@@ -23,24 +31,50 @@ const userName = user.name;
 ```
 
 ```typescript
-import { assertOneOf } from '@kensio/smartass';
+import { assertOneOf } from "@kensio/smartass";
 
 const status = getStatus();
-assertOneOf(status, ['pending', 'active', 'completed']);
+assertOneOf(status, ["pending", "active", "completed"]);
 // TypeScript now knows status is of type 'pending' | 'active' | 'completed'
 ```
 
-## Installation
+## Composable type narrowing matchers
 
-```bash
-npm install @kensio/smartass
+As well as the standalone assertion functions, you can also use type narrowing matcher functions to
+compose an object structure.
+
+```typescript
+import {
+  assertObjectMatches,
+  arrayIncluding,
+  oneOf,
+  stringOfLength,
+} from "@kensio/smartass";
+
+const user = getUser();
+
+assertObjectMatches(user, {
+  role: oneOf(["admin", "editor", "viewer"]),
+  tags: arrayIncluding("beta"),
+  id: stringOfLength(8),
+});
+
+// TypeScript knows:
+//   user.role is 'admin' | 'editor' | 'viewer'
+//   user.tags is an array with at least one string element
+//   user.id is a string of length 8 with safe indexing
 ```
 
+This applies the same type narrowing effect as the assertion functions but in a composable object
+structure.
+
 ## Assertion functions
 
+<!-- assertion-functions:start -->
+
 - [assertArrayEquals](src/assert/array-equals/array-equals.assert.ts)
-- [assertArrayIncludes](src/assert/array-includes/array-includes.assert.ts)
 - [assertArrayIncludesAll](src/assert/array-includes-all/array-includes-all.assert.ts)
+- [assertArrayIncludes](src/assert/array-includes/array-includes.assert.ts)
 - [assertArrayLength](src/assert/array-length/array-length.assert.ts)
 - [assertArrayMinLength](src/assert/array-min-length/array-min-length.assert.ts)
 - [assertArrayNotEmpty](src/assert/array-not-empty/array-not-empty.assert.ts)
@@ -60,9 +94,9 @@ npm install @kensio/smartass
 - [assertStringLength](src/assert/string-length/string-length.assert.ts)
 - [assertStringNotIncludes](src/assert/string-not-includes/string-not-includes.assert.ts)
 - [assertStringStartsWith](src/assert/string-starts-with/string-starts-with.assert.ts)
-- [assertThrowsError](src/assert/throws-error/throws-error.assert.ts)
 - [assertThrowsErrorAsync](src/assert/throws-error-async/throws-error-async.assert.ts)
 - [assertThrowsErrorLike](src/assert/throws-error-like/throws-error-like.assert.ts)
+- [assertThrowsError](src/assert/throws-error/throws-error.assert.ts)
 - [assertTrue](src/assert/true/true.assert.ts)
 - [assertTypeBigInt](src/assert/type-bigint/type-bigint.assert.ts)
 - [assertTypeBoolean](src/assert/type-boolean/type-boolean.assert.ts)
@@ -70,8 +104,42 @@ npm install @kensio/smartass
 - [assertTypeNumber](src/assert/type-number/type-number.assert.ts)
 - [assertTypeNumeric](src/assert/type-numeric/type-numeric.assert.ts)
 - [assertTypeObject](src/assert/type-object/type-object.assert.ts)
-- [assertTypeOf](src/assert/typeof/typeof.assert.ts)
 - [assertTypeString](src/assert/type-string/type-string.assert.ts)
+- [assertTypeSymbol](src/assert/type-symbol/type-symbol.assert.ts)
 - [assertTypeTypedArray](src/assert/type-typed-array/type-typed-array.assert.ts)
 - [assertUndefined](src/assert/undefined/undefined.assert.ts)
 - [assertUuidV4](src/assert/uuid/uuid-v4.assert.ts)
+<!-- assertion-functions:end -->
+
+## Matcher functions
+
+<!-- matcher-functions:start -->
+
+- [arrayIncludingAll](src/assert/array-includes-all/array-includes-all.match.ts)
+- [arrayIncluding](src/assert/array-includes/array-includes.match.ts)
+- [arrayOfLength](src/assert/array-length/array-length.match.ts)
+- [arrayOfMinLength](src/assert/array-min-length/array-min-length.match.ts)
+- [nonEmptyArray](src/assert/array-not-empty/array-not-empty.match.ts)
+- [bufferEqualTo](src/assert/buffer-equal/buffer-equal.match.ts)
+- [instanceOf](src/assert/instance-of/instance-of.match.ts)
+- [nonNullable](src/assert/non-nullable/non-nullable.match.ts)
+- [numberBetween](src/assert/number-between/number-between.match.ts)
+- [numberToNearest](src/assert/number-to-nearest/number-to-nearest.match.ts)
+- [objectWithProperty](src/assert/object-has-property/object-has-property.match.ts)
+- [oneOf](src/assert/one-of/one-of.match.ts)
+- [stringEndingWith](src/assert/string-ends-with/string-ends-with.match.ts)
+- [stringIncluding](src/assert/string-includes/string-includes.match.ts)
+- [stringOfLength](src/assert/string-length/string-length.match.ts)
+- [stringNotIncluding](src/assert/string-not-includes/string-not-includes.match.ts)
+- [stringStartingWith](src/assert/string-starts-with/string-starts-with.match.ts)
+- [typeBigInt](src/assert/type-bigint/type-bigint.match.ts)
+- [typeBoolean](src/assert/type-boolean/type-boolean.match.ts)
+- [typeFunction](src/assert/type-function/type-function.match.ts)
+- [typeNumber](src/assert/type-number/type-number.match.ts)
+- [typeNumeric](src/assert/type-numeric/type-numeric.match.ts)
+- [typeObject](src/assert/type-object/type-object.match.ts)
+- [typeString](src/assert/type-string/type-string.match.ts)
+- [typeSymbol](src/assert/type-symbol/type-symbol.match.ts)
+- [typeTypedArray](src/assert/type-typed-array/type-typed-array.match.ts)
+- [uuidV4](src/assert/uuid/uuid-v4.match.ts)
+<!-- matcher-functions:end -->

package/package.json

@@ -7,7 +7,7 @@
     "url": "https://github.com/KensioSoftware/smartass"
   },
   "license": "AGPL-3.0",
-  "version": "1.9.0",
+  "version": "1.10.0",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -41,11 +41,11 @@
     "@types/node": "^25.9.3",
     "@vitest/coverage-v8": "^4.1.8",
     "@vitest/eslint-plugin": "^1.6.20",
-    "eslint": "^10.4.1",
+    "eslint": "^10.5.0",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-jsdoc": "^62.9.0",
     "eslint-plugin-no-secrets": "^2.3.3",
-    "eslint-plugin-security": "^4.0.0",
+    "eslint-plugin-security": "^4.0.1",
     "eslint-plugin-unicorn": "^64.0.0",
     "globals": "^17.6.0",
     "jiti": "^2.7.0",
@@ -58,8 +58,9 @@
     "build": "tsc -p tsconfig.build.json",
     "build:check": "tsc -p tsconfig.json --noEmit",
     "build:index": "bash scripts/build-index.sh",
-    "fmt": "eslint --fix '{src,test}/**/*.ts' && prettier --write '{src,test}/**/*.{ts,json,md,css,html,yml,yaml}'",
-    "lint": "eslint '{src,test}/**/*.ts' && prettier --check '{src,test}/**/*.{ts,json,md,css,html,yml,yaml}'",
+    "build:readme": "bash scripts/build-readme-lists.sh",
+    "fmt": "eslint --fix . && prettier --write .",
+    "lint": "eslint . && prettier --check .",
     "test": "vitest run --typecheck",
     "test:coverage": "vitest run --typecheck --coverage",
     "check": "pnpm fmt && pnpm build:check && pnpm test:coverage"