🔖 0.3.0 of everything

.github/workflows/publish.yml

@@ -18,16 +18,19 @@ jobs:
             - name: Set up Deno
               uses: denoland/setup-deno@v1
               with:
-                  deno-version: 2.0.0
+                  deno-version: 2.0.2
 
-            - name: Lint
+            - name: Lint code
               run: deno lint
 
+            - name: Lint docs
+              run: deno run lint-docs
+
             - name: Format
-              run: deno fmt --check
+              run: deno run format-check
 
             - name: Test
-              run: deno test --coverage
+              run: deno run test-coverage
 
             - name: Generate Coverage
               run: deno coverage --lcov coverage/ > coverage.lcov

.vscode/settings.json

@@ -4,5 +4,11 @@
 		"source.organizeImports": "explicit"
 	},
 	"editor.defaultFormatter": "denoland.vscode-deno",
-	"editor.formatOnSave": true
+	"editor.formatOnSave": true,
+	"[yaml]": {
+		"editor.insertSpaces": true,
+		"editor.tabSize": 4,
+		"editor.autoIndent": "advanced",
+		"diffEditor.ignoreTrimWhitespace": false
+	}
 }

@coven/compare/CreateDifference.ts

@@ -6,7 +6,7 @@ import type { WithPropertyPath } from "./WithPropertyPath.ts";
  *
  * @example Object that satisfies a creation difference
  * ```typescript
- * const createDifference = ({
+ * ({
  * 	kind: "CREATE",
  * 	right: "created value",
  * 	path: ["property", "path"].values()

@coven/compare/README.md

@@ -3,7 +3,7 @@
 [![JSR](https://jsr.io/badges/@coven/compare)](https://jsr.io/@coven/compare)
 [![JSR Score](https://jsr.io/badges/@coven/compare/score)](https://jsr.io/@coven/compare/score)
 
-🪞 Minimalistic deep comparison.
+⚖️ Minimalist diffing.
 
 This library takes 2 values (a `left` and a `right`) and returns an iterator
 with all the differences between said values. The differences are represented by

@coven/compare/compare.ts

@@ -18,28 +18,15 @@ const alwaysFalse = always(false);
  *
  * @example Using compare with strings
  * ```typescript
- * import { flat } from "@coven/compare";
- * import { assertEquals } from "@std/assert";
- *
  * const witchCompare = compare("🧙‍♀️");
- *
- * assertEquals(flat(witchCompare("🧙‍♀️")), []);
- * assertEquals(
- * 	flat(witchCompare("🎃")),
- * 	[{ kind: "UPDATE", left: "🧙‍♀️", right: "🎃", path: [] }]
- * );
+ * witchCompare("🧙‍♀️"); // Yields nothing
+ * witchCompare("🎃"); // Yields { kind: "UPDATE", left: "🧙‍♀️", right: "🎃", path: [] }
  * ```
  * @example Using compare with objects
  * ```typescript
- * import { flat } from "@coven/compare";
- * import { assertEquals } from "@std/assert";
- *
  * const witchObjectCompare = compare({ witch: "🧙‍♀️" });
  *
- * assertEquals(
- * 	flat(witchObjectCompare({ witch: "🎃" })),
- * 	[{ kind: "UPDATE", left: "🧙‍♀️", right: "🎃", path: ["witch"] }],
- * );
+ * witchObjectCompare({ witch: "🎃" }); // Yields { kind: "UPDATE", left: "🧙‍♀️", right: "🎃", path: ["witch"] }
  * ```
  * @see {@linkcode CurriedComparison}
  * @see {@linkcode compareObjects}

@coven/compare/compareIterables.ts

@@ -17,19 +17,10 @@ import { pathPrepend } from "./pathPrepend.ts";
  *
  * @example Compare 2 arrays of numbers
  * ```typescript
- * import { flat } from "@coven/compare";
- * import { assertEquals } from "@std/assert";
- *
  * const compare1342 = compareIterables([13, 42]);
  *
