@docsalot/previewing 0.1.0-beta.1 → 0.1.0-beta.3

package/README.md

@@ -1,17 +1,13 @@
-# @mintlify/previewing
+# @docsalot/previewing
 
-Preview Mintlify docs locally.
+Preview DocsALot docs locally.
 
-## 🚀 Installation
+## Installation
 
-```
-npm install @mintlify/previewing
+```bash
+npm install @docsalot/previewing
 ```
 
 ## Community
 
-Join our Discord community if you have questions or just want to chat:
-
-[![](https://dcbadge.vercel.app/api/server/ACREKdwjG5)](https://discord.gg/ACREKdwjG5)
-
-_Built with 💚 by the Mintlify community._
+Discord: https://discord.gg/Dp6EpTv4BU

package/dist/constants.d.ts

@@ -1,7 +1,7 @@
-export declare const TARGET_MINT_VERSION = "v0.0.9";
+export declare const TARGET_CLIENT_VERSION = "v0.0.9";
 export declare const INSTALL_PATH: string;
 export declare const HOME_DIR: string;
-export declare const DOT_MINTLIFY: string;
+export declare const DOT_DOCSALOT: string;
 export declare const VERSION_PATH: string;
 export declare const CLIENT_PATH: string;
 export declare const MINT_PATH: string;

package/dist/constants.js

@@ -3,19 +3,17 @@
 import path from "path";
 import * as url from "url";
 import os from "os";
-// Change this to bump to a newer version of mint's client
-export const TARGET_MINT_VERSION = "v0.0.9";
+// Change this to bump to a newer version of the bundled client.
+export const TARGET_CLIENT_VERSION = "v0.0.9";
 // package installation location
 export const INSTALL_PATH = url.fileURLToPath(new URL(".", import.meta.url));
 export const HOME_DIR = os.homedir();
-// DOT_MINTLIFY can be overridden via environment variable
-// Priority: DOCSALOT_PATH env var > hardcoded local path
-// Docker: Set DOCSALOT_PATH=/app/mint-main
-const HARDCODED_PATH = '/Users/faizank/workspace/experiments/live_projects/slashml/mint-main';
-export const DOT_MINTLIFY = process.env.DOCSALOT_PATH || HARDCODED_PATH;
-export const VERSION_PATH = path.join(DOT_MINTLIFY, "mint", "mint-version.txt");
-export const CLIENT_PATH = path.join(DOT_MINTLIFY, "client");
-export const MINT_PATH = path.join(DOT_MINTLIFY, "mint");
+// DOCSALOT_PATH can be overridden via environment variable.
+// Priority: DOCSALOT_PATH env var > ~/.docsalot
+export const DOT_DOCSALOT = process.env.DOCSALOT_PATH || path.join(HOME_DIR, ".docsalot");
+export const VERSION_PATH = path.join(DOT_DOCSALOT, "mint", "client-version.txt");
+export const CLIENT_PATH = path.join(DOT_DOCSALOT, "client");
+export const MINT_PATH = path.join(DOT_DOCSALOT, "mint");
 // command execution location
 export const CMD_EXEC_PATH = process.cwd();
 export const SUPPORTED_MEDIA_EXTENSIONS = [

package/dist/local-preview/helper-commands/installDepsCommand.js

@@ -1,11 +1,56 @@
 import shell from "shelljs";
-import { CLIENT_PATH } from "../../constants.js";
+import fse, { pathExists } from "fs-extra";
+import path from "path";
+import { Octokit } from "@octokit/rest";
+import { isInternetAvailable } from "is-internet-available";
+import { CLIENT_PATH, MINT_PATH, TARGET_CLIENT_VERSION, VERSION_PATH, } from "../../constants.js";
 import { buildLogger, ensureYarn } from "../../util.js";
+const downloadTargetClient = async (logger) => {
+    fse.emptyDirSync(MINT_PATH);
+    logger.text = "Downloading DocsALot framework...";
+    const octokit = new Octokit();
+    const downloadRes = await octokit.repos.downloadTarballArchive({
+        owner: "slashml",
+        repo: "docsalot",
+        ref: TARGET_CLIENT_VERSION,
+    });
+    logger.text = "Extracting DocsALot framework...";
+    const tarPath = path.join(MINT_PATH, "mint.tar.gz");
+    const tmpPath = path.join(MINT_PATH, "mint-tmp");
+    fse.writeFileSync(tarPath, Buffer.from(downloadRes.data));
+    fse.mkdirSync(tmpPath, { recursive: true });
+    const untarResult = shell.exec(`tar -xzf "${tarPath}" -C "${tmpPath}" --strip-components 1`, {
+        silent: true,
+    });
+    if (untarResult.code !== 0) {
+        logger.fail("Failed to extract DocsALot framework.");
+        process.exit(1);
+    }
+    fse.removeSync(tarPath);
+    fse.moveSync(path.join(tmpPath, "client"), CLIENT_PATH);
+    fse.writeFileSync(VERSION_PATH, TARGET_CLIENT_VERSION);
+    fse.removeSync(tmpPath);
+};
 const installDeps = async () => {
-    const logger = buildLogger("");
+    const logger = buildLogger("Preparing local DocsALot client...");
     ensureYarn(logger);
+    await fse.ensureDir(MINT_PATH);
+    const clientExists = await pathExists(CLIENT_PATH);
+    if (!clientExists) {
+        const internet = await isInternetAvailable();
+        if (!internet) {
+            logger.fail("First-time setup requires internet to download the local DocsALot framework.");
+            process.exit(1);
+        }
+        await downloadTargetClient(logger);
+    }
+    logger.text = "Installing local DocsALot dependencies...";
     shell.cd(CLIENT_PATH);
-    shell.exec("yarn");
+    const installResult = shell.exec("yarn");
+    if (installResult.code !== 0) {
+        logger.fail("Failed to install dependencies.");
+        process.exit(1);
+    }
     logger.succeed("Dependencies installed.");
 };
 export default installDeps;

package/dist/local-preview/index.js

@@ -8,13 +8,12 @@ import { isInternetAvailable } from "is-internet-available";
 import path from "path";
 import shell from "shelljs";
 import { Octokit } from "@octokit/rest";
-import { CLIENT_PATH, HOME_DIR, DOT_MINTLIFY, CMD_EXEC_PATH, TARGET_MINT_VERSION, VERSION_PATH, MINT_PATH, } from "../constants.js";
+import { CLIENT_PATH, HOME_DIR, DOT_DOCSALOT, CMD_EXEC_PATH, TARGET_CLIENT_VERSION, VERSION_PATH, MINT_PATH, } from "../constants.js";
 import { buildLogger, ensureYarn } from "../util.js";
 import listener from "./listener/index.js";
 import { getConfigPath } from "./listener/utils/mintConfigFile.js";
 const nodeModulesExists = async () => {
-    // return pathExists(path.join(DOT_MINTLIFY, "mint", "client", "node_modules"));
-    return pathExists(path.join(DOT_MINTLIFY, "client", "node_modules"));
+    return pathExists(path.join(DOT_DOCSALOT, "client", "node_modules"));
 };
 const promptForYarn = async () => {
     const yarnInstalled = shell.which("yarn");
@@ -38,16 +37,16 @@ const promptForYarn = async () => {
         });
     }
 };
-const downloadTargetMint = async (logger) => {
+const downloadTargetClient = async (logger) => {
     fse.emptyDirSync(MINT_PATH);
-    logger.text = "Downloading Mintlify framework...";
+    logger.text = "Downloading DocsALot framework...";
     const octokit = new Octokit();
     const downloadRes = await octokit.repos.downloadTarballArchive({
-        owner: "mintlify",
-        repo: "mint",
-        ref: TARGET_MINT_VERSION,
+        owner: "slashml",
+        repo: "docsalot",
+        ref: TARGET_CLIENT_VERSION,
     });
-    logger.text = "Extracting Mintlify framework...";
+    logger.text = "Extracting DocsALot framework...";
     const TAR_PATH = path.join(MINT_PATH, "mint.tar.gz");
     fse.writeFileSync(TAR_PATH, Buffer.from(downloadRes.data));
     // strip-components 1 removes the top level directory from the unzipped content
@@ -58,7 +57,7 @@ const downloadTargetMint = async (logger) => {
     });
     fse.removeSync(TAR_PATH);
     fse.moveSync(path.join(MINT_PATH, "mint-tmp", "client"), path.join(CLIENT_PATH));
-    fse.writeFileSync(VERSION_PATH, TARGET_MINT_VERSION);
+    fse.writeFileSync(VERSION_PATH, TARGET_CLIENT_VERSION);
     // Delete unnecessary content downloaded from GitHub
     fse.removeSync(path.join(MINT_PATH, "mint-tmp"));
     logger.text = "Installing dependencies...";
@@ -66,10 +65,10 @@ const downloadTargetMint = async (logger) => {
     shell.cd(CLIENT_PATH);
     shell.exec("yarn", { silent: true });
 };
-const checkForMintJson = async (logger) => {
+const checkForLayoutJson = async (logger) => {
     const configPath = await getConfigPath(CMD_EXEC_PATH);
     if (configPath == null) {
-        logger.fail("Must be ran in a directory where a mint.json file exists.");
+        logger.fail("Must be ran in a directory where a layout.json file exists.");
         process.exit(1);
     }
     return;
@@ -83,40 +82,40 @@ const dev = async (argv) => {
     shell.cd(MINT_PATH);
     const internet = await isInternetAvailable();
     if (!internet && !(await pathExists(CLIENT_PATH))) {
-        logger.fail("Running mintlify dev for the first time requires an internet connection.");
+        logger.fail("Running docsalot dev for the first time requires an internet connection.");
         process.exit(1);
     }
     // if (internet) {
     //   const mintVersionExists = await pathExists(VERSION_PATH);
-    //   let needToDownloadTargetMint = !mintVersionExists;
+    //   let needToDownloadTargetClient = !mintVersionExists;
     //   if (mintVersionExists) {
     //     const currVersion = fse.readFileSync(VERSION_PATH, "utf8");
-    //     if (currVersion !== TARGET_MINT_VERSION) {
-    //       needToDownloadTargetMint = true;
+    //     if (currVersion !== TARGET_CLIENT_VERSION) {
+    //       needToDownloadTargetClient = true;
     //     }
     //   }
-    //   if (needToDownloadTargetMint) {
-    //     await downloadTargetMint(logger);
+    //   if (needToDownloadTargetClient) {
+    //     await downloadTargetClient(logger);
     //   }
     // }
     if (!(await nodeModulesExists())) {
         if (!internet) {
             logger.fail(`Dependencies are missing and you are offline. Connect to the internet and run
   
