bug: A hand patch for three content errors.

Author: PaulJPhilp

README.md

@@ -267,7 +267,7 @@ How to test Effect code effectively, reliably, and deterministically.
 
 | Pattern | Skill Level | Summary |
 | :--- | :--- | :--- |
-| [Safely Bracket Resource Usage with `acquireRelease`](./content/published/acquire-release-bracket.mdx) | 🟢 **Beginner** | Use `Effect.acquireRelease` to guarantee a resource's cleanup logic runs, even if errors or interruptions occur. |
+| [Safely Bracket Resource Usage with `acquireRelease`](./content/published/safely-bracket-resource-usage.mdx) | 🟢 **Beginner** | Use `Effect.acquireRelease` to guarantee a resource's cleanup logic runs, even if errors or interruptions occur. |
 
 ---
 
@@ -284,15 +284,15 @@ How to test Effect code effectively, reliably, and deterministically.
 
 | Pattern | Skill Level | Summary |
 | :--- | :--- | :--- |
-| [Safely Bracket Resource Usage with `acquireRelease`](./content/published/acquire-release-bracket.mdx) | 🟢 **Beginner** | Use `Effect.acquireRelease` to guarantee a resource's cleanup logic runs, even if errors or interruptions occur. |
+| [Safely Bracket Resource Usage with `acquireRelease`](./content/published/safely-bracket-resource-usage.mdx) | 🟢 **Beginner** | Use `Effect.acquireRelease` to guarantee a resource's cleanup logic runs, even if errors or interruptions occur. |
 
 ---
 
 ## Network Requests
 
 | Pattern | Skill Level | Summary |
 | :--- | :--- | :--- |
-| [Safely Bracket Resource Usage with `acquireRelease`](./content/published/acquire-release-bracket.mdx) | 🟢 **Beginner** | Use `Effect.acquireRelease` to guarantee a resource's cleanup logic runs, even if errors or interruptions occur. |
+| [Safely Bracket Resource Usage with `acquireRelease`](./content/published/safely-bracket-resource-usage.mdx) | 🟢 **Beginner** | Use `Effect.acquireRelease` to guarantee a resource's cleanup logic runs, even if errors or interruptions occur. |
 
 ---
 
@@ -309,7 +309,7 @@ How to test Effect code effectively, reliably, and deterministically.
 
 | Pattern | Skill Level | Summary |
 | :--- | :--- | :--- |
-| [Safely Bracket Resource Usage with `acquireRelease`](./content/published/acquire-release-bracket.mdx) | 🟢 **Beginner** | Use `Effect.acquireRelease` to guarantee a resource's cleanup logic runs, even if errors or interruptions occur. |
+| [Safely Bracket Resource Usage with `acquireRelease`](./content/published/safely-bracket-resource-usage.mdx) | 🟢 **Beginner** | Use `Effect.acquireRelease` to guarantee a resource's cleanup logic runs, even if errors or interruptions occur. |
 | [Compose Resource Lifecycles with `Layer.merge`](./content/published/compose-scoped-layers.mdx) | 🟡 **Intermediate** | Combine multiple resource-managing layers, letting Effect automatically handle the acquisition and release order. |
 | [Create a Service Layer from a Managed Resource](./content/published/scoped-service-layer.mdx) | 🟡 **Intermediate** | Use `Layer.scoped` with `Effect.Service` to transform a managed resource into a shareable, application-wide service. |
 | [Create a Managed Runtime for Scoped Resources](./content/published/create-managed-runtime-for-scoped-resources.mdx) | 🟠 **Advanced** | Use Layer.launch to safely manage the lifecycle of layers containing scoped resources, ensuring finalizers are always run. |

content/published/scoped-service-layer.mdx

@@ -15,7 +15,7 @@ author: "PaulJPhilp"
 
 ## Guideline
 
-Define a service using `class MyService extends Effect.Service(...)`. On this class, create a static `Live` property using `Layer.scoped`. This layer should be constructed with the service class itself and a scoped `Effect` (typically from `Effect.acquireRelease`) that builds and releases the underlying resource.
+Define a service using `class MyService extends Effect.Service(...)`.   Implement the service using the `scoped` property of the service class. This property should be a scoped `Effect` (typically from `Effect.acquireRelease`) that builds and releases the underlying resource.
 
 ## Rationale
 
