fix(json): removes Json.Arbitrary module so users don't have to depend on fast-check

.changeset/short-nails-travel.md

@@ -0,0 +1,5 @@
+---
+"@traversable/json": patch
+---
+
+fix(json): removes `Arbitrary` module so users don't have to download fast-check as a dep

packages/json/src/arbitrary.ts

@@ -1,61 +1,61 @@
-import type { Json } from './exports.js'
-import * as fc from 'fast-check'
+// import type { Json } from './exports.js'
+// import * as fc from 'fast-check'
 
-/** @internal */
-const depthIdentifier = fc.createDepthIdentifier()
+// /** @internal */
+// const depthIdentifier = fc.createDepthIdentifier()
 
-/** @internal */
-const identifier = fc.stringMatching(/[_$a-zA-Z][_$a-zA-Z0-9]+/g)
+// /** @internal */
+// const identifier = fc.stringMatching(/[_$a-zA-Z][_$a-zA-Z0-9]+/g)
 
-/** @internal */
-const scalars = [
-  fc.constant(null),
-  fc.constant(undefined),
-  fc.boolean(),
-  fc.integer(),
-  fc.float(),
-  fc.string(),
-]
+// /** @internal */
+// const scalars = [
+//   fc.constant(null),
+//   fc.constant(undefined),
+//   fc.boolean(),
+//   fc.integer(),
+//   fc.float(),
+//   fc.string(),
+// ]
 
-/** @internal */
-const seed: fc.LetrecTypedBuilder<Seed> = (LOOP) => {
-  return {
-    scalar: fc.oneof(...scalars),
-    array: fc.array(LOOP('any')),
-    object: fc.dictionary(identifier, LOOP('any')),
-    any: fc.oneof(
-      { depthIdentifier, maxDepth: 2, depthSize: 'xsmall', withCrossShrink: true },
-      ...scalars,
-      LOOP('scalar'),
-      LOOP('array'),
-      LOOP('object'),
-    )
-  }
-}
+// /** @internal */
+// const seed: fc.LetrecTypedBuilder<Seed> = (LOOP) => {
+//   return {
+//     scalar: fc.oneof(...scalars),
+//     array: fc.array(LOOP('any')),
+//     object: fc.dictionary(identifier, LOOP('any')),
+//     any: fc.oneof(
+//       { depthIdentifier, maxDepth: 2, depthSize: 'xsmall', withCrossShrink: true },
+//       ...scalars,
+//       LOOP('scalar'),
+//       LOOP('array'),
+//       LOOP('object'),
+//     )
+//   }
+// }
 
-/**
- * ## {@link Seed `Json.Seed`}
- * 
- * This type describes an object whose values are [fast-check](https://github.com/dubzzz/fast-check)
- * arbitraries that are capable of generating arbitrary, valid JSON values.
- * 
- * See also:
- * - {@link Arbitrary `Json.Arbitrary`}
- */
-export interface Seed {
-  any: Json
-  scalar: Json.Scalar
-  array: readonly this['any'][]
-  object: Record<string, this['any']>
-}
+// /**
+//  * ## {@link Seed `Json.Seed`}
+//  * 
+//  * This type describes an object whose values are [fast-check](https://github.com/dubzzz/fast-check)
+//  * arbitraries that are capable of generating arbitrary, valid JSON values.
+//  * 
+//  * See also:
+//  * - {@link Arbitrary `Json.Arbitrary`}
+//  */
+// export interface Seed {
+//   any: Json
+//   scalar: Json.Scalar
+//   array: readonly this['any'][]
+//   object: Record<string, this['any']>
+// }
 
-/**
- * ## {@link Arbitrary `Json.Arbitrary`}
- * 
- * An object whose values are [fast-check](https://github.com/dubzzz/fast-check)
- * arbitraries that are capable of generating arbitrary, valid JSON values.
- * 
- * See also:
- * - {@link Seed `Json.Seed`}
- */
-export const Arbitrary = fc.letrec(seed)
+// /**
+//  * ## {@link Arbitrary `Json.Arbitrary`}
+//  * 
+//  * An object whose values are [fast-check](https://github.com/dubzzz/fast-check)
+//  * arbitraries that are capable of generating arbitrary, valid JSON values.
+//  * 
+//  * See also:
+//  * - {@link Seed `Json.Seed`}
+//  */
+// export const Arbitrary = fc.letrec(seed)

packages/json/src/exports.ts

@@ -1,5 +1,4 @@
 import * as _ from './functor.js'
-import { Arbitrary as _Arbitrary } from './arbitrary.js'
 
 export { VERSION } from './version.js'
 export { Cache } from './cache.js'