-      mintlify install
+      docsalot install
       
       `);
         }
         else {
             logger.fail(`Dependencies were not installed correctly, run
   
-      mintlify install
+      docsalot install
       
       `);
         }
         process.exit(1);
     }
-    await checkForMintJson(logger);
+    await checkForLayoutJson(logger);
     shell.cd(CLIENT_PATH);
     const relativePath = path.relative(CLIENT_PATH, CMD_EXEC_PATH);
     child_process.spawnSync("yarn preconfigure", [relativePath], { shell: true });
@@ -130,7 +129,7 @@ const run = (port) => {
     // For local development, use dev-watch (binds to localhost, with file watching)
     const isProduction = process.env.BIND_ALL_INTERFACES === "true";
     const devScript = isProduction ? "npm run dev-host" : "npm run dev-watch";
-    const mintlifyDevProcess = child_process.spawn(devScript, {
+    const docsalotDevProcess = child_process.spawn(devScript, {
         env: {
             ...process.env,
             PORT: port,
@@ -139,7 +138,7 @@ const run = (port) => {
         stdio: "pipe",
         shell: true,
     });
-    mintlifyDevProcess.stdout.on("data", (data) => {
+    docsalotDevProcess.stdout.on("data", (data) => {
         const output = data.toString();
         console.log(output);
         if (output.startsWith("> Ready on http://localhost:")) {
@@ -149,7 +148,7 @@ const run = (port) => {
         }
     });
     const onExit = () => {
-        mintlifyDevProcess.kill("SIGINT");
+        docsalotDevProcess.kill("SIGINT");
         process.exit(0);
     };
     process.on("SIGINT", onExit);

package/dist/local-preview/listener/categorize.js

@@ -34,7 +34,9 @@ export const categorizeFiles = async (contentDirectoryPath) => {
                     });
                 }
             }
-            else if (!filename.endsWith("mint.json") && !isOpenApi) {
+            else if (!filename.endsWith("layout.json") &&
+                !filename.endsWith("docs.json") &&
+                !isOpenApi) {
                 // all other files
                 staticFilenames.push(filename);
             }
@@ -64,7 +66,7 @@ const supportedStaticFileExtensions = [
 export const getCategory = (filePath) => {
     filePath = filePath.toLowerCase();
     const parsed = path.parse(filePath);
-    if (parsed.base === "mint.json" || parsed.base === "layout.json") {
+    if (parsed.base === "layout.json") {
         return "mintConfig";
     }
     const fileName = parsed.name;

package/dist/local-preview/listener/index.js

@@ -86,7 +86,7 @@ const listener = () => {
                     console.log(`Snippet deleted: ${filename}`);
                     break;
                 case "mintConfig":
-                    console.log("⚠️ mint.json deleted. Please create a new mint.json file as it is mandatory.");
+                    console.log("⚠️ layout.json deleted. Please create a new layout.json file as it is mandatory.");
                     process.exit(1);
                 case "potentialJsonOpenApiSpec":
                 case "potentialYamlOpenApiSpec":
@@ -147,9 +147,9 @@ const onUpdateEvent = async (filename) => {
             break;
         case "mintConfig":
             regenerateNav = true;
-            const mintJsonFileContent = (await readFile(filePath)).toString();
+            const layoutJsonFileContent = (await readFile(filePath)).toString();
             try {
-                const mintConfig = JSON.parse(mintJsonFileContent);
+                const mintConfig = JSON.parse(layoutJsonFileContent);
                 const { status, errors, warnings } = mintValidation.validateMintConfig(mintConfig);
                 errors.forEach((error) => {
                     console.error(`🚨 ${Chalk.red(error)}`);
@@ -163,7 +163,7 @@ const onUpdateEvent = async (filename) => {
             }
             catch (error) {
                 if (error.name === "SyntaxError") {
-                    console.error(`🚨 ${Chalk.red("mint.json has invalid JSON. You are likely missing a comma or a bracket. You can paste your mint.json file into https://jsonlint.com/ to get a more specific error message.")}`);
+                    console.error(`🚨 ${Chalk.red("layout.json has invalid JSON. You are likely missing a comma or a bracket. You can paste your layout.json file into https://jsonlint.com/ to get a more specific error message.")}`);
                 }
                 else {
                     console.error(`🚨 ${Chalk.red(error.message)}`);

package/dist/local-preview/listener/utils/mintConfigFile.js

@@ -4,10 +4,6 @@ import pathUtil from "path";
 const { readFile } = _promises;
 // TODO: Put in prebuild package
 export const getConfigPath = async (contentDirectoryPath) => {
-    // Prefer modern config filename, but keep backward compatibility.
-    if (await pathExists(pathUtil.join(contentDirectoryPath, "mint.json"))) {
-        return pathUtil.join(contentDirectoryPath, "mint.json");
-    }
     if (await pathExists(pathUtil.join(contentDirectoryPath, "layout.json"))) {
         return pathUtil.join(contentDirectoryPath, "layout.json");
     }

package/dist/local-preview/prod.js

@@ -7,11 +7,11 @@ import inquirer from "inquirer";
 import { isInternetAvailable } from "is-internet-available";
 import path from "path";
 import shell from "shelljs";
-import { CLIENT_PATH, HOME_DIR, DOT_MINTLIFY, CMD_EXEC_PATH, MINT_PATH, } from "../constants.js";
+import { CLIENT_PATH, HOME_DIR, DOT_DOCSALOT, CMD_EXEC_PATH, MINT_PATH, } from "../constants.js";
 import { buildLogger } from "../util.js";
 import { getConfigPath } from "./listener/utils/mintConfigFile.js";
 const nodeModulesExists = async () => {
-    return pathExists(path.join(DOT_MINTLIFY, "client", "node_modules"));
+    return pathExists(path.join(DOT_DOCSALOT, "client", "node_modules"));
 };
 const promptForYarn = async () => {
     const yarnInstalled = shell.which("yarn");
@@ -35,10 +35,10 @@ const promptForYarn = async () => {
         });
     }
 };
-const checkForMintJson = async (logger) => {
+const checkForLayoutJson = async (logger) => {
     const configPath = await getConfigPath(CMD_EXEC_PATH);
     if (configPath == null) {
-        logger.fail("Must be ran in a directory where a mint.json file exists.");
+        logger.fail("Must be ran in a directory where a layout.json file exists.");
         process.exit(1);
     }
     return;
@@ -46,32 +46,32 @@ const checkForMintJson = async (logger) => {
 const prod = async (argv) => {
     shell.cd(HOME_DIR);
     await promptForYarn();
-    const logger = buildLogger("Preparing production Mintlify instance...");
+    const logger = buildLogger("Preparing production DocsALot instance...");
     await fse.ensureDir(MINT_PATH);
     shell.cd(MINT_PATH);
     const internet = await isInternetAvailable();
     if (!internet && !(await pathExists(CLIENT_PATH))) {
-        logger.fail("Running mintlify prod for the first time requires an internet connection.");
+        logger.fail("Running docsalot prod for the first time requires an internet connection.");
         process.exit(1);
     }
     if (!(await nodeModulesExists())) {
         if (!internet) {
             logger.fail(`Dependencies are missing and you are offline. Connect to the internet and run
 
