@ahmedrowaihi/8n 6.0.2 → 6.0.4

package/src/cli/adapter.ts

@@ -1,41 +0,0 @@
-import { renameSync, rmSync, existsSync, cpSync } from "node:fs";
-import { join } from "node:path";
-import type { NextAdapter } from "next";
-
-const adapter: NextAdapter = {
-  name: "8n",
-  modifyConfig(config, { phase }) {
-    if (phase !== "phase-production-build") return config;
-
-    const basePath = process.env.NEXT_BASE_PATH || "";
-    const staticExport = process.env.NEXT_STATIC_EXPORT === "true";
-
-    return {
-      ...config,
-      ...(staticExport ? { output: "export", trailingSlash: true } : {}),
-      ...(basePath ? { basePath, assetPrefix: basePath } : {}),
-    };
-  },
-
-  async onBuildComplete({ projectDir }) {
-    const docsProjectDir = process.env.DOCS_PROJECT_DIR;
-    const staticExport = process.env.NEXT_STATIC_EXPORT === "true";
-
-    if (!docsProjectDir || !staticExport) return;
-
-    const src = join(projectDir, "out");
-    const dest = join(docsProjectDir, "out");
-
-    if (existsSync(dest)) rmSync(dest, { recursive: true, force: true });
-
-    try {
-      renameSync(src, dest);
-    } catch (err: any) {
-      if (err.code !== "EXDEV") throw err;
-      cpSync(src, dest, { recursive: true });
-      rmSync(src, { recursive: true, force: true });
-    }
-  },
-};
-
-module.exports = adapter;

package/src/cli/commands/build.ts

@@ -1,13 +0,0 @@
-import pc from "picocolors";
-import { buildEnv, syncPublicDir, resolveProject, runNext } from "../web-app.js";
-
-export async function build() {
-  const { config, contentDir } = await resolveProject();
-
-  console.log(pc.cyan("8n") + pc.dim(` build → ${contentDir}`));
-
-  syncPublicDir(process.cwd());
-  await runNext("build", buildEnv({ config, contentDir, staticExport: true }));
-
-  console.log(pc.green("✓") + pc.dim(` build complete → out/`));
-}

package/src/cli/commands/dev.ts

@@ -1,13 +0,0 @@
-import pc from "picocolors";
-import { buildEnv, checkSelfUpdate, syncPublicDir, watchPublicDir, resolveProject, runNext } from "../web-app.js";
-
-export async function dev() {
-  const { config, contentDir } = await resolveProject();
-
-  console.log(pc.cyan("8n") + pc.dim(` dev → ${contentDir}`));
-
-  checkSelfUpdate();
-  syncPublicDir(process.cwd());
-  watchPublicDir(process.cwd());
-  await runNext("dev", buildEnv({ config, contentDir }));
-}

package/src/cli/commands/init.ts

