starlight-fsharp-oracle 0.1.0

package/Directory.Build.props

@@ -0,0 +1,25 @@
+<Project>
+    <!-- Make F# support Central Package Management -->
+    <PropertyGroup>
+        <DisableImplicitSystemValueTupleReference>true</DisableImplicitSystemValueTupleReference>
+        <DisableImplicitFSharpCoreReference>true</DisableImplicitFSharpCoreReference>
+    </PropertyGroup>
+    <!-- Use lock files -->
+    <PropertyGroup Condition="'$(GITHUB_ACTIONS)' == 'true'">
+        <ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
+    </PropertyGroup>
+    <PropertyGroup>
+        <RestorePackagesWithLockFile>true</RestorePackagesWithLockFile>
+        <RestoreLockedMode Condition="'$(ContinuousIntegrationBuild)' == 'true'">true</RestoreLockedMode>
+    </PropertyGroup>
+    <PropertyGroup>
+        <GenerateDocumentationFile>true</GenerateDocumentationFile>
+        <Authors>Maxime Mangel</Authors>
+    </PropertyGroup>
+    <!-- Packages common to all the projects
+            Excepts Glutinum.Build which is isolated from the others -->
+    <ItemGroup Condition="'$(PackageId)'!='EasyBuild'">
+        <!-- Depends on the same version of FSharp.Core for all the projects -->
+        <PackageReference Include="FSharp.Core" />
+    </ItemGroup>
+</Project>

package/Directory.Packages.props

@@ -0,0 +1,18 @@
+<Project>
+  <PropertyGroup>
+    <ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>
+  </PropertyGroup>
+  <ItemGroup>
+  </ItemGroup>
+  <ItemGroup>
+    <PackageVersion Include="Fable.Core" Version="5.0.0" />
+    <PackageVersion Include="Fable.Node" Version="1.6.0" />
+    <PackageVersion Include="Fable.Promise" Version="3.2.0" />
+    <PackageVersion Include="FSharp.Compiler.Service" Version="43.12.203" />
+    <PackageVersion Include="FSharp.Core" Version="10.1.203" />
+    <PackageVersion Include="Thoth.Json.Core" Version="0.9.0" />
+    <PackageVersion Include="Thoth.Json.Core.Auto" Version="0.1.0" />
+    <PackageVersion Include="Thoth.Json.JavaScript" Version="0.5.0" />
+    <PackageVersion Include="Thoth.Json.System.Text.Json" Version="0.3.0" />
+  </ItemGroup>
+</Project>

package/README.md