packages/json/src/json.ts

@@ -1,5 +1,3 @@
-export { Arbitrary } from './arbitrary.js'
-
 export type {
   Fixpoint,
   Free,

packages/json/test/arbitrary.ts

@@ -0,0 +1,61 @@
+import { Json } from '@traversable/json'
+import * as fc from 'fast-check'
+
+/** @internal */
+const depthIdentifier = fc.createDepthIdentifier()
+
+/** @internal */
+const identifier = fc.stringMatching(/[_$a-zA-Z][_$a-zA-Z0-9]+/g)
+
+/** @internal */
+const scalars = [
+  fc.constant(null),
+  fc.constant(undefined),
+  fc.boolean(),
+  fc.integer(),
+  fc.float(),
+  fc.string(),
+]
+
+/** @internal */
+const seed: fc.LetrecTypedBuilder<Seed> = (LOOP) => {
+  return {
+    scalar: fc.oneof(...scalars),
+    array: fc.array(LOOP('any')),
+    object: fc.dictionary(identifier, LOOP('any')),
+    any: fc.oneof(
+      { depthIdentifier, maxDepth: 2, depthSize: 'xsmall', withCrossShrink: true },
+      ...scalars,
+      LOOP('scalar'),
+      LOOP('array'),
+      LOOP('object'),
+    )
+  }
+}
+
+/**
+ * ## {@link Seed `Json.Seed`}
+ * 
+ * This type describes an object whose values are [fast-check](https://github.com/dubzzz/fast-check)
+ * arbitraries that are capable of generating arbitrary, valid JSON values.
+ * 
+ * See also:
+ * - {@link Arbitrary `Json.Arbitrary`}
+ */
+export interface Seed {
+  any: Json
+  scalar: Json.Scalar
+  array: readonly this['any'][]
+  object: Record<string, this['any']>
+}
+
+/**
+ * ## {@link Arbitrary `Json.Arbitrary`}
+ * 
+ * An object whose values are [fast-check](https://github.com/dubzzz/fast-check)
+ * arbitraries that are capable of generating arbitrary, valid JSON values.
+ * 
+ * See also:
+ * - {@link Seed `Json.Seed`}
+ */
+export const Arbitrary = fc.letrec(seed)

packages/json/test/cache.test.ts

@@ -4,6 +4,8 @@ import { fc, test } from '@fast-check/vitest'
 import { Cache, Json } from '@traversable/json'
 import { symbol } from '@traversable/registry'
 
+import { Arbitrary } from './arbitrary.js'
+
 vi.describe('〖⛳️〗‹‹‹ ❲@traversable/json❳', () => {
   const createBadCache = Cache.new as any
   const index = { depth: 0, path: [] }
@@ -20,7 +22,7 @@ vi.describe('〖⛳️〗‹‹‹ ❲@traversable/json❳', () => {
   })
 
   test.prop(
-    [fc.dictionary(fc.string(), Json.Arbitrary.object)], {
+    [fc.dictionary(fc.string(), Arbitrary.object)], {
     // numRuns: 10_000,
     examples: [
       [{ "toString": {} }]

packages/json/test/json.test.ts

@@ -1,6 +1,9 @@
 import { Json } from '@traversable/json'
 import * as vi from 'vitest'
 import { test } from '@fast-check/vitest'
+import * as fc from 'fast-check'
+import { Arbitrary } from './arbitrary.js'
+
 
 const addMetadata = (data: Json) =>
   !Json.isObject(data) ? data
@@ -16,17 +19,17 @@ const rmMetadata = (data: Json) => {
 
 vi.describe('〖⛳️〗‹‹‹ ❲@traversable/json❳', () => {
   test.prop(
-    [Json.Arbitrary.any], {
+    [Arbitrary.any], {
     // numRuns: 50_000
   })(
     '〖⛳️〗› ❲Json#Functor❳: Functor.map preserves structure',
     (json) => {
       vi.assert.deepEqual(Json.Functor.map((x) => x)(json), json)
     }
-  );
+  )
 
   test.prop(
-    [Json.Arbitrary.object], {
+    [Arbitrary.object], {
     // numRuns: 50_000,
   })(
     '〖⛳️〗› ❲Json#fold + Json#unfold❳',
@@ -38,5 +41,5 @@ vi.describe('〖⛳️〗‹‹‹ ❲@traversable/json❳', () => {
       vi.assert.notDeepEqual(withoutMetadata, withMetadata)
       vi.assert.deepEqual(json, withoutMetadata)
     }
-  );
+  )
 })