@@ -1,141 +0,0 @@
-import { resolve, join, basename } from "node:path";
-import { existsSync, mkdirSync, writeFileSync, readFileSync, appendFileSync, readdirSync } from "node:fs";
-import { createInterface } from "node:readline/promises";
-import pc from "picocolors";
-
-const CONFIG_FILE = "8n.config.ts";
-
-const SCAFFOLD: Record<string, string> = {
-  [CONFIG_FILE]: `export default {
-  content: "./content",
-  locales: ["en"],
-  siteName: "Docs",
-
-  // Pin to a specific starter version (git tag or commit SHA).
-  // Remove this line to always track the latest release.
-  // version: "v1.0.0",
-
-  // Sections auto-show when content exists, auto-hide when empty.
-  // Set a section to false to hide it even if content is present.
-  // sections: { api: false },
-
-  // Add links to the top navigation bar.
-  // nav: { links: [{ text: "Blog", url: "https://example.com/blog" }] },
-};
-`,
-  ["content/docs/en/meta.json"]: JSON.stringify({ title: "Documentation", pages: ["index", "getting-started"] }, null, 2) + "\n",
-  ["content/docs/en/index.mdx"]: `---
-title: Introduction
-description: Welcome to the docs.
----
-
-Welcome to your documentation. Edit files in \`content/\` and run \`8n dev\` to start.
-`,
-  ["content/docs/en/getting-started/meta.json"]: JSON.stringify({ title: "Getting Started", pages: ["installation"] }, null, 2) + "\n",
-  ["content/docs/en/getting-started/installation.mdx"]: `---
-title: Installation
-description: How to install and set up the project.
----
-
-## Installation
-
-Add your installation steps here.
-`,
-  ["content/home/en/index.mdx"]: `---
-title: Home
----
-
-<div className="flex flex-col items-center justify-center text-center flex-1 gap-6 px-6 py-24">
-  <h1 className="text-4xl sm:text-5xl md:text-6xl font-bold leading-tight tracking-tight max-w-2xl">
-    Welcome to your docs.
-  </h1>
-  <div className="text-muted-foreground text-lg max-w-md leading-relaxed">
-    Edit \`content/home/en/index.mdx\` to customize this page.
-  </div>
-</div>
-`,
-  ["content/changelog/en/meta.json"]: JSON.stringify({ title: "Changelog" }, null, 2) + "\n",
-  ["content/changelog/en/v1.0.0.mdx"]: `---
-title: Version 1.0.0
-version: 1.0.0
-date: "${new Date().toISOString().slice(0, 10)}"
-summary: Initial release.
----
-
-## Initial Release
-
-First version of the docs.
-`,
-};
-
-const GITIGNORE_ENTRIES = ["out"];
-
-function isDirEmpty(dir: string): boolean {
-  if (!existsSync(dir)) return true;
-  return readdirSync(dir).filter((f) => !f.startsWith(".")).length === 0;
-}
-
-function scaffold(targetDir: string) {
-  let created = 0;
-
-  const files: Record<string, string> = {
-    ...SCAFFOLD,
-    "package.json": JSON.stringify(
-      { name: basename(targetDir), private: true, scripts: { dev: "8n dev", build: "8n build", start: "8n start" } },
-      null,
-      2,
-    ) + "\n",
-  };
-
-  for (const [rel, content] of Object.entries(files)) {
-    const abs = resolve(targetDir, rel);
-    if (existsSync(abs)) {
-      console.log(pc.dim(`  skip  ${rel}`));
-      continue;
-    }
-    mkdirSync(join(abs, ".."), { recursive: true });
-    writeFileSync(abs, content);
-    console.log(pc.green("  create") + pc.dim(` ${rel}`));
-    created++;
-  }
-
-  const gitignorePath = resolve(targetDir, ".gitignore");
-  const existing = existsSync(gitignorePath) ? readFileSync(gitignorePath, "utf-8") : "";
-  const missing = GITIGNORE_ENTRIES.filter((e) => !existing.split("\n").includes(e));
-  if (missing.length > 0) {
-    const prefix = existing.length > 0 && !existing.endsWith("\n") ? "\n" : "";
-    appendFileSync(gitignorePath, prefix + missing.join("\n") + "\n");
-    for (const e of missing) console.log(pc.green("  gitignore") + pc.dim(` ${e}`));
-    created += missing.length;
-  }
-
-  if (created > 0) {
-    console.log(pc.green("\n✓") + ` ready — run ${pc.cyan("pnpm dev")} to start`);
-  } else {
-    console.log(pc.dim("\n  already initialized"));
-  }
-}
-
-export async function init() {
-  const cwd = process.cwd();
-
-  console.log(pc.cyan("8n") + pc.dim(" init"));
-
-  if (isDirEmpty(cwd)) {
-    scaffold(cwd);
-    return;
-  }
-
-  const rl = createInterface({ input: process.stdin, output: process.stdout });
-  const name = (await rl.question(pc.dim("  directory name: "))).trim();
-  rl.close();
-
-  if (!name) {
-    console.log(pc.red("  aborted"));
-    return;
-  }
-
-  const targetDir = resolve(cwd, name);
-  mkdirSync(targetDir, { recursive: true });
-  scaffold(targetDir);
-}

package/src/cli/commands/mcp.ts

