@docubook/docs-tree 1.0.0

package/README.md

@@ -0,0 +1,76 @@
+# @docubook/docs-tree
+
+Prebuild navigation tree for DocuBook documentation.
+
+## Installation
+
+### npm
+```bash
+npm install --save-dev @docubook/docs-tree
+```
+
+### pnpm
+```bash
+pnpm add -D @docubook/docs-tree
+```
+
+### yarn
+```bash
+yarn add -D @docubook/docs-tree
+```
+
+### bun
+```bash
+bun add -d @docubook/docs-tree
+```
+
+## Usage
+
+### npm
+```bash
+npx @docubook/docs-tree ./docs ./docu.json ./lib/docs-tree.json
+```
+
+### pnpm
+```bash
+pnpm dlx @docubook/docs-tree ./docs ./docu.json ./lib/docs-tree.json
+```
+
+### yarn
+```bash
+yarn dlx @docubook/docs-tree ./docs ./docu.json ./lib/docs-tree.json
+```
+
+### bun
+```bash
+bunx @docubook/docs-tree ./docs ./docu.json ./lib/docs-tree.json
+```
+
+Or run with default paths:
+```bash
+npx @docubook/docs-tree  # Uses ./docs, ./docu.json, ./docs-tree.json
+```
+
+## Implementation in DocuBook Projects
+
+Add to your `package.json` scripts:
+
+```json
+{
+  "scripts": {
+    "prebuild": "pnpx @docubook/docs-tree ./docs ./docu.json ./lib/docs-tree.json",
+    "build": "pnpm run prebuild && next build"
+  }
+}
+```
+
+Import in your routes file:
+
+```typescript
+// lib/route.ts
+import docsTree from "@/lib/docs-tree.json";
+
+export const ROUTES = docsTree;
+```
+
+The navigation tree will be prebuilt before each production build, with intelligent caching to skip regeneration when no changes are detected.

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli.js

@@ -0,0 +1,35 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_1 = require("./index");
+const path_1 = __importDefault(require("path"));
+const args = process.argv.slice(2);
+// Default values
+const defaultDocsDir = './docs';
+const defaultConfigPath = './docu.json';
+const defaultOutputPath = './docs-tree.json';
+let docsDir;
+let configPath;
+let outputPath;
+if (args.length === 0) {
+    // Use defaults
+    docsDir = defaultDocsDir;
+    configPath = defaultConfigPath;
+    outputPath = defaultOutputPath;
+}
+else if (args.length === 3) {
+    [docsDir, configPath, outputPath] = args;
+}
+else {
+    console.error('Usage: docs-tree [docs-dir] [config-path] [output-path]');
+    console.error('If no arguments provided, defaults will be used:');
+    console.error(`  docs-dir: ${defaultDocsDir}`);
+    console.error(`  config-path: ${defaultConfigPath}`);
+    console.error(`  output-path: ${defaultOutputPath}`);
+    process.exit(1);
+}
+const builder = new index_1.DocsTreeBuilder(path_1.default.resolve(docsDir), path_1.default.resolve(configPath), path_1.default.resolve(outputPath));
+builder.build().catch(console.error);

package/dist/index.d.ts

@@ -0,0 +1,21 @@
+export interface DocuConfig {
+    routes: any[];
+}
+export interface EachRoute {
+    title: string;
+    href: string;
+    noLink?: boolean;
+    context?: any;
+    items?: EachRoute[];
+}
+export declare class DocsTreeBuilder {
+    private docsDir;
+    private configPath;
+    private outputPath;
+    private cachePath;
+    constructor(docsDir: string, configPath: string, outputPath: string);
+    private getHash;
+    private scanDocs;
+    private buildRoutes;
+    build(): Promise<void>;
+}

package/dist/index.js