-      mintlify install
+      docsalot install
 
       `);
         }
         else {
             logger.fail(`Dependencies were not installed correctly, run
 
-      mintlify install
+      docsalot install
 
       `);
         }
         process.exit(1);
     }
-    await checkForMintJson(logger);
+    await checkForLayoutJson(logger);
     shell.cd(CLIENT_PATH);
     const relativePath = path.relative(CLIENT_PATH, CMD_EXEC_PATH);
     child_process.spawnSync("yarn preconfigure", [relativePath], { shell: true });
@@ -95,7 +95,7 @@ const run = (port) => {
     console.log(`✅ ${Chalk.green("Build complete! Starting production server...")}`);
     console.log("");
     // Start the production server (no file watching)
-    const mintlifyProdProcess = child_process.spawn("npm run start", {
+    const docsalotProdProcess = child_process.spawn("npm run start", {
         env: {
             ...process.env,
             PORT: port,
@@ -106,7 +106,7 @@ const run = (port) => {
         shell: true,
     });
     let serverStarted = false;
-    mintlifyProdProcess.stdout.on("data", (data) => {
+    docsalotProdProcess.stdout.on("data", (data) => {
         const output = data.toString();
         console.log(output);
         // Next.js production server outputs "ready" or "started server"
@@ -117,11 +117,11 @@ const run = (port) => {
             open(`http://localhost:${port}`);
         }
     });
-    mintlifyProdProcess.stderr.on("data", (data) => {
+    docsalotProdProcess.stderr.on("data", (data) => {
         console.error(data.toString());
     });
     const onExit = () => {
-        mintlifyProdProcess.kill("SIGINT");
+        docsalotProdProcess.kill("SIGINT");
         process.exit(0);
     };
     process.on("SIGINT", onExit);