@@ -1,195 +0,0 @@
-import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
-import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
-import { z } from "zod";
-import { readdir, readFile } from "node:fs/promises";
-import { join, basename, extname, relative } from "node:path";
-import { existsSync } from "node:fs";
-import { getPackageRoot, resolveProject } from "../web-app.js";
-
-declare const __CLI_VERSION__: string;
-
-async function listMdFiles(dir: string): Promise<string[]> {
-  let entries;
-  try { entries = await readdir(dir, { withFileTypes: true }); } catch { return []; }
-  return entries
-    .filter((e) => !e.isDirectory() && (e.name.endsWith(".mdx") || e.name.endsWith(".md")))
-    .map((e) => e.name);
-}
-
-export async function mcp() {
-  const mcpDir = join(getPackageRoot(), "content", "mcp", "en");
-
-  const server = new McpServer({ name: "8n", version: __CLI_VERSION__ });
-
-  server.registerTool(
-    "read_me",
-    {
-      description: "Returns how to use the 8n MCP tools. Call this BEFORE documenting anything with 8n.",
-      inputSchema: {},
-    },
-    async () => ({
-      content: [{
-        type: "text" as const,
-        text: `# 8n MCP
-
-Use these tools to learn how to write documentation for an 8n project before creating any content.
-
-## Tools
-
-### list_components
-Lists all available reference topics (config, structure, frontmatter, components).
-Call this first to discover what topics are available.
-
-### get_component
-Reads a specific topic by name (without extension).
-Example: get_component({ name: "components" }) returns all available MDX components with usage examples.
-
-## Workflow
-1. Call list_components to see available topics
-2. Call get_component for the topics relevant to your task
-3. Use that knowledge to write correct MDX content for the user's project
-`,
-      }],
-    }),
-  );
-
-  server.registerTool(
-    "list_components",
-    {
-      description: "Lists all available 8n reference topics (config, structure, frontmatter, MDX components).",
-      inputSchema: {},
-    },
-    async () => {
-      if (!existsSync(mcpDir)) {
-        return { content: [{ type: "text" as const, text: "8n MCP knowledge not found. Reinstall @ahmedrowaihi/8n." }] };
-      }
-      const files = await listMdFiles(mcpDir);
-      const names = files.map((f) => basename(f, extname(f)));
-      return { content: [{ type: "text" as const, text: names.join("\n") }] };
-    },
-  );
-
-  server.registerTool(
-    "get_component",
-    {
-      description: "Reads a specific 8n reference topic by name. Use list_components first to discover available names.",
-      inputSchema: {
-        name: z.string().describe("Topic name without extension, e.g. components, config, structure, frontmatter"),
-      },
-    },
-    async ({ name }) => {
-      if (!existsSync(mcpDir)) {
-        return { content: [{ type: "text" as const, text: "8n MCP knowledge not found. Reinstall @ahmedrowaihi/8n." }] };
-      }
-      for (const ext of [".mdx", ".md"]) {
-        const file = join(mcpDir, `${name}${ext}`);
-        if (existsSync(file)) {
-          const text = await readFile(file, "utf-8");
-          return { content: [{ type: "text" as const, text }] };
-        }
-      }
-      return { content: [{ type: "text" as const, text: `Unknown topic: ${name}. Call list_components to see available topics.` }] };
-    },
-  );
-
-  server.registerTool(
-    "analyze",
-    {
-      description: "Runs static analysis on the user's content directory and reports issues that may break the documentation site.",
-      inputSchema: {},
-    },
-    async () => {
-      let contentDir = join(process.cwd(), "content");
-      let locales: string[] = ["en"];
-      try {
-        const project = await resolveProject();
-        contentDir = project.contentDir;
-        locales = project.config.locales ?? ["en"];
-      } catch { /* use defaults */ }
-
-      const issues: string[] = [];
-
-      async function walkAll(dir: string): Promise<string[]> {
-        const results: string[] = [];
-        let entries;
-        try { entries = await readdir(dir, { withFileTypes: true }); } catch { return results; }
-        for (const e of entries) {
-          const full = join(dir, e.name);
-          if (e.isDirectory()) results.push(...await walkAll(full));
-          else results.push(full);
-        }
-        return results;
-      }
-
-      const allFiles = await walkAll(contentDir);
-      const mdxFiles = allFiles.filter((f) => f.endsWith(".mdx") || f.endsWith(".md"));
-      const metaFiles = allFiles.filter((f) => f.endsWith("meta.json"));
-
-      for (const file of mdxFiles) {
-        const raw = await readFile(file, "utf-8").catch(() => "");
-        const rel = relative(contentDir, file);
-        if (!raw.match(/^---[\s\S]*?\ntitle:/m)) {
-          issues.push(`Missing title in frontmatter: ${rel}`);
-        }
-        if (rel.startsWith("changelog/")) {
-          if (!raw.match(/\nversion:/)) issues.push(`Changelog page missing version: ${rel}`);
-          if (!raw.match(/\ndate:/)) issues.push(`Changelog page missing date: ${rel}`);
-        }
-        const bodyMatch = raw.match(/^---[\s\S]*?---\s*([\s\S]*)$/m);
-        if (bodyMatch && bodyMatch[1].trim() === "") {
-          issues.push(`Empty page body: ${rel}`);
-        }
-      }
-
-      for (const file of metaFiles) {
-        const rel = relative(contentDir, file);
-        const raw = await readFile(file, "utf-8").catch(() => "");
-        let meta: { pages?: string[] };
-        try {
-          meta = JSON.parse(raw);
-        } catch {
-          issues.push(`Malformed JSON: ${rel}`);
-          continue;
-        }
-        if (meta.pages) {
-          const dir = join(file, "..");
-          for (const page of meta.pages) {
-            // Skip Fumadocs special syntax: ...folder (extract), --- (separator), [text](url) (link)
-            if (page.startsWith("...") || page === "---" || page.startsWith("[")) continue;
-            const isFolder = existsSync(join(dir, page)) && !existsSync(join(dir, `${page}.mdx`)) && !existsSync(join(dir, `${page}.md`));
-            if (isFolder) continue;
-            const exists = [".mdx", ".md"].some((ext) => existsSync(join(dir, `${page}${ext}`)));
-            if (!exists) issues.push(`meta.json references missing page "${page}": ${rel}`);
-          }
-        }
-      }
-
-      const defaultLocale = locales[0];
-      const otherLocales = locales.slice(1);
-      for (const locale of otherLocales) {
-        const defaultFiles = mdxFiles
-          .filter((f) => f.includes(`/${defaultLocale}/`))
-          .map((f) => relative(contentDir, f).replace(`${defaultLocale}/`, `${locale}/`));
-        for (const expected of defaultFiles) {
-          if (!existsSync(join(contentDir, expected))) {
-            issues.push(`Missing ${locale} translation: ${expected}`);
-          }
-        }
-      }
-
-      if (issues.length === 0) {
-        return { content: [{ type: "text" as const, text: "✓ No issues found." }] };
-      }
-
-      return {
-        content: [{
-          type: "text" as const,
-          text: `Found ${issues.length} issue${issues.length === 1 ? "" : "s"}:\n\n${issues.map((i) => `- ${i}`).join("\n")}`,
-        }],
-      };
-    },
-  );
-
-  const transport = new StdioServerTransport();
-  await server.connect(transport);
-}

