add --no-examples option (#44)

Effect-TS · Nov 9, 2023 · b799243 · b799243
1 parent 9ff7548
commit b799243
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 3 deletions.
diff --git a/.changeset/polite-crabs-know.md b/.changeset/polite-crabs-know.md
@@ -0,0 +1,5 @@
+---
+"@effect/docgen": patch
+---
+
+add `--no-examples` option
diff --git a/docs/modules/Process.ts.md b/docs/modules/Process.ts.md
@@ -54,6 +54,7 @@ Represents a handle to the currently executing process.
 export interface Process {
   readonly cwd: Effect.Effect<never, never, string>
   readonly platform: Effect.Effect<never, never, string>
+  readonly argv: Effect.Effect<never, never, Array<string>>
 }
 ```
 

diff --git a/src/Core.ts b/src/Core.ts
@@ -410,13 +410,19 @@ const writeMarkdown = (files: ReadonlyArray<FileSystem.File>) =>
     return yield* _(writeFilesToOutDir(files))
   })
 
+const NO_EXAMPLES_OPTION = "--no-examples"
+
 const program = Effect.gen(function*(_) {
   yield* _(Effect.logInfo("Reading modules..."))
   const sourceFiles = yield* _(readSourceFiles)
   yield* _(Effect.logInfo("Parsing modules..."))
   const modules = yield* _(parseModules(sourceFiles))
-  yield* _(Effect.logInfo("Typechecking examples..."))
-  yield* _(typeCheckAndRunExamples(modules))
+  const process = yield* _(Process.Process)
+  const argv = yield* _(process.argv)
+  if (!argv.slice(2).some((arg) => arg === NO_EXAMPLES_OPTION)) {
+    yield* _(Effect.logInfo("Typechecking examples..."))
+    yield* _(typeCheckAndRunExamples(modules))
+  }
   yield* _(Effect.logInfo("Creating markdown files..."))
   const outputFiles = yield* _(getMarkdown(modules))
   yield* _(Effect.logInfo("Writing markdown files..."))

diff --git a/src/Process.ts b/src/Process.ts
@@ -13,6 +13,7 @@ import { Context, Effect, Layer } from "effect"
 export interface Process {
   readonly cwd: Effect.Effect<never, never, string>
   readonly platform: Effect.Effect<never, never, string>
+  readonly argv: Effect.Effect<never, never, Array<string>>
 }
 
 /**
@@ -29,6 +30,7 @@ export const ProcessLive = Layer.succeed(
   Process,
   Process.of({
     cwd: Effect.sync(() => process.cwd()),
-    platform: Effect.sync(() => process.platform)
+    platform: Effect.sync(() => process.platform),
+    argv: Effect.sync(() => process.argv)
   })
 )