From 7967260eb0fe3785a7978bda0b3a5a882e8a85bb Mon Sep 17 00:00:00 2001 From: Giulio Canti Date: Mon, 10 Mar 2025 11:35:16 +0100 Subject: [PATCH 1/5] Update @effect/docgen and fix code examples --- package.json | 2 +- packages/effect/src/Effect.ts | 1 + packages/effect/src/Micro.ts | 2 +- pnpm-lock.yaml | 10 +++++----- 4 files changed, 8 insertions(+), 7 deletions(-) diff --git a/package.json b/package.json index c0338e6e9ce..d8efa000bda 100644 --- a/package.json +++ b/package.json @@ -40,7 +40,7 @@ "@changesets/cli": "^2.27.7", "@edge-runtime/vm": "^4.0.0", "@effect/build-utils": "^0.7.7", - "@effect/docgen": "https://pkg.pr.new/Effect-TS/docgen/@effect/docgen@ecfa840", + "@effect/docgen": "https://pkg.pr.new/Effect-TS/docgen/@effect/docgen@57ff897", "@effect/eslint-plugin": "^0.2.0", "@effect/language-service": "^0.1.0", "@effect/vitest": "workspace:^", diff --git a/packages/effect/src/Effect.ts b/packages/effect/src/Effect.ts index 56d2b0644ba..ad94a86f1f5 100644 --- a/packages/effect/src/Effect.ts +++ b/packages/effect/src/Effect.ts @@ -7857,6 +7857,7 @@ export { * * @example * ```ts + * import * as assert from "node:assert" * import { Effect, pipe } from "effect" * * const result = pipe( diff --git a/packages/effect/src/Micro.ts b/packages/effect/src/Micro.ts index 8dfcdf28fc6..9d9f2860118 100644 --- a/packages/effect/src/Micro.ts +++ b/packages/effect/src/Micro.ts @@ -1038,7 +1038,7 @@ export { * import { Micro } from "effect" * * Micro.try({ - * try: () => throw new Error("boom"), + * try: () => { throw new Error("boom") }, * catch: (cause) => new Error("caught", { cause }) * }) * ``` diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 2d2350d938d..89345ae55f9 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -53,8 +53,8 @@ importers: specifier: ^0.7.7 version: 0.7.7 '@effect/docgen': - specifier: https://pkg.pr.new/Effect-TS/docgen/@effect/docgen@ecfa840 - version: https://pkg.pr.new/Effect-TS/docgen/@effect/docgen@ecfa840(tsx@4.17.0)(typescript@5.7.2) + specifier: https://pkg.pr.new/Effect-TS/docgen/@effect/docgen@57ff897 + version: https://pkg.pr.new/Effect-TS/docgen/@effect/docgen@57ff897(tsx@4.17.0)(typescript@5.7.2) '@effect/eslint-plugin': specifier: ^0.2.0 version: 0.2.0 @@ -1969,8 +1969,8 @@ packages: engines: {node: '>=16.17.1'} hasBin: true - '@effect/docgen@https://pkg.pr.new/Effect-TS/docgen/@effect/docgen@ecfa840': - resolution: {tarball: https://pkg.pr.new/Effect-TS/docgen/@effect/docgen@ecfa840} + '@effect/docgen@https://pkg.pr.new/Effect-TS/docgen/@effect/docgen@57ff897': + resolution: {tarball: https://pkg.pr.new/Effect-TS/docgen/@effect/docgen@57ff897} version: 0.5.2 engines: {node: '>=18.0.0'} hasBin: true @@ -9419,7 +9419,7 @@ snapshots: '@effect/build-utils@0.7.7': {} - '@effect/docgen@https://pkg.pr.new/Effect-TS/docgen/@effect/docgen@ecfa840(tsx@4.17.0)(typescript@5.7.2)': + '@effect/docgen@https://pkg.pr.new/Effect-TS/docgen/@effect/docgen@57ff897(tsx@4.17.0)(typescript@5.7.2)': dependencies: '@babel/code-frame': 7.26.2 '@effect/markdown-toc': 0.1.0 From 4d62ecd1d9553cd73edc8bf1c21bbda8be48b4e3 Mon Sep 17 00:00:00 2001 From: Giulio Canti Date: Mon, 10 Mar 2025 11:40:07 +0100 Subject: [PATCH 2/5] docs: Add missing import in Covariant module example --- packages/typeclass/src/Covariant.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/packages/typeclass/src/Covariant.ts b/packages/typeclass/src/Covariant.ts index b7629fb7fbd..7b84b5a779a 100644 --- a/packages/typeclass/src/Covariant.ts +++ b/packages/typeclass/src/Covariant.ts @@ -99,6 +99,7 @@ export { /** * @example * ```ts + * import * as assert from "node:assert" * import * as covariant from "@effect/typeclass/Covariant" * import type { HKT } from "effect" * import { dual, pipe } from "effect/Function" From 11f5ae121a59eb5d9f99ffcf21dbca8f63256805 Mon Sep 17 00:00:00 2001 From: Giulio Canti Date: Mon, 10 Mar 2025 11:51:18 +0100 Subject: [PATCH 3/5] chore(docgen): Add compiler options for SQL package examples --- packages/sql/docgen.json | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/packages/sql/docgen.json b/packages/sql/docgen.json index e5bd31dc415..d49d9b789b0 100644 --- a/packages/sql/docgen.json +++ b/packages/sql/docgen.json @@ -3,5 +3,22 @@ "srcLink": "https://github.com/Effect-TS/effect/tree/main/packages/sql/src/", "exclude": [ "src/internal/**/*.ts" - ] + ], + "examplesCompilerOptions": { + "noEmit": true, + "strict": true, + "skipLibCheck": true, + "moduleResolution": "Bundler", + "module": "ES2022", + "target": "ES2022", + "lib": ["ES2022", "DOM"], + "paths": { + "effect": ["../../../effect/src/index.js"], + "effect/*": ["../../../effect/src/*.js"], + "@effect/sql": ["../../../sql/src/index.js"], + "@effect/sql/*": ["../../../sql/src/*.js"], + "@effect/experimental": ["../../../experimental/src/index.js"], + "@effect/experimental/*": ["../../../experimental/src/*.js"] + } + } } From 7fe346e8652d6c2a9d441debd53fe821feb6566a Mon Sep 17 00:00:00 2001 From: Giulio Canti Date: Mon, 10 Mar 2025 11:56:09 +0100 Subject: [PATCH 4/5] chore(docgen): Add paths for @effect/platform in SQL package --- packages/sql/docgen.json | 2 ++ 1 file changed, 2 insertions(+) diff --git a/packages/sql/docgen.json b/packages/sql/docgen.json index d49d9b789b0..130e931c213 100644 --- a/packages/sql/docgen.json +++ b/packages/sql/docgen.json @@ -15,6 +15,8 @@ "paths": { "effect": ["../../../effect/src/index.js"], "effect/*": ["../../../effect/src/*.js"], + "@effect/platform": ["../../../platform/src/index.js"], + "@effect/platform/*": ["../../../platform/src/*.js"], "@effect/sql": ["../../../sql/src/index.js"], "@effect/sql/*": ["../../../sql/src/*.js"], "@effect/experimental": ["../../../experimental/src/index.js"], From 778e16c1fc59707ce6c62f0970904ee6dc9b2bae Mon Sep 17 00:00:00 2001 From: Giulio Canti Date: Mon, 10 Mar 2025 12:04:18 +0100 Subject: [PATCH 5/5] chore(docgen): Add DOM.Iterable to TypeScript library options --- packages/sql/docgen.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/sql/docgen.json b/packages/sql/docgen.json index 130e931c213..1b529cbf9b3 100644 --- a/packages/sql/docgen.json +++ b/packages/sql/docgen.json @@ -11,7 +11,7 @@ "moduleResolution": "Bundler", "module": "ES2022", "target": "ES2022", - "lib": ["ES2022", "DOM"], + "lib": ["ES2022", "DOM", "DOM.Iterable"], "paths": { "effect": ["../../../effect/src/index.js"], "effect/*": ["../../../effect/src/*.js"],