package/src/cli/commands/start.ts

@@ -1,12 +0,0 @@
-import pc from "picocolors";
-import { buildEnv, syncPublicDir, resolveProject, runNext } from "../web-app.js";
-
-export async function start() {
-  const { config, contentDir } = await resolveProject();
-
-  console.log(pc.cyan("8n") + pc.dim(` start → ${contentDir}`));
-
-  syncPublicDir(process.cwd());
-  await runNext("build", buildEnv({ config, contentDir }));
-  await runNext("start", buildEnv({ config, contentDir }));
-}

package/src/cli/index.ts

@@ -1,26 +0,0 @@
-#!/usr/bin/env node
-import { Command, Option } from "commander";
-import { dev } from "./commands/dev.js";
-import { build } from "./commands/build.js";
-import { start } from "./commands/start.js";
-import { init } from "./commands/init.js";
-import { mcp } from "./commands/mcp.js";
-
-declare const __CLI_VERSION__: string;
-
-const program = new Command()
-  .name("8n")
-  .description("Run your 8n docs site")
-  .version(__CLI_VERSION__)
-  .addOption(new Option("--debug").hideHelp())
-  .hook("preAction", (cmd) => {
-    if (cmd.opts().debug) process.env.DEBUG_8N = "1";
-  });
-
-program.command("init").description("Scaffold a new docs project in the current directory").action(init);
-program.command("dev").description("Start the dev server").action(dev);
-program.command("build").description("Build for production").action(build);
-program.command("start").description("Start the production server").action(start);
-program.command("mcp").description("Start the MCP server for AI-assisted docs authoring").action(mcp);
-
-program.parse();

package/src/cli/load-config.ts

@@ -1,26 +0,0 @@
-import { loadConfig } from "c12";
-import { z } from "zod";
-
-export const configSchema = z.object({
-  content: z.string().default("./content"),
-  locales: z.array(z.string()).min(1).default(["en"]),
-  github: z.object({ repo: z.string() }).optional(),
-  siteName: z.string().optional(),
-  version: z.string().optional(),
-  sections: z.record(z.string(), z.boolean()).optional(),
-  nav: z.object({
-    links: z.array(z.object({ text: z.string(), url: z.string() })).default([]),
-  }).default({ links: [] }),
-  animations: z.boolean().default(true),
-  basePath: z.string().optional(),
-});
-
-export type DocsConfig = z.infer<typeof configSchema>;
-
-export async function resolveConfig(): Promise<DocsConfig> {
-  const { config } = await loadConfig<DocsConfig>({
-    name: "8n",
-    defaults: configSchema.parse({}),
-  });
-  return configSchema.parse(config);
-}