- * assertEquals(
- * 	flat(compare1342([13, 42])),
- * 	[],
- * );
- * assertEquals(
- * 	flat(compare1342([13, 665])),
- * 	[{ kind: "UPDATE", left: 42, right: 665, path: [1] }]
- * );
+ * compare1342([13, 42]); // Yields nothing
+ * compare1342([13, 665]); // Yields { kind: "UPDATE", left: 42, right: 665, path: [1] }
  * ```
  * @see {@linkcode compare}
  * @param left Original iterable.

@coven/compare/compareObjects.ts

@@ -14,14 +14,8 @@ import type { Difference } from "./Difference.ts";
  *
  * @example Compare 2 objects with the same property but different value
  * ```typescript
- * import { flat } from "@coven/compare";
- * import { assertEquals } from "@std/assert";
- *
  * const compareWitch = compareObjects({ witch: "🧙‍♀️" });
- * assertEquals(
- * 	flat(compareWitch({ witch: "🎃" })),
- * 	[{ kind: "UPDATE", left: "🧙‍♀️", right: "🎃", path: ["witch"] }]
- * );
+ * compareWitch({ witch: "🎃" }); // Yields { kind: "UPDATE", left: "🧙‍♀️", right: "🎃", path: ["witch"] }
  * ```
  * @see {@linkcode compareIterables}
  * @see {@linkcode compareProperties}

@coven/compare/compareProperties.ts

@@ -13,15 +13,8 @@ import { pathPrepend } from "./pathPrepend.ts";
  *
  * @example Compare objects
  * ```typescript
- * import { flat } from "@coven/compare";
- * import { assertEquals } from "@std/assert";
- *
  * const compareWitch = compareProperties({ witch: "🧙‍♀️" });
- *
- * assertEquals(
- * 	flat(compareWitch({ witch: "🎃" })),
- * 	[{ kind: "UPDATE", left: "🧙‍♀️", right: "🎃", path: ["witch"] }],
- * );
+ * compareWitch({ witch: "🎃" }); // Yields { kind: "UPDATE", left: "🧙‍♀️", right: "🎃", path: ["witch"] }
  * ```
  * @see {@linkcode compare}
  * @see {@linkcode getKeys}

@coven/compare/deno.json

@@ -1,5 +1,5 @@
 {
 	"name": "@coven/compare",
-	"version": "0.2.0",
+	"version": "0.3.0",
 	"exports": "./mod.ts"
 }

@coven/compare/differentiate.ts

@@ -26,44 +26,26 @@ const differenceBase = { path: toIterable(EMPTY_ARRAY) };
  *
  * @example Missing right value
  * ```typescript
- * import { MISSING_VALUE, flat } from "@coven/compare";
- * import { assertEquals } from "@std/assert";
+ * import { MISSING_VALUE } from "@coven/compare";
  *
- * assertEquals(
- * 	flat(differentiate("🧙‍♀️")(MISSING_VALUE)),
- * 	[{ kind: "DELETE", left: "🧙‍♀️", path: [] }]
- * );
+ * differentiate("🧙‍♀️")(MISSING_VALUE); // Yields { kind: "DELETE", left: "🧙‍♀️", path: [] }
  * ```
  * @example Missing left value
  * ```typescript
- * import { MISSING_VALUE, flat } from "@coven/compare";
- * import { assertEquals } from "@std/assert";
+ * import { MISSING_VALUE } from "@coven/compare";
  *
- * assertEquals(
- * 	flat(differentiate(MISSING_VALUE)("🎃")),
- * 	[{ kind: "CREATE", right: "🎃", path: [] }]
- * );
+ * differentiate(MISSING_VALUE)("🎃"); // Yields { kind: "CREATE", right: "🎃", path: [] }
  * ```
  * @example Both values set
  * ```typescript
- * import { flat } from "@coven/compare";
- * import { assertEquals } from "@std/assert";
- *
- * assertEquals(
- * 	flat(differentiate("🧙‍♀️")("🎃")),
- * 	[{ kind: "UPDATE", left: "🧙‍♀️", right: "🎃", path: [] }]
- * );
- * differentiate("🧙‍♀️")("🧙‍♀️"); // yields []
+ * differentiate("🧙‍♀️")("🎃"); // Yields { kind: "UPDATE", left: "🧙‍♀️", right: "🎃", path: [] }
+ * differentiate("🧙‍♀️")("🧙‍♀️"); // Yields nothing
  * ```
  * @example Both values missing
  * ```typescript