@@ -34,7 +34,7 @@ interface DbOps {
 class Database extends Effect.Service<DbOps>()(
   "Database",
   {
-    effect: Effect.gen(function* () {
+    scoped: Effect.gen(function* () {
       const id = Math.floor(Math.random() * 1000);
       yield* Console.log(`[Pool ${id}] Acquired`);
       return {

content/published/stream-from-file.mdx

@@ -44,23 +44,35 @@ This example demonstrates reading a text file, splitting it into individual line
 ```typescript
 import { FileSystem } from '@effect/platform';
 import { NodeFileSystem } from '@effect/platform-node';
-import { Effect } from 'effect';
+import type { PlatformError } from '@effect/platform/Error';
+import { Effect, Stream } from 'effect';
 import * as path from 'node:path';
 
-const processFile = (filePath: string, content: string): Effect.Effect<void, Error, FileSystem.FileSystem> =>
+const processFile = (
+  filePath: string,
+  content: string
+): Effect.Effect<void, PlatformError, FileSystem.FileSystem> =>
   Effect.gen(function* () {
     const fs = yield* FileSystem.FileSystem;
-    try {
-      yield* fs.writeFileString(filePath, content);
-      const fileContent = yield* fs.readFileString(filePath);
-      const lines = fileContent.split('\n');
-
-      for (const line of lines) {
-        yield* Effect.log(`Processing: ${line}`);
-      }
-    } finally {
-      yield* fs.remove(filePath);
-    }
+
+    // Write content to file
+    yield* fs.writeFileString(filePath, content);
+
+    // Create a stream from file content
+    const fileStream = Stream.fromEffect(fs.readFileString(filePath))
+      .pipe(
+        // Split content into lines
+        Stream.map((content: string) => content.split('\n')),
+        Stream.flatMap(Stream.fromIterable),
+        // Process each line
+        Stream.tap((line) => Effect.log(`Processing: ${line}`))
+      );
+
+    // Run the stream to completion
+    yield* Stream.runDrain(fileStream);
+
+    // Clean up file
+    yield* fs.remove(filePath);
   });
 
 const program = Effect.gen(function* () {
@@ -69,15 +81,17 @@ const program = Effect.gen(function* () {
   yield* processFile(
     filePath,
     'line 1\nline 2\nline 3'
+  ).pipe(
+    Effect.catchAll((error: PlatformError) =>
+      Effect.logError(`Error processing file: ${error.message}`)
+    )
   );
-}).pipe(
-  Effect.catchAll((error) =>
-    Effect.logError(`Error processing file: ${String(error)}`)
-  )
-);
+});
 
 Effect.runPromise(
-  program.pipe(Effect.provide(NodeFileSystem.layer)) as Effect.Effect<undefined, never, never>
+  program.pipe(
+    Effect.provide(NodeFileSystem.layer)
+  )
 ).catch(console.error);
 /*
 Output:

content/raw/scoped-service-layer.mdx

@@ -15,7 +15,7 @@ author: "PaulJPhilp"
 
 ## Guideline
 
-Define a service using `class MyService extends Effect.Service(...)`. On this class, create a static `Live` property using `Layer.scoped`. This layer should be constructed with the service class itself and a scoped `Effect` (typically from `Effect.acquireRelease`) that builds and releases the underlying resource.
+Define a service using `class MyService extends Effect.Service(...)`.   Implement the service using the `scoped` property of the service class. This property should be a scoped `Effect` (typically from `Effect.acquireRelease`) that builds and releases the underlying resource.
 
 ## Rationale
 

content/src/scoped-service-layer.ts

@@ -8,7 +8,7 @@ interface DbOps {
 class Database extends Effect.Service<DbOps>()(
   "Database",
   {
-    effect: Effect.gen(function* () {
+    scoped: Effect.gen(function* () {
       const id = Math.floor(Math.random() * 1000);
       yield* Console.log(`[Pool ${id}] Acquired`);
       return {

content/src/stream-from-file.ts

@@ -1,22 +1,34 @@
 import { FileSystem } from '@effect/platform';
 import { NodeFileSystem } from '@effect/platform-node';
-import { Effect } from 'effect';
+import type { PlatformError } from '@effect/platform/Error';
+import { Effect, Stream } from 'effect';
 import * as path from 'node:path';
 
-const processFile = (filePath: string, content: string): Effect.Effect<void, Error, FileSystem.FileSystem> =>
+const processFile = (
+  filePath: string,
+  content: string
+): Effect.Effect<void, PlatformError, FileSystem.FileSystem> =>
   Effect.gen(function* () {
     const fs = yield* FileSystem.FileSystem;
-    try {
-      yield* fs.writeFileString(filePath, content);
-      const fileContent = yield* fs.readFileString(filePath);
-      const lines = fileContent.split('\n');
-
-      for (const line of lines) {
-        yield* Effect.log(`Processing: ${line}`);
-      }
-    } finally {
-      yield* fs.remove(filePath);
-    }
+
+    // Write content to file
+    yield* fs.writeFileString(filePath, content);
+
+    // Create a stream from file content
+    const fileStream = Stream.fromEffect(fs.readFileString(filePath))
+      .pipe(
+        // Split content into lines
+        Stream.map((content: string) => content.split('\n')),
+        Stream.flatMap(Stream.fromIterable),
+        // Process each line
+        Stream.tap((line) => Effect.log(`Processing: ${line}`))
+      );
+
+    // Run the stream to completion
+    yield* Stream.runDrain(fileStream);
+
+    // Clean up file
+    yield* fs.remove(filePath);
   });
 
 const program = Effect.gen(function* () {
@@ -25,15 +37,17 @@ const program = Effect.gen(function* () {
   yield* processFile(
     filePath,
     'line 1\nline 2\nline 3'
+  ).pipe(
+    Effect.catchAll((error: PlatformError) =>
+      Effect.logError(`Error processing file: ${error.message}`)
+    )
   );
-}).pipe(
-  Effect.catchAll((error) =>
-    Effect.logError(`Error processing file: ${String(error)}`)
-  )
-);
+});
 
 Effect.runPromise(
-  program.pipe(Effect.provide(NodeFileSystem.layer)) as Effect.Effect<undefined, never, never>
+  program.pipe(
+    Effect.provide(NodeFileSystem.layer)
+  )
 ).catch(console.error);
 /*
 Output:

scripts/README.md

@@ -0,0 +1,136 @@
+# Effect Patterns Publishing Pipeline
+
+This directory contains the scripts that power the Effect Patterns publishing pipeline. These scripts help maintain consistency between TypeScript source files and their corresponding MDX documentation.
+
+## Pipeline Overview
+
+The publishing pipeline consists of a 3-stage workflow:
+
+1. **New Patterns** (`content/new/`): Empty subdirectories for new patterns that haven't been published yet
+2. **Raw Patterns** (`content/raw/`): MDX files with TypeScript code replaced by `<Example />` components
+3. **Published Patterns** (`content/published/`): Final MDX files with embedded TypeScript code blocks
+
+## Available Scripts
+
+### 1. `process_patterns.ts`
+
+Processes MDX files by extracting TypeScript code blocks and replacing them with Example components.
+
+```bash
+npx tsx process_patterns.ts --indir <input_directory> --outdir <output_directory> [--srcdir <source_directory>] [--count <number>]
+```
+
+**Arguments:**
+- `--indir`: Input directory containing MDX files (required)
+- `--outdir`: Output directory for processed MDX files (required)
+- `--srcdir`: Directory to write extracted TypeScript code (optional)
+- `--count`: Number of files to process (optional)
+
+**Example:**
+```bash
+npx tsx process_patterns.ts --indir content/published --outdir content/raw --srcdir content/src
+```
+
+### 2. `publish-patterns.ts`
+
+Processes MDX files by replacing Example components with TypeScript code from source files.
+
+```bash
+npx tsx publish-patterns.ts --indir <input_directory> --outdir <output_directory> --srcdir <source_directory> [--count <number>]
+```
+
+**Arguments:**
+- `--indir`: Input directory containing MDX files with Example components (required)
+- `--outdir`: Output directory for processed MDX files (required)
+- `--srcdir`: Directory containing TypeScript source files (required)
+- `--count`: Number of files to process (optional)
+
+**Example:**
+```bash
+npx tsx publish-patterns.ts --indir content/raw --outdir content/published --srcdir content/src
+```
+
+### 3. `pattern-validator.ts`
+
+Validates that TypeScript code blocks in MDX files match their corresponding source files.
+
+```bash
+npx tsx pattern-validator.ts --indir <input_directory> --srcdir <source_directory> [--count <number>]
+```
+
+**Arguments:**
+- `--indir`: Input directory containing MDX files (required)
+- `--srcdir`: Directory containing TypeScript source files (required)
+- `--count`: Number of files to process (optional)
+
+**Example:**
+```bash
+npx tsx pattern-validator.ts --indir content/published --srcdir content/src
+```
+
+### 4. `generate_readme.ts`
+
+Generates the main README.md file with links to all patterns, organized by category.
+
+```bash
+npx tsx generate_readme.ts
+```
+
+**Note:** This script looks for MDX files in the `content/published` directory.
+
+### 5. `validate_and_generate.ts`
+
+Combines validation and README generation in one step.
+
+```bash
+npx tsx validate_and_generate.ts
+```
+
+This script:
+1. Validates all TypeScript code blocks against source files
+2. Generates the README.md with links to all patterns
+3. Ensures complete consistency between code, documentation, and README
+
+## Typical Workflow
+
+1. **Create new patterns** in `content/new/`
+2. **Process patterns** to extract TypeScript code:
+   ```bash
+   npx tsx process_patterns.ts --indir content/published --outdir content/raw --srcdir content/src
+   ```
+3. **Make changes** to TypeScript source files in `content/src/`
+4. **Publish patterns** to restore TypeScript code blocks:
+   ```bash
+   npx tsx publish-patterns.ts --indir content/raw --outdir content/published --srcdir content/src
+   ```
+5. **Validate patterns** to ensure consistency:
+   ```bash
+   npx tsx pattern-validator.ts --indir content/published --srcdir content/src
+   ```
+6. **Generate README** with links to all patterns:
+   ```bash
+   npx tsx generate_readme.ts
+   ```
+
+Or use the combined validation and generation script:
+```bash
+npx tsx validate_and_generate.ts
+```
+
+## Future Automation
+
+Future enhancements to this pipeline could include:
+
+1. GitHub Actions workflow to automatically validate patterns on pull requests
+2. Automated tests for the pipeline scripts
+3. Integration with a CI/CD system for automated deployment
+4. Pre-commit hooks to ensure consistency before committing changes
+
+## Dependencies
+
+- TypeScript
+- Node.js
+- commander (for CLI argument parsing)
+- gray-matter (for parsing MDX frontmatter)
+- fs/promises (for file system operations)
+- path (for path manipulation)