package/src/cli/web-app.ts

@@ -1,95 +0,0 @@
-import { join, dirname, resolve } from "node:path";
-import { fileURLToPath } from "node:url";
-import { existsSync, cpSync, watch } from "node:fs";
-import { x } from "tinyexec";
-import pc from "picocolors";
-import type { DocsConfig } from "./load-config.js";
-import { resolveConfig } from "./load-config.js";
-
-declare const __CLI_VERSION__: string;
-
-export function getPackageRoot(): string {
-  // dist/cli/index.mjs is 2 levels deep from package root
-  return join(dirname(fileURLToPath(import.meta.url)), "..", "..");
-}
-
-export async function checkSelfUpdate(): Promise<void> {
-  try {
-    const res = await fetch("https://registry.npmjs.org/@ahmedrowaihi/8n/latest", {
-      headers: { Accept: "application/json" },
-      signal: AbortSignal.timeout(3000),
-    });
-    if (!res.ok) return;
-    const { version: latest } = await res.json() as { version: string };
-    const current = __CLI_VERSION__;
-    if (latest !== current) {
-      console.log(
-        pc.yellow("⚠") + pc.dim(` new version available: `) +
-        pc.cyan(latest) + pc.dim(` (current: ${current}) — run `) +
-        pc.cyan("npm i -g @ahmedrowaihi/8n") + pc.dim(" to update"),
-      );
-    }
-  } catch {
-    // ignore — network may be unavailable
-  }
-}
-
-export function syncPublicDir(projectDir: string): void {
-  const src = join(projectDir, "public");
-  if (!existsSync(src)) return;
-  cpSync(src, join(getPackageRoot(), "public", "_assets"), { recursive: true, force: true });
-}
-
-export function watchPublicDir(projectDir: string): void {
-  const src = join(projectDir, "public");
-  if (!existsSync(src)) return;
-  watch(src, { recursive: true }, () => {
-    cpSync(src, join(getPackageRoot(), "public", "_assets"), { recursive: true, force: true });
-  });
-}
-
-export function getNextBin(): string {
-  return join(getPackageRoot(), "node_modules", ".bin", "next");
-}
-
-export async function resolveProject() {
-  const config = await resolveConfig();
-  const contentDir = resolve(process.cwd(), config.content ?? "./content");
-  return { config, contentDir };
-}
-
-export async function runNext(cmd: string, env: NodeJS.ProcessEnv): Promise<void> {
-  await x(getNextBin(), [cmd], {
-    nodeOptions: { cwd: getPackageRoot(), stdio: "inherit", env },
-  });
-}
-
-export interface BuildEnvOptions {
-  config: DocsConfig;
-  contentDir: string;
-  staticExport?: boolean;
-}
-
-const adapterPath = join(dirname(fileURLToPath(import.meta.url)), "adapter.cjs");
-
-export function buildEnv({ config, contentDir, staticExport = false }: BuildEnvOptions): NodeJS.ProcessEnv {
-  const ghRepo = process.env.GITHUB_REPOSITORY;
-  const ghServer = process.env.GITHUB_SERVER_URL ?? "https://github.com";
-  const ghPagesUrl = ghRepo ? `${ghServer}/${ghRepo}` : undefined;
-  const ghPagesBasePath = ghRepo ? `/${ghRepo.split("/")[1]}` : undefined;
-
-  return {
-    ...process.env,
-    CONTENT_DIR: contentDir,
-    LOCALES: (config.locales ?? ["en"]).join(","),
-    NEXT_PUBLIC_SITE_NAME: config.siteName ?? "Docs",
-    NEXT_PUBLIC_GITHUB_REPO: config.github?.repo ?? ghPagesUrl,
-    SECTIONS: JSON.stringify(config.sections ?? {}),
-    NEXT_PUBLIC_NAV_LINKS: JSON.stringify(config.nav?.links ?? []),
-    NEXT_PUBLIC_ANIMATIONS: config.animations === false ? "false" : "true",
-    NEXT_BASE_PATH: config.basePath ?? ghPagesBasePath ?? "",
-    NEXT_STATIC_EXPORT: staticExport ? "true" : "false",
-    NEXT_ADAPTER_PATH: adapterPath,
-    DOCS_PROJECT_DIR: process.cwd(),
-  };
-}