- * import { MISSING_VALUE, flat } from "@coven/compare";
- * import { assertEquals } from "@std/assert";
+ * import { MISSING_VALUE } from "@coven/compare";
  *
- * assertEquals(
- * 	flat(differentiate(MISSING_VALUE)(MISSING_VALUE)),
- * 	[]
- * );
+ * differentiate(MISSING_VALUE)(MISSING_VALUE); // Yields nothing
  * ```
  * @see {@linkcode Difference}
  * @param left Left/Original value.

@coven/compare/flat.ts

@@ -10,17 +10,13 @@ import { flatPathMap } from "./flatPathMap.ts";
  * @example Flatting a creation Difference
  * ```typescript
  * import type { Difference } from "@coven/compare";
- * import { assertEquals } from "@std/assert";
  *
- * assertEquals(flat([{
+ * flat([{
  * 	kind: "CREATE",
  * 	path: ["property", "path"].values(),
  * 	right: "created value",
- * }].values() as Iterable<Difference>), [{
- * 	kind: "CREATE",
- * 	path: ["property", "path"],
- * 	right: "created value",
- * }])
+ * }].values() as Iterable<Difference>);
+ * // [{ kind: "CREATE", path: ["property", "path"], right: "created value" }]
  * ```
  * @see {@linkcode Difference}
  * @see {@linkcode FlatDifference}

@coven/compare/getKeys.ts

@@ -9,9 +9,8 @@ const isFunctionConstructor = is(Function);
  *
  * @example Get keys of a plain object
  * ```typescript
- * import { assertEquals } from "@std/assert";
- *
- * assertEquals([...getKeys({})], []);
+ * getKeys({}); // Yields nothing
+ * getKeys({ coven: "engineering" }); // Yields "coven"
  * ```
  * @param object Object to get the keys from.
  * @yields Object keys.

@coven/compare/pathPrepend.ts

@@ -7,19 +7,11 @@ import { setPath } from "./setPath.ts";
  *
  * @example Prepend string to path
  * ```typescript
