@aravindc26/velu 0.11.13 → 0.11.15

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aravindc26/velu",
-  "version": "0.11.13",
+  "version": "0.11.15",
   "description": "A modern documentation site generator powered by Markdown and JSON configuration",
   "type": "module",
   "license": "MIT",

package/src/build.ts

@@ -9,11 +9,12 @@ import { normalizeConfigNavigation } from "./navigation-normalize.js";
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
 const PACKAGED_ENGINE_DIR = join(__dirname, "engine");
-const DEV_ENGINE_DIR = join(__dirname, "..", "src", "engine");
-const ENGINE_DIR = existsSync(DEV_ENGINE_DIR) ? DEV_ENGINE_DIR : PACKAGED_ENGINE_DIR;
-const PRIMARY_CONFIG_NAME = "docs.json";
-const LEGACY_CONFIG_NAME = "velu.json";
-const SOURCE_MIRROR_DIR = "velu-imports";
+const DEV_ENGINE_DIR = join(__dirname, "..", "src", "engine");
+const ENGINE_DIR = existsSync(DEV_ENGINE_DIR) ? DEV_ENGINE_DIR : PACKAGED_ENGINE_DIR;
+const CLI_PACKAGE_JSON_PATH = join(__dirname, "..", "package.json");
+const PRIMARY_CONFIG_NAME = "docs.json";
+const LEGACY_CONFIG_NAME = "velu.json";
+const SOURCE_MIRROR_DIR = "velu-imports";
 
 const SOURCE_MIRROR_EXTENSIONS = new Set([
   ".md", ".mdx", ".jsx", ".js", ".tsx", ".ts",
@@ -137,6 +138,9 @@ interface VeluRedirect {
 
 interface VeluConfig {
   $schema?: string;
+  name?: string;
+  title?: string;
+  description?: string;
   theme?: string;
   variables?: Record<string, string>;
   colors?: VeluColors;
@@ -587,7 +591,7 @@ const STATIC_EXTENSIONS = new Set([
   ".zip",
 ]);
 
-function copyStaticAssets(docsDir: string, publicDir: string) {
+function copyStaticAssets(docsDir: string, publicDir: string) {
   function walk(dir: string) {
     const entries = readdirSync(dir, { withFileTypes: true });
     for (const entry of entries) {
@@ -611,12 +615,49 @@ function copyStaticAssets(docsDir: string, publicDir: string) {
     }
   }
 
-  walk(docsDir);
-}
-
-function toPosixPath(value: string): string {
-  return value.replace(/\\/g, "/");
-}
+  walk(docsDir);
+}
+
+function resolveProjectName(config: VeluConfig): string {
+  const fromName = typeof config.name === "string" ? config.name.trim() : "";
+  if (fromName) return fromName;
+  const fromTitle = typeof config.title === "string" ? config.title.trim() : "";
+  if (fromTitle) return fromTitle;
+  return "Documentation";
+}
+
+function resolveProjectDescription(config: VeluConfig): string {
+  if (typeof config.description === "string") return config.description.trim();
+  return "";
+}
+
+function resolveCliVersion(): string {
+  try {
+    const raw = readFileSync(CLI_PACKAGE_JSON_PATH, "utf-8");
+    const parsed = JSON.parse(raw) as { version?: unknown };
+    if (typeof parsed.version === "string" && parsed.version.trim().length > 0) {
+      return parsed.version.trim();
+    }
+  } catch {
+    // ignore and fallback
+  }
+  return "unknown";
+}
+
+function writeProjectConstFile(config: VeluConfig, outDir: string) {
+  const constPayload = {
+    name: resolveProjectName(config),
+    description: resolveProjectDescription(config),
+    version: resolveCliVersion(),
+  };
+
+  const constPath = join(outDir, "public", "const.json");
+  writeFileSync(constPath, `${JSON.stringify(constPayload, null, 2)}\n`, "utf-8");
+}
+
+function toPosixPath(value: string): string {
+  return value.replace(/\\/g, "/");
+}
 
 function isInsideDocsRoot(docsDir: string, targetPath: string): boolean {
   const relPath = relative(docsDir, targetPath);
@@ -1167,12 +1208,14 @@ function build(docsDir: string, outDir: string) {
   console.log(`📋 Copied ${configName} as ${PRIMARY_CONFIG_NAME} (and legacy ${LEGACY_CONFIG_NAME})`);
 
   // ── 3b. Copy static assets from docs project into public/ ─────────────────
-  copyStaticAssets(docsDir, join(outDir, "public"));
-  writeRedirectArtifacts(config, outDir);
-  if ((config.redirects ?? []).length > 0) {
-    console.log("↪️  Generated redirect artifacts");
-  }
-  console.log("🖼️  Copied static assets");
+  copyStaticAssets(docsDir, join(outDir, "public"));
+  writeRedirectArtifacts(config, outDir);
+  writeProjectConstFile(rawConfig, outDir);
+  if ((config.redirects ?? []).length > 0) {
+    console.log("↪️  Generated redirect artifacts");
+  }
+  console.log("🧾 Generated const.json");
+  console.log("🖼️  Copied static assets");
 
   // ── 4. Build content + metadata artifacts ────────────────────────────────
   const contentDir = join(outDir, "content", "docs");

package/src/cli.ts

@@ -35,6 +35,7 @@ function printHelp() {
   velu — documentation site generator
 
   Usage:
+    velu version           Print Velu CLI version
     velu init              Scaffold a new docs project with example files
     velu lint              Validate docs.json (or velu.json) and check referenced pages
     velu run [--port N]    Build site and start dev server (default: 4321)
@@ -42,6 +43,7 @@ function printHelp() {
     velu paths             Output navigation paths and source files as JSON (grouped by language)
 
   Options:
+    --version         Show Velu CLI version
     --port <number>   Port for the dev server (default: 4321)
     --help            Show this help message
 
@@ -49,6 +51,24 @@ function printHelp() {
 `);
 }
 
+function getCliVersion(): string {
+  try {
+    const pkgPath = join(PACKAGE_ROOT, "package.json");
+    const raw = readFileSync(pkgPath, "utf-8");
+    const parsed = JSON.parse(raw) as { version?: unknown };
+    if (typeof parsed.version === "string" && parsed.version.trim().length > 0) {
+      return parsed.version.trim();
+    }
+  } catch {
+    // ignore and fallback
+  }
+  return "unknown";
+}
+
+function printVersion() {
+  console.log(getCliVersion());
+}
+
 // ── init ────────────────────────────────────────────────────────────────────────
 
 function init(targetDir: string) {
@@ -495,6 +515,11 @@ if (!command || command === "--help" || command === "-h") {
   process.exit(0);
 }
 
+if (command === "version" || command === "--version" || command === "-v") {
+  printVersion();
+  process.exit(0);
+}
+
 const docsDir = process.cwd();
 
 // init doesn't require docs.json