📝 small JSDocs improvements.

vangware · Oct 5, 2023 · 13ab5e9 · 13ab5e9
1 parent 9322170
commit 13ab5e9
Show file tree

Hide file tree

Showing 37 changed files with 129 additions and 26 deletions.
diff --git a/package.json b/package.json
@@ -16,13 +16,13 @@
 		"@vangware/test": "workspace:*"
 	},
 	"devDependencies": {
-		"@astrojs/prefetch": "^0.4.0",
+		"@astrojs/prefetch": "^0.4.1",
 		"@astrojs/starlight": "^0.10.4",
 		"@astrojs/starlight-tailwind": "^2.0.0",
-		"@astrojs/tailwind": "^5.0.0",
+		"@astrojs/tailwind": "^5.0.1",
 		"@changesets/cli": "^2.26.2",
 		"@types/node": "^20.8.2",
-		"astro": "^3.2.2",
+		"astro": "^3.2.3",
 		"c8": "^8.0.1",
 		"cpy-cli": "^5.0.0",
 		"esbuild": "^0.19.4",

diff --git a/packages/@vangware/ansi/CHANGELOG.md b/packages/@vangware/ansi/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Change log
 
+## 6.3.33
+
+### Patch Changes
+
+-   ⬆️ upgrade `@vangware/types` to `v6.3.3`
+
 ## 6.3.32
 
 ### Patch Changes

diff --git a/packages/@vangware/ansi/package.json b/packages/@vangware/ansi/package.json
@@ -1,7 +1,7 @@
 {
 	"name": "@vangware/ansi",
 	"description": "📟 Functional CLI ANSI formatter",
-	"version": "6.3.32",
+	"version": "6.3.33",
 	"author": {
 		"email": "hello@vangware.com",
 		"name": "Vangware",

diff --git a/packages/@vangware/create-package/CHANGELOG.md b/packages/@vangware/create-package/CHANGELOG.md
@@ -1,5 +1,14 @@
 # Change log
 
+## 1.7.11
+
+### Patch Changes
+
+-   📝 small JSDocs improvements.
+-   ⬆️ upgrade `@vangware/types` to `v6.3.3`
+-   ⬆️ upgrade `@vangware/ansi` to `v6.3.33`
+-   ⬆️ upgrade `@vangware/prompts` to `v2.2.12`
+
 ## 1.7.10
 
 ### Patch Changes

diff --git a/packages/@vangware/create-package/package.json b/packages/@vangware/create-package/package.json
@@ -1,7 +1,7 @@
 {
 	"name": "@vangware/create-package",
 	"description": "🚧 Vangware package scaffolder script",
-	"version": "1.7.10",
+	"version": "1.7.11",
 	"author": {
 		"email": "hello@vangware.com",
 		"name": "Vangware",

diff --git a/packages/@vangware/create-package/src/validations/hasSpecialCharacters.ts b/packages/@vangware/create-package/src/validations/hasSpecialCharacters.ts
@@ -2,5 +2,5 @@ import { foregroundRed } from "@vangware/ansi";
 
 export const hasSpecialCharacters = (value: string) =>
 	/[~'!()*]/u.test(value.split("/").slice(-1)[0] ?? "")
-		? foregroundRed`"${value}" shouldn't contain special characters`
+		? foregroundRed`"${value}" must not contain special characters`
 		: "";
diff --git a/packages/@vangware/create-package/src/validations/hasValidLength.ts b/packages/@vangware/create-package/src/validations/hasValidLength.ts
@@ -4,4 +4,4 @@ export const hasValidLength =
 	(minimum: number) => (maximum: number) => (value: string) =>
 		value.length >= minimum && value.length <= maximum
 			? ""
-			: foregroundRed`"${value}" should be between ${minimum} and ${maximum} characters long`;
+			: foregroundRed`"${value}" must be between ${minimum} and ${maximum} characters long`;
diff --git a/packages/@vangware/create-package/src/validations/startsWithPeriod.ts b/packages/@vangware/create-package/src/validations/startsWithPeriod.ts
@@ -2,5 +2,5 @@ import { foregroundRed } from "@vangware/ansi";
 
 export const startsWithPeriod = (value: string) =>
 	value.startsWith(".")
-		? foregroundRed`"${value}" shouldn't start with a period`
+		? foregroundRed`"${value}" must not start with a period`
 		: "";
diff --git a/packages/@vangware/create-package/src/validations/startsWithUnderscore.ts b/packages/@vangware/create-package/src/validations/startsWithUnderscore.ts
@@ -2,5 +2,5 @@ import { foregroundRed } from "@vangware/ansi";
 
 export const startsWithUnderscore = (value: string) =>
 	value.startsWith("_")
-		? foregroundRed`"${value}" shouldn't start with an underscore`
+		? foregroundRed`"${value}" must not start with an underscore`
 		: "";
diff --git a/packages/@vangware/cron/CHANGELOG.md b/packages/@vangware/cron/CHANGELOG.md
@@ -1,5 +1,14 @@
 # Change log
 
+## 5.1.46
+
+### Patch Changes
+
+-   ⬆️ upgrade `@vangware/types` to `v6.3.3`
+-   ⬆️ upgrade `@vangware/iterables` to `v3.1.25`
+-   ⬆️ upgrade `@vangware/parsers` to `v1.4.17`
+-   ⬆️ upgrade `@vangware/predicates` to `v2.2.2`
+
 ## 5.1.45
 
 ### Patch Changes

diff --git a/packages/@vangware/cron/package.json b/packages/@vangware/cron/package.json
@@ -1,7 +1,7 @@
 {
 	"name": "@vangware/cron",
 	"description": "⏲️ Cron Quartz and Cron UNIX expression parser",
-	"version": "5.1.45",
+	"version": "5.1.46",
 	"author": {
 		"email": "hello@vangware.com",
 		"name": "Vangware",

diff --git a/packages/@vangware/iterables/CHANGELOG.md b/packages/@vangware/iterables/CHANGELOG.md
@@ -1,5 +1,13 @@
 # Change log
 
+## 3.1.25
+
+### Patch Changes
+
+-   ⬆️ upgrade `@vangware/types` to `v6.3.3`
+-   ⬆️ upgrade `@vangware/predicates` to `v2.2.2`
+-   ⬆️ upgrade `@vangware/utils` to `v10.1.25`
+
 ## 3.1.24
 
 ### Patch Changes

diff --git a/packages/@vangware/iterables/package.json b/packages/@vangware/iterables/package.json
@@ -1,7 +1,7 @@
 {
 	"name": "@vangware/iterables",
 	"description": "🔁 Iterable and AsyncIterable utils",
-	"version": "3.1.24",
+	"version": "3.1.25",
 	"author": {
 		"email": "hello@vangware.com",
 		"name": "Vangware",

diff --git a/packages/@vangware/notify/CHANGELOG.md b/packages/@vangware/notify/CHANGELOG.md
@@ -1,5 +1,14 @@
 # Change log
 
+## 1.0.14
+
+### Patch Changes
+
+-   ⬆️ upgrade `@vangware/types` to `v6.3.3`
+-   ⬆️ upgrade `@vangware/iterables` to `v3.1.25`
+-   ⬆️ upgrade `@vangware/predicates` to `v2.2.2`
+-   ⬆️ upgrade `@vangware/utils` to `v10.1.25`
+
 ## 1.0.13
 
 ### Patch Changes

diff --git a/packages/@vangware/notify/package.json b/packages/@vangware/notify/package.json
@@ -1,7 +1,7 @@
 {
 	"name": "@vangware/notify",
 	"description": "📣 Minimalistic Pub/Sub implementation",
-	"version": "1.0.13",
+	"version": "1.0.14",
 	"author": {
 		"email": "hello@vangware.com",
 		"name": "Vangware",

diff --git a/packages/@vangware/parsers/CHANGELOG.md b/packages/@vangware/parsers/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Change log
 
+## 1.4.17
+
+### Patch Changes
+
+-   ⬆️ upgrade `@vangware/types` to `v6.3.3`
+
 ## 1.4.16
 
 ### Patch Changes

diff --git a/packages/@vangware/parsers/package.json b/packages/@vangware/parsers/package.json
@@ -1,7 +1,7 @@
 {
 	"name": "@vangware/parsers",
 	"description": "👁️‍🗨️ Parsers without nonsense",
-	"version": "1.4.16",
+	"version": "1.4.17",
 	"author": {
 		"email": "hello@vangware.com",
 		"name": "Vangware",

diff --git a/packages/@vangware/predicates/CHANGELOG.md b/packages/@vangware/predicates/CHANGELOG.md
@@ -1,5 +1,12 @@
 # Change log
 
+## 2.2.2
+
+### Patch Changes
+
+-   ⬆️ upgrade `@vangware/types` to `v6.3.3`
+-   ⬆️ upgrade `@vangware/parsers` to `v1.4.17`
+
 ## 2.2.1
 
 ### Patch Changes

diff --git a/packages/@vangware/predicates/package.json b/packages/@vangware/predicates/package.json
@@ -1,7 +1,7 @@
 {
 	"name": "@vangware/predicates",
 	"description": "🧐 Predicate util functions",
-	"version": "2.2.1",
+	"version": "2.2.2",
 	"author": {
 		"email": "hello@vangware.com",
 		"name": "Vangware",

diff --git a/packages/@vangware/prompts/CHANGELOG.md b/packages/@vangware/prompts/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Change log
 
+## 2.2.12
+
+### Patch Changes
+
+-   ⬆️ upgrade `@vangware/types` to `v6.3.3`
+
 ## 2.2.11
 
 ### Patch Changes

diff --git a/packages/@vangware/prompts/package.json b/packages/@vangware/prompts/package.json
@@ -1,7 +1,7 @@
 {
 	"name": "@vangware/prompts",
 	"description": "⁉️ CLI interactive prompts",
-	"version": "2.2.11",
+	"version": "2.2.12",
 	"author": {
 		"email": "hello@vangware.com",
 		"name": "Vangware",

diff --git a/packages/@vangware/test/CHANGELOG.md b/packages/@vangware/test/CHANGELOG.md
@@ -1,5 +1,12 @@
 # Change log
 
+## 10.3.33
+
+### Patch Changes
+
+-   ⬆️ upgrade `@vangware/types` to `v6.3.3`
+-   ⬆️ upgrade `@vangware/ansi` to `v6.3.33`
+
 ## 10.3.32
 
 ### Patch Changes

diff --git a/packages/@vangware/test/package.json b/packages/@vangware/test/package.json
@@ -1,7 +1,7 @@
 {
 	"name": "@vangware/test",
 	"description": "✅ Equality test with enforced readability",
-	"version": "10.3.32",
+	"version": "10.3.33",
 	"author": {
 		"email": "hello@vangware.com",
 		"name": "Vangware",

diff --git a/packages/@vangware/types/CHANGELOG.md b/packages/@vangware/types/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Change log
 
+## 6.3.3
+
+### Patch Changes
+
+-   📝 small JSDocs improvements.
+
 ## 6.3.2
 
 ### Patch Changes

diff --git a/packages/@vangware/types/package.json b/packages/@vangware/types/package.json
@@ -1,7 +1,7 @@
 {
 	"name": "@vangware/types",
 	"description": "🏷️ Vangware shared types",
-	"version": "6.3.2",
+	"version": "6.3.3",
 	"author": {
 		"email": "hello@vangware.com",
 		"name": "Vangware",

diff --git a/packages/@vangware/types/src/EmptyArray.ts b/packages/@vangware/types/src/EmptyArray.ts
@@ -4,7 +4,7 @@
  * @category Array
  * @remarks
  * This is a type alias for an readonly empty array. Trying to access items on
- * it should give a compile-time error.
+ * it will give a compile-time error.
  * @example
  * ```typescript
  * const emptyArray: EmptyArray = [];

diff --git a/packages/@vangware/types/src/EmptyString.ts b/packages/@vangware/types/src/EmptyString.ts
@@ -3,8 +3,7 @@
  *
  * @category String
  * @remarks
- * This type is a string with no characters on it (length `0`). Trying to access
- * characters should return `undefined`, and several of its methods return another
+ * This type is a string with no characters on it (length `0`).
  * {@link EmptyString}.
  * @example
  * ```typescript

diff --git a/packages/@vangware/utils/CHANGELOG.md b/packages/@vangware/utils/CHANGELOG.md
@@ -1,5 +1,12 @@
 # Change log
 
+## 10.1.25
+
+### Patch Changes
+
+-   ⬆️ upgrade `@vangware/types` to `v6.3.3`
+-   ⬆️ upgrade `@vangware/predicates` to `v2.2.2`
+
 ## 10.1.24
 
 ### Patch Changes

diff --git a/packages/@vangware/utils/package.json b/packages/@vangware/utils/package.json
@@ -1,7 +1,7 @@
 {
 	"name": "@vangware/utils",
 	"description": "⚒️ Vangware curried functional utils",
-	"version": "10.1.24",
+	"version": "10.1.25",
 	"author": {
 		"email": "hello@vangware.com",
 		"name": "Vangware",

diff --git a/packages/@vangware/window-open-promise/CHANGELOG.md b/packages/@vangware/window-open-promise/CHANGELOG.md
@@ -1,5 +1,13 @@
 # Change log
 
+## 5.1.46
+
+### Patch Changes
+
+-   ⬆️ upgrade `@vangware/types` to `v6.3.3`
+-   ⬆️ upgrade `@vangware/iterables` to `v3.1.25`
+-   ⬆️ upgrade `@vangware/predicates` to `v2.2.2`
+
 ## 5.1.45
 
 ### Patch Changes

diff --git a/packages/@vangware/window-open-promise/package.json b/packages/@vangware/window-open-promise/package.json
@@ -1,7 +1,7 @@
 {
 	"name": "@vangware/window-open-promise",
 	"description": "🪟 Promised Window.open();",
-	"version": "5.1.45",
+	"version": "5.1.46",
 	"author": {
 		"email": "hello@vangware.com",
 		"name": "Vangware",

diff --git a/packages/preact-pair/CHANGELOG.md b/packages/preact-pair/CHANGELOG.md
@@ -1,5 +1,13 @@
 # Change log
 
+## 1.0.51
+
+### Patch Changes
+
+-   📝 small JSDocs improvements.
+-   ⬆️ upgrade `@vangware/types` to `v6.3.3`
+-   ⬆️ upgrade `@vangware/utils` to `v10.1.25`
+
 ## 1.0.50
 
 ### Patch Changes

diff --git a/packages/preact-pair/package.json b/packages/preact-pair/package.json
@@ -1,7 +1,7 @@
 {
 	"name": "preact-pair",
 	"description": "🖇️ Util to help with the paired hook pattern",
-	"version": "1.0.50",
+	"version": "1.0.51",
 	"author": {
 		"email": "hello@vangware.com",
 		"name": "Vangware",

diff --git a/packages/preact-pair/src/PairedRenderFunction.ts b/packages/preact-pair/src/PairedRenderFunction.ts
@@ -2,7 +2,7 @@ import type { Function, Unary } from "@vangware/types";
 import type { h } from "preact";
 
 /**
- * Function that receives the paired hook and should return a `VNode`.
+ * Function that receives the paired hook and must return a `VNode`.
  *
  * @category Internal
  */

diff --git a/packages/react-pair/CHANGELOG.md b/packages/react-pair/CHANGELOG.md
@@ -1,5 +1,13 @@
 # Change log
 
+## 3.0.52
+
+### Patch Changes
+
+-   📝 small JSDocs improvements.
+-   ⬆️ upgrade `@vangware/types` to `v6.3.3`
+-   ⬆️ upgrade `@vangware/utils` to `v10.1.25`
+
 ## 3.0.51
 
 ### Patch Changes

diff --git a/packages/react-pair/package.json b/packages/react-pair/package.json
@@ -1,7 +1,7 @@
 {
 	"name": "react-pair",
 	"description": "🖇️ Util to help with the paired hook pattern",
-	"version": "3.0.51",
+	"version": "3.0.52",
 	"author": {
 		"email": "hello@vangware.com",
 		"name": "Vangware",

diff --git a/packages/react-pair/src/PairedRenderFunction.ts b/packages/react-pair/src/PairedRenderFunction.ts
@@ -2,7 +2,7 @@ import type { Function, Unary } from "@vangware/types";
 import type { createElement } from "react";
 
 /**
- * Function that receives the paired hook and should return a `ReactElement`.
+ * Function that receives the paired hook and must return a `ReactElement`.
  *
  * @category Internal
  */