- * import { flat } from "@coven/compare";
- * import { assertEquals } from "@std/assert";
- *
- * assertEquals(flat([
- * 	pathPrepend("coven")({
+ * pathPrepend("coven")({
  * 	kind: "DELETE",
  * 	left: 13,
  * 	path: ["engineering"].values()
- * })]), [{
- * 	kind: "DELETE",
- * 	left: 13,
- * 	path: ["coven", "engineering"]
- * }]);
+ * }); // Yields { kind: "DELETE", left: 13, path: ["coven", "engineering"] }
  * ```
  * @param prepend Property to prepend.
  * @returns Curried generator with `prepend` in context.

@coven/constants/EMPTY_ARRAY.ts

@@ -1,6 +1,9 @@
 /**
- * Empty read-only array. The array is read-only in runtime by `Object.freeze`,
- * so trying to do mutations will throw.
+ * Empty read-only array.
+ *
+ * > [!IMPORTANT]
+ * > The array is read-only in runtime by `Object.freeze`, so trying to do
+ * > mutations will throw.
  *
  * @see [Object.freeze](https://mdn.io/Oject.freeze)
  */

@coven/constants/EMPTY_OBJECT.ts

@@ -1,6 +1,9 @@
 /**
- * Empty read-only `null` prototype object. The object is read-only in runtime
- * by `Object.freeze`, so trying to do mutations will throw.
+ * Empty read-only `null` prototype object.
+ *
+ * > [!IMPORTANT]
+ * > The object is read-only in runtime by `Object.freeze`, so trying to do
+ * > mutations will throw.
  *
  * @see [Object.create](https://mdn.io/Object.create)
  * @see [Object.freeze](https://mdn.io/Object.freeze)

@coven/constants/EMPTY_STRING.ts

@@ -1,4 +1,6 @@
 /**
- * Empty string. This one exists to have something more readable than `""`.
+ * Empty string.
+ *
+ * This one exists to have something more readable than `""`.
  */
 export const EMPTY_STRING = "";

@coven/constants/README.md

@@ -3,16 +3,13 @@
 [![JSR](https://jsr.io/badges/@coven/constants)](https://jsr.io/@coven/constants)
 [![JSR Score](https://jsr.io/badges/@coven/constants/score)](https://jsr.io/@coven/constants/score)
 
-📖 Shared constants scrolls.
+🧱 Common constants.
 
 ## Constants
 
-- `EMPTY_ARRAY`: Empty read-only array. The array is read-only in runtime by
-  `Object.freeze`, so trying to do mutations will throw.
-- `EMPTY_OBJECT`: Empty read-only `null` prototype object. The object is
-  read-only in runtime by `Object.freeze`, so trying to do mutations will throw.
-- `EMPTY_STRING`: Empty string. This one exists to have something more readable
-  than `""`.
+- `EMPTY_ARRAY`: Empty read-only array.
+- `EMPTY_OBJECT`: Empty read-only `null` prototype object.
+- `EMPTY_STRING`: Empty string.
 
 ## Example
 

@coven/constants/deno.json

@@ -1,5 +1,5 @@
 {
 	"name": "@coven/constants",
-	"version": "0.1.0",
+	"version": "0.3.0",
 	"exports": "./mod.ts"
 }

@coven/cron/CronObject.ts

@@ -5,8 +5,8 @@ import type { MonthValue } from "./MonthValue.ts";
 /**
  * Object that represents the 5 cron expression fields.
  *
- * @see {@link Field}
- * @see {@link MonthValue}
+ * @see {@linkcode Field}
+ * @see {@linkcode MonthValue}
  */
 export type CronObject = {
 	readonly dayOfMonth: Field<DayOfMonth>;

@coven/cron/Field.ts

@@ -3,12 +3,12 @@ import type { ListField } from "./ListField.ts";
 import type { ValueOrRangeField } from "./ValueOrRangeField.ts";
 
 /**
- * Union of {@link AllToken}, {@link ValueOrRangeField} and {@link ListField}
+ * Union of {@linkcode AllToken}, {@linkcode ValueOrRangeField} and {@linkcode ListField}
  * that represents a field in a cron expression.
  *
- * @see {@link AllToken}
- * @see {@link ValueOrRangeField}
- * @see {@link ListField}
+ * @see {@linkcode AllToken}
+ * @see {@linkcode ValueOrRangeField}
+ * @see {@linkcode ListField}
  */
 export type Field<Value extends number> =
 	| AllToken

@coven/cron/FieldString.ts

@@ -3,11 +3,11 @@ import type { ListString } from "./ListString.ts";
 import type { ValueOrRangeString } from "./ValueOrRangeString.ts";
 
 /**
- * Union of {@link AllToken}, {@link ValueOrRangeString} and {@link ListString}
+ * Union of {@linkcode AllToken}, {@linkcode ValueOrRangeString} and {@linkcode ListString}
  * that represents a field in a cron expression.
  *
- * @see {@link AllToken}
- * @see {@link ValueOrRangeString}
- * @see {@link ListString}
+ * @see {@linkcode AllToken}
+ * @see {@linkcode ValueOrRangeString}
+ * @see {@linkcode ListString}
  */
 export type FieldString = AllToken | ListString | ValueOrRangeString;

@coven/cron/ListField.ts

@@ -4,7 +4,7 @@ import type { ValueOrRangeField } from "./ValueOrRangeField.ts";
 /**
  * Type that represents a list of values for a cron object field.
  *
- * @see {@link ValueOrRangeField}
+ * @see {@linkcode ValueOrRangeField}
  */
 export type ListField<Value extends number> = ReadonlyArray<
 	ValueOrRangeField<Value>

@coven/cron/ListString.ts

@@ -4,7 +4,7 @@ import type { ValueOrRangeString } from "./ValueOrRangeString.ts";
 /**
  * Type that represents a list of values for a cron string field.
  *
- * @see {@link ValueOrRangeString}
+ * @see {@linkcode ValueOrRangeString}
  */
 export type ListString =
 	`${string}${ListExpressionSeparatorToken}${ValueOrRangeString}`;