@@ -0,0 +1,80 @@
+# FSharp.Oracle
+
+> **Reads the binaries. Sees the truth. Writes the docs.** 🔮
+
+FSharp.Oracle is a documentation generator for F# libraries. It inspects compiled assemblies using the F# Compiler Service (FCS) and generates rich API reference documentation as [Starlight](https://starlight.astro.build/) pages.
+
+## Architecture
+
+Two F# components bridged by a JSON intermediate representation:
+
+- **Oracle** — `packages/Oracle/`
+  - Uses FCS (F# Compiler Service) to inspect compiled assemblies
+  - Extracts types, functions, members, and XML documentation
+  - Emits a JSON IR
+
+- **Starlight.FSharp.Doc** — `packages/Starlight.FSharp.Oracle/`
+  - Starlight plugin written in F# and compiled via [Fable](https://fable.io/)
+  - Reads the JSON IR and generates `.mdx` pages
+  - Injects sidebar groups and CSS theme variables
+
+## Installation
+
+```bash
+npm install starlight-fsharp-doc
+```
+
+You will also need the .NET Oracle tool alongside your Starlight site:
+
+```bash
+git clone https://github.com/your-org/starlight-fsharp-doc.git
+cd packages/Oracle
+```
+
+## Usage
+
+TODO 🚨
+
+Add the plugin to your `astro.config.mjs`:
+
+```js
+import starlightFSharpDoc from 'starlight-fsharp-doc';
+import { resolve } from 'node:path';
+
+export default defineConfig({
+  integrations: [
+    starlight({
+      plugins: [
+        starlightFSharpDoc({
+          // Paths to compiled F# assemblies
+          assemblies: [
+            resolve(__dirname, '../src/MyLibrary/bin/Debug/net10.0/MyLibrary.dll'),
+          ],
+          // Output base path for generated pages
+          output: 'api',
+          // Sidebar configuration
+          sidebar: { label: 'API Reference' },
+          // Command to run Oracle (optional — defaults shown)
+          command: [
+            'dotnet',
+            'run',
+            '--project',
+            resolve(__dirname, '../packages/Oracle'),
+            '--',
+          ],
+        }),
+      ],
+    }),
+  ],
+});
+```
+
+The plugin runs during `dev`, `build`, and `sync`. It skips extraction on `preview`.
+
+## Development
+
+TODO 🚨
+
+## License
+
+MIT

package/dist/Extensions/StringBuilder.js

@@ -0,0 +1,28 @@
+
+import { StringBuilder__AppendLine, StringBuilder__AppendLine_Z721C83C5, StringBuilder__Append_Z721C83C5 } from "../fable_modules/fable-library-js.5.0.0-rc.7/System.Text.js";
+import { defaultArg } from "../fable_modules/fable-library-js.5.0.0-rc.7/Option.js";
+import { replicate } from "../fable_modules/fable-library-js.5.0.0-rc.7/String.js";
+
+export function System_Text_StringBuilder__StringBuilder_Write_Z721C83C5(this$, text) {
+    StringBuilder__Append_Z721C83C5(this$, text);
+}
+
+export function System_Text_StringBuilder__StringBuilder_WriteLine_Z721C83C5(this$, text) {
+    StringBuilder__AppendLine_Z721C83C5(this$, text);
+}
+
+export function System_Text_StringBuilder__StringBuilder_NewLine(this$) {
+    StringBuilder__AppendLine(this$);
+}
+
+export function System_Text_StringBuilder__StringBuilder_Indent_71136F3F(this$, factor) {
+    const factor_1 = defaultArg(factor, 1) | 0;
+    const value = System_Text_StringBuilder__StringBuilder_Space_71136F3F(this$, factor_1 * 4);
+}
+
+export function System_Text_StringBuilder__StringBuilder_Space_71136F3F(this$, factor) {
+    const factor_1 = defaultArg(factor, 1) | 0;
+    const text = replicate(factor_1, " ");
+    StringBuilder__Append_Z721C83C5(this$, text);
+}
+

package/dist/Extensions/TextNode.js

@@ -0,0 +1,115 @@
+
+import { concat, join, replace } from "../fable_modules/fable-library-js.5.0.0-rc.7/String.js";
+import { TextNode } from "../FSharp.Oracle.Schema/Schema.js";
+import { map } from "../fable_modules/fable-library-js.5.0.0-rc.7/List.js";
+import { singleton, collect, delay, toList } from "../fable_modules/fable-library-js.5.0.0-rc.7/Seq.js";
+import { rangeDouble } from "../fable_modules/fable-library-js.5.0.0-rc.7/Range.js";
+
+function escapeJsx(s) {
+    return replace(replace(s, "{", "{"), "}", "}");
+}
+
+export function wrapWithClass(cls, text) {
+    return `<span class="${cls}">${escapeJsx(text)}</span>`;
+}
+
+export function wrapInKeyword(text) {
+    return wrapWithClass("fsharp-doc-kw", text);
+}
+
+export function FSharp_Oracle_Schema_TextNode__TextNode_ToHtml_Static_5FC7EAAF(node) {
+    return FSharp_Oracle_Schema_TextNode__TextNode_get_Html(node);
+}
+
+export function FSharp_Oracle_Schema_TextNode__TextNode_ToHtml_Static_Z3A0E64B3(node) {
+    return FSharp_Oracle_Schema_TextNode__TextNode_ToHtml_Static_5FC7EAAF(new TextNode(19, [node]));
+}
+
+export function FSharp_Oracle_Schema_TextNode__TextNode_get_Html(this$) {
+    switch (this$.tag) {
+        case 12:
+            return wrapInKeyword(":");
+        case 7:
+            return wrapInKeyword("->");
+        case 13:
+            return wrapInKeyword(".");
+        case 11:
+            return wrapInKeyword(",");
+        case 9:
+            return "&nbsp;";
+        case 17:
+            return wrapInKeyword("&gt;");
+        case 16:
+            return wrapInKeyword("&lt;");
+        case 4:
+            return wrapInKeyword("{");
+        case 5:
+            return wrapInKeyword("}");
+        case 6:
+            return wrapInKeyword("=");
+        case 8:
+            return "&#x27;";
+        case 14:
+            return wrapInKeyword("(");
+        case 15:
+            return wrapInKeyword(")");
+        case 19: {
+            const node = this$.fields[0];
+            return join("", map(FSharp_Oracle_Schema_TextNode__TextNode_get_Html, node));
+        }
+        case 3: {
+            const text = this$.fields[0];
+            return wrapInKeyword(text);
+        }
+        case 18:
+            return wrapInKeyword("*");
+        case 1: {
+            const url = this$.fields[2];
+            const name = this$.fields[0];
+            return wrapWithClass("fsharp-doc-type", `<a href="${url}">${name}</a>`);
+        }
+        case 2: {
+            const name_1 = this$.fields[0];
+            return wrapWithClass("fsharp-doc-typevar", name_1);
+        }
+        case 20:
+            return "\n";
+        case 21: {
+            const tagName = this$.fields[0];
+            return concat("<", tagName, ...">");
+        }
+        case 23: {
+            const tagName_1 = this$.fields[0];
+            const cls = this$.fields[1];
+            return `<${tagName_1} class="${cls}">`;
+        }
+        case 22: {
+            const tagName_2 = this$.fields[0];
+            return concat("</", tagName_2, ...">");
+        }
+        case 24: {
+            const text_1 = this$.fields[0];
+            const href = this$.fields[1];
+            return `<a href="${href}">${text_1}</a>`;
+        }
+        case 25: {
+            const text_2 = this$.fields[0];
+            const href_1 = this$.fields[1];
+            return wrapWithClass("fsharp-doc-property", `<a href="${href_1}">${text_2}</a>`);
+        }
+        case 26: {
+            const text_3 = this$.fields[0];
+            const href_2 = this$.fields[1];
+            return wrapWithClass("fsharp-doc-kw", `<a href="${href_2}">${text_3}</a>`);
+        }
+        case 10: {
+            const count = this$.fields[0] | 0;
+            return FSharp_Oracle_Schema_TextNode__TextNode_ToHtml_Static_5FC7EAAF(new TextNode(19, [toList(delay(() => collect((matchValue) => singleton(new TextNode(9, [])), rangeDouble(1, 1, count))))]));
+        }
+        default: {
+            const s = this$.fields[0];
+            return escapeJsx(s);
+        }
+    }
+}
+