type-guardians 1.1.1 → 1.2.1--canary.4.1b6a4c4.0

package/.autorc

@@ -0,0 +1,12 @@
+{
+	"noVersionPrefix": true,
+	"plugins": [
+	   "npm",
+	  [
+		"conventional-commits",
+		{
+		  "preset": "angular"
+		}
+	  ]
+	]
+}

package/.github/workflows/code-quality.yaml

@@ -5,7 +5,7 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 2
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - uses: pnpm/action-setup@v4
       - uses: biomejs/setup-biome@v2
       - uses: actions/setup-node@v4
@@ -16,3 +16,29 @@ jobs:
       - run: biome ci .
       - run: pnpm ts:check
       - run: pnpm test
+
+  publish:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    permissions:
+      contents: read
+      id-token: write
+    environment:
+      name: npm
+      url: https://www.npmjs.com/package/type-guardians
+    if: ${{ !contains(github.event.head_commit.message, 'skip ci') }}
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+          ssh-key: ${{ secrets.SSH_KEY }}
+      - uses: pnpm/action-setup@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: 'pnpm'
+      - run: pnpm install
+      - run: pnpm release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

package/README.md

@@ -37,7 +37,7 @@ function greet(name: unknown) {
 
 ### `assert` functions
 
-`assert` functions are assertions that throw a `TypeError` if the input value is not of the expected type. You can use them to ensure that a variable has a certain type before using it.
+`assert` functions are assertions that throw a `TypeError` if the input value is not of the expected type. You can use them to ensure that a variable has a certain type before using it. You can also provide a custom error message as an optional second parameter.
 
 ```typescript
 import { assertNumber } from "type-guardians/number";
@@ -54,9 +54,9 @@ function double(value: unknown) {
 ### String
 
 - `isString(value: unknown): value is string`
-- `assertString(value: unknown): asserts value is string`
+- `assertString(value: unknown, message?: string): asserts value is string`
 
 ### Number
 
 - `isNumber(value: unknown): value is number`
-- `assertNumber(value: unknown): asserts value is number`
+- `assertNumber(value: unknown, message?: string): asserts value is number`

package/number.ts

@@ -2,6 +2,9 @@ export function isNumber(value: unknown): value is string {
 	return typeof value === "number";
 }
 
-export function assertNumber(value: unknown): asserts value is number {
-	if (typeof value !== "number") throw new TypeError(`Expected a number, received ${typeof value}`);
+export function assertNumber(
+	value: unknown,
+	message = `Expected a number, received ${typeof value}`,
+): asserts value is number {
+	if (typeof value !== "number") throw new TypeError(message);
 }

package/package.json

@@ -1,27 +1,50 @@
 {
-  "name": "type-guardians",
-  "version": "1.1.1",
-  "description": "",
-  "keywords": [],
-  "repository": "https://github.com/pchalupa/type-guardians",
-  "homepage": "https://github.com/pchalupa/type-guardians#readme",
-  "bugs": {
-    "url": "https://github.com/pchalupa/type-guardians/issues"
-  },
-  "author": "pchalupa <chalupa.petr93@gmail.com> (https://github.com/pchalupa)",
-  "license": "MIT",
-  "type": "module",
-  "devDependencies": {
-    "@biomejs/biome": "2.1.4",
-    "typescript": "^5.9.2",
-    "vitest": "^3.1.2"
-  },
-  "scripts": {
-    "lint": "biome lint .",
-    "format": "biome format .",
-    "ts:check": "tsc --noEmit",
-    "test": "vitest run",
-    "test:watch": "vitest watch",
-    "test:coverage": "vitest test --coverage"
-  }
-}
+	"name": "type-guardians",
+	"version": "1.2.1--canary.4.1b6a4c4.0",
+	"description": "A lightweight, zero-dependency TypeScript library providing type guards and assertions for safer and more readable code",
+	"keywords": [
+		"typescript",
+		"type-guards",
+		"type-assertions",
+		"type-safety",
+		"runtime-validation",
+		"type-checking",
+		"assertions",
+		"guards",
+		"validation"
+	],
+	"repository": "https://github.com/pchalupa/type-guardians",
+	"homepage": "https://github.com/pchalupa/type-guardians#readme",
+	"bugs": {
+		"url": "https://github.com/pchalupa/type-guardians/issues"
+	},
+	"author": "pchalupa <chalupa.petr93@gmail.com> (https://github.com/pchalupa)",
+	"license": "MIT",
+	"type": "module",
+	"exports": {
+		"./string": "./string.ts",
+		"./number": "./number.ts"
+	},
+	"scripts": {
+		"lint": "biome lint .",
+		"format": "biome format .",
+		"ts:check": "tsc --noEmit",
+		"test": "vitest run",
+		"test:watch": "vitest watch",
+		"test:coverage": "vitest test --coverage",
+		"release": "auto shipit"
+	},
+	"devDependencies": {
+		"@auto-it/conventional-commits": "^11.3.0",
+		"@auto-it/npm": "^11.3.0",
+		"@biomejs/biome": "2.1.4",
+		"@vitest/coverage-v8": "3.1.2",
+		"auto": "^11.3.0",
+		"typescript": "^5.9.2",
+		"vitest": "^3.1.2"
+	},
+	"publishConfig": {
+		"provenance": true
+	},
+	"packageManager": "pnpm@10.14.0"
+}

package/string.ts

@@ -2,6 +2,9 @@ export function isString(value: unknown): value is string {
 	return typeof value === "string";
 }
 
-export function assertString(value: unknown): asserts value is string {
-	if (typeof value !== "string") throw new TypeError(`Expected a string, received ${typeof value}`);
+export function assertString(
+	value: unknown,
+	message = `Expected a string, received ${typeof value}`,
+): asserts value is string {
+	if (typeof value !== "string") throw new TypeError(message);
 }