Add source link generation for documentation modules

- Implement source link generation for functions, classes, and other printable entities
- Update Printer module to dynamically generate GitHub source links
- Modify Domain and Parser modules to support source position tracking
- Refactor printing functions to use Effect for source link generation
- Update test cases to validate new source link functionality

Author: gcanti

docs/modules/Checker.ts.md

@@ -34,6 +34,8 @@ Since v0.6.0
 declare const checkClasses: (_classes: ReadonlyArray<Domain.Class>) => Effect.Effect<Array<never>, never, never>
 ```
 
+[Source](https://github.com/effect-ts/docgen/blob/main/src/Checker.ts#L32)
+
 Since v0.6.0
 
 ## checkConstants
@@ -44,6 +46,8 @@ Since v0.6.0
 declare const checkConstants: (_constants: ReadonlyArray<Domain.Constant>) => Effect.Effect<Array<never>, never, never>
 ```
 
+[Source](https://github.com/effect-ts/docgen/blob/main/src/Checker.ts#L39)
+
 Since v0.6.0
 
 ## checkExports
@@ -54,6 +58,8 @@ Since v0.6.0
 declare const checkExports: (_exports: ReadonlyArray<Domain.Export>) => Effect.Effect<Array<never>, never, never>
 ```
 
+[Source](https://github.com/effect-ts/docgen/blob/main/src/Checker.ts#L67)
+
 Since v0.6.0
 
 ## checkFunctions
@@ -66,6 +72,8 @@ declare const checkFunctions: (
 ) => Effect.Effect<Array<string>, never, Parser.Source>
 ```
 
+[Source](https://github.com/effect-ts/docgen/blob/main/src/Checker.ts#L25)
+
 Since v0.6.0
 
 ## checkInterfaces
@@ -78,6 +86,8 @@ declare const checkInterfaces: (
 ) => Effect.Effect<Array<never>, never, never>
 ```
 
+[Source](https://github.com/effect-ts/docgen/blob/main/src/Checker.ts#L46)
+
 Since v0.6.0
 
 ## checkModule
@@ -88,6 +98,8 @@ Since v0.6.0
 declare const checkModule: (_module: Domain.Module) => Effect.Effect<Array<never>, never, never>
 ```
 
+[Source](https://github.com/effect-ts/docgen/blob/main/src/Checker.ts#L74)
+
 Since v0.6.0
 
 ## checkNamespaces
@@ -100,6 +112,8 @@ declare const checkNamespaces: (
 ) => Effect.Effect<Array<never>, never, never>
 ```
 
+[Source](https://github.com/effect-ts/docgen/blob/main/src/Checker.ts#L60)
+
 Since v0.6.0
 
 ## checkTypeAliases
@@ -112,4 +126,6 @@ declare const checkTypeAliases: (
 ) => Effect.Effect<Array<never>, never, never>
 ```
 
+[Source](https://github.com/effect-ts/docgen/blob/main/src/Checker.ts#L53)
+
 Since v0.6.0

docs/modules/Domain.ts.md

@@ -29,13 +29,12 @@ Since v0.6.0
     - [\_tag (property)](#_tag-property-4)
   - [Method (class)](#method-class)
   - [Module (class)](#module-class)
-    - [\_tag (property)](#_tag-property-5)
   - [Namespace (class)](#namespace-class)
-    - [\_tag (property)](#_tag-property-6)
+    - [\_tag (property)](#_tag-property-5)
   - [Position (interface)](#position-interface)
   - [Property (class)](#property-class)
   - [TypeAlias (class)](#typealias-class)
-    - [\_tag (property)](#_tag-property-7)
+    - [\_tag (property)](#_tag-property-6)
 - [service](#service)
   - [Process (class)](#process-class)
 - [sorting](#sorting)
@@ -256,6 +255,7 @@ Since v0.6.0
 
 ```ts
 declare class Module { constructor(
+    readonly source: Parser.SourceShape,
     readonly name: string,
     readonly doc: Doc,
     readonly path: Array.NonEmptyReadonlyArray<string>,
@@ -271,16 +271,6 @@ declare class Module { constructor(
 
 Since v0.6.0
 
-### \_tag (property)
-
-**Signature**
-
-```ts
-readonly _tag: "Module"
-```
-
-Since v0.6.0
-
 ## Namespace (class)
 
 **Signature**

docs/modules/Parser.ts.md

@@ -71,6 +71,8 @@ declare const parseFiles: (
 >
 ```
 
+[Source](https://github.com/effect-ts/docgen/blob/main/src/Parser.ts#L667)
+
 Since v0.6.0
 
 ## parseFunctions

docs/modules/Printer.ts.md

@@ -39,18 +39,13 @@ export const a: string = "a"
 **Example** (Title 1)
 
 ```ts twoslash title="Title 1"
-import { Domain, Printer } from "@effect/docgen"
-import { Option } from "effect"
-
-const doc = new Domain.Doc(undefined, ["1.0.0"], [], [], [], [], [], {})
-const m = new Domain.Module("tests", doc, ["src", "tests.ts"], [], [], [], [], [], [], [])
-console.log(Printer.printModule(m))
+export const b: string = "b"
 ```
 
 **Example** (Title 2)
 
 ```js twoslash title="Title 2"
-export const a: string = "b"
+export const c: string = "c"
 ```
 
 **Throws**
@@ -66,9 +61,11 @@ export const a: string = "b"
 **Signature**
 
 ```ts
-declare const printModule: (module: Domain.Module) => string
+declare const printModule: (module: Domain.Module) => Effect.Effect<string, never, Configuration.Configuration>
 ```
 
+[Source](https://github.com/effect-ts/docgen/blob/main/src/Printer.ts#L323)
+
 Since v0.6.0
 
 # utils
@@ -81,6 +78,8 @@ Since v0.6.0
 declare const prettify: (s: string) => Effect.Effect<string, never, never>
 ```
 
+[Source](https://github.com/effect-ts/docgen/blob/main/src/Printer.ts#L375)
+
 Since v0.6.0
 
 ## printFrontMatter
@@ -91,4 +90,6 @@ Since v0.6.0
 declare const printFrontMatter: (module: Domain.Module, nav_order: number) => string
 ```
 
+[Source](https://github.com/effect-ts/docgen/blob/main/src/Printer.ts#L364)
+
 Since v0.6.0

src/Core.ts

@@ -522,7 +522,7 @@ const getModuleMarkdownFiles = (modules: ReadonlyArray<Domain.Module>) =>
   Effect.forEach(modules, (module, i) =>
     Effect.gen(function*() {
       const outputPath = yield* getModuleMarkdownOutputPath(module)
-      const moduleContent = Printer.printModule(module)
+      const moduleContent = yield* Printer.printModule(module)
       const tocgen = yield* Effect.promise(async () => {
         // @ts-expect-error
         return await import("@effect/markdown-toc").then((m) => m.default)

src/Domain.ts

@@ -7,7 +7,7 @@ import * as Data from "effect/Data"
 import * as Effect from "effect/Effect"
 import * as Order from "effect/Order"
 import * as String from "effect/String"
-
+import type * as Parser from "./Parser.js"
 /**
  * @category model
  * @since 0.6.0
@@ -43,11 +43,8 @@ export class Doc {
  * @since 0.6.0
  */
 export class Module {
-  /**
-   * @since 0.6.0
-   */
-  readonly _tag = "Module" // TODO: remove this
   constructor(
+    readonly source: Parser.SourceShape,
     readonly name: string,
     readonly doc: Doc,
     readonly path: Array.NonEmptyReadonlyArray<string>,

src/Parser.ts

@@ -601,6 +601,7 @@ export const parseModule = Effect.gen(function*() {
   const namespaces = yield* parseNamespaces
   const name = source.sourceFile.getBaseName()
   return new Domain.Module(
+    source,
     name,
     doc,
     source.path,
@@ -622,8 +623,8 @@ export const parseFile =
   (file: Domain.File): Effect.Effect<Domain.Module, Array<string>, Configuration.Configuration | Path.Path> => {
     return Effect.gen(function*() {
       const path = yield* Path.Path
-      const filePath = file.path.split(path.sep)
       const sourceFile = project.getSourceFile(file.path)
+      const filePath = file.path.split(path.sep)
       if (sourceFile !== undefined && Array.isNonEmptyArray(filePath)) {
         return yield* Effect.provideService(parseModule, Source, { sourceFile, path: filePath })
       }