@@ -0,0 +1,86 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocsTreeBuilder = void 0;
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const path_1 = __importDefault(require("path"));
+const crypto_1 = __importDefault(require("crypto"));
+class DocsTreeBuilder {
+    constructor(docsDir, configPath, outputPath) {
+        this.docsDir = path_1.default.resolve(docsDir);
+        this.configPath = path_1.default.resolve(configPath);
+        this.outputPath = path_1.default.resolve(outputPath);
+        this.cachePath = path_1.default.join(path_1.default.dirname(this.outputPath), '.docs-tree-cache.json');
+    }
+    async getHash() {
+        const configContent = await fs_extra_1.default.readFile(this.configPath, 'utf-8');
+        const docsStats = await fs_extra_1.default.stat(this.docsDir);
+        const hash = crypto_1.default.createHash('md5');
+        hash.update(configContent);
+        hash.update(docsStats.mtime.toISOString());
+        return hash.digest('hex');
+    }
+    async scanDocs(dir) {
+        const items = await fs_extra_1.default.readdir(dir);
+        const files = [];
+        for (const item of items) {
+            const fullPath = path_1.default.join(dir, item);
+            const stat = await fs_extra_1.default.stat(fullPath);
+            if (stat.isFile() && (item.endsWith('.mdx') || item.endsWith('.md'))) {
+                files.push(item.replace(/\.(mdx|md)$/, ''));
+            }
+        }
+        return files;
+    }
+    async buildRoutes(routes, basePath = '') {
+        const result = [];
+        for (const route of routes) {
+            const fullHref = basePath + route.href;
+            const routeItem = {
+                title: route.title,
+                href: route.href, // keep relative
+                noLink: route.noLink,
+                context: route.context
+            };
+            if (route.items) {
+                routeItem.items = await this.buildRoutes(route.items, fullHref);
+            }
+            else {
+                // Jika tidak ada items, cek apakah ada folder atau file di docs
+                const docsSubDir = path_1.default.join(this.docsDir, fullHref.replace(/^\//, ''));
+                if (await fs_extra_1.default.pathExists(docsSubDir)) {
+                    const files = await this.scanDocs(docsSubDir);
+                    routeItem.items = files.map(file => ({
+                        title: file.replace(/-/g, ' ').replace(/\b\w/g, l => l.toUpperCase()),
+                        href: `/${file}`
+                    }));
+                }
+            }
+            result.push(routeItem);
+        }
+        return result;
+    }
+    async build() {
+        const currentHash = await this.getHash();
+        // Cek cache
+        if (await fs_extra_1.default.pathExists(this.cachePath)) {
+            const cache = await fs_extra_1.default.readJson(this.cachePath);
+            if (cache.hash === currentHash && await fs_extra_1.default.pathExists(this.outputPath)) {
+                console.log('Using cached docs-tree.json');
+                return;
+            }
+        }
+        // Baca config
+        const config = await fs_extra_1.default.readJson(this.configPath);
+        // Build routes
+        const navigationRoutes = await this.buildRoutes(config.routes);
+        // Write output
+        await fs_extra_1.default.writeJson(this.outputPath, navigationRoutes, { spaces: 2 });
+        // Update cache
+        await fs_extra_1.default.writeJson(this.cachePath, { hash: currentHash });
+        console.log('Generated docs-tree.json');
+    }
+}
+exports.DocsTreeBuilder = DocsTreeBuilder;

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@docubook/docs-tree",
+  "version": "1.0.0",
+  "description": "Prebuild navigation tree for DocuBook documentation",
+  "main": "dist/index.js",
+  "bin": {
+    "@docubook/docs-tree": "./dist/cli.js"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch"
+  },
+  "keywords": ["docubook", "navigation", "tree", "docs"],
+  "homepage": "https://docubook.pro/",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/DocuBook/docubook"
+  },
+  "author": "wildan.nrs",
+  "author-url": "https://wildan.dev",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/fs-extra": "^11.0.0",
+    "@types/node": "^20.0.0",
+    "typescript": "^5.0.0"
+  },
+  "dependencies": {
+    "fs-extra": "^11.0.0"
+  }
+}

package/src/cli.ts

@@ -0,0 +1,39 @@
+#!/usr/bin/env node
+
+import { DocsTreeBuilder } from './index';
+import path from 'path';
+
+const args = process.argv.slice(2);
+
+// Default values
+const defaultDocsDir = './docs';
+const defaultConfigPath = './docu.json';
+const defaultOutputPath = './docs-tree.json';
+
+let docsDir: string;
+let configPath: string;
+let outputPath: string;
+
+if (args.length === 0) {
+  // Use defaults
+  docsDir = defaultDocsDir;
+  configPath = defaultConfigPath;
+  outputPath = defaultOutputPath;
+} else if (args.length === 3) {
+  [docsDir, configPath, outputPath] = args;
+} else {
+  console.error('Usage: docs-tree [docs-dir] [config-path] [output-path]');
+  console.error('If no arguments provided, defaults will be used:');
+  console.error(`  docs-dir: ${defaultDocsDir}`);
+  console.error(`  config-path: ${defaultConfigPath}`);
+  console.error(`  output-path: ${defaultOutputPath}`);
+  process.exit(1);
+}
+
+const builder = new DocsTreeBuilder(
+  path.resolve(docsDir),
+  path.resolve(configPath),
+  path.resolve(outputPath)
+);
+
+builder.build().catch(console.error);

package/src/index.ts

@@ -0,0 +1,114 @@
+import fs from 'fs-extra';
+import path from 'path';
+import crypto from 'crypto';
+
+export interface DocuConfig {
+  routes: any[];
+  // tambahkan field lain jika perlu
+}
+
+export interface EachRoute {
+  title: string;
+  href: string;
+  noLink?: boolean;
+  context?: any;
+  items?: EachRoute[];
+}
+
+export class DocsTreeBuilder {
+  private docsDir: string;
+  private configPath: string;
+  private outputPath: string;
+  private cachePath: string;
+
+  constructor(docsDir: string, configPath: string, outputPath: string) {
+    this.docsDir = path.resolve(docsDir);
+    this.configPath = path.resolve(configPath);
+    this.outputPath = path.resolve(outputPath);
+    this.cachePath = path.join(path.dirname(this.outputPath), '.docs-tree-cache.json');
+  }
+
+  private async getHash(): Promise<string> {
+    const configContent = await fs.readFile(this.configPath, 'utf-8');
+    const docsStats = await fs.stat(this.docsDir);
+    const hash = crypto.createHash('md5');
+    hash.update(configContent);
+    hash.update(docsStats.mtime.toISOString());
+    return hash.digest('hex');
+  }
+
+  private async scanDocs(dir: string): Promise<string[]> {
+    const items = await fs.readdir(dir);
+    const files: string[] = [];
+
+    for (const item of items) {
+      const fullPath = path.join(dir, item);
+      const stat = await fs.stat(fullPath);
+
+      if (stat.isFile() && (item.endsWith('.mdx') || item.endsWith('.md'))) {
+        files.push(item.replace(/\.(mdx|md)$/, ''));
+      }
+    }
+
+    return files;
+  }
+
+  private async buildRoutes(routes: any[], basePath: string = ''): Promise<EachRoute[]> {
+    const result: EachRoute[] = [];
+
+    for (const route of routes) {
+      const fullHref = basePath + route.href;
+      const routeItem: EachRoute = {
+        title: route.title,
+        href: route.href, // keep relative
+        noLink: route.noLink,
+        context: route.context
+      };
+
+      if (route.items) {
+        routeItem.items = await this.buildRoutes(route.items, fullHref);
+      } else {
+        // Jika tidak ada items, cek apakah ada folder atau file di docs
+        const docsSubDir = path.join(this.docsDir, fullHref.replace(/^\//, ''));
+        if (await fs.pathExists(docsSubDir)) {
+          const files = await this.scanDocs(docsSubDir);
+          routeItem.items = files.map(file => ({
+            title: file.replace(/-/g, ' ').replace(/\b\w/g, l => l.toUpperCase()),
+            href: `/${file}`
+          }));
+        }
+      }
+
+      result.push(routeItem);
+    }
+
+    return result;
+  }
+
+  public async build(): Promise<void> {
+    const currentHash = await this.getHash();
+
+    // Cek cache
+    if (await fs.pathExists(this.cachePath)) {
+      const cache = await fs.readJson(this.cachePath);
+      if (cache.hash === currentHash && await fs.pathExists(this.outputPath)) {
+        console.log('Using cached docs-tree.json');
+        return;
+      }
+    }
+
+    // Baca config
+    const config: DocuConfig = await fs.readJson(this.configPath);
+
+    // Build routes
+    const navigationRoutes = await this.buildRoutes(config.routes);
+
+    // Write output
+    await fs.writeJson(this.outputPath, navigationRoutes, { spaces: 2 });
+
+    // Update cache
+    await fs.writeJson(this.cachePath, { hash: currentHash });
+
+    console.log('Generated docs-tree.json');
+  }
+}

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "commonjs",
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "declaration": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}