mintlify 2.0.6 → 2.0.8

package/src/local-preview/index.ts

@@ -1,19 +1,22 @@
 import Chalk from "chalk";
 import open from "open";
-import { promises as _promises } from "fs";
 import fse, { pathExists } from "fs-extra";
 import inquirer from "inquirer";
 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,
 } from "../constants.js";
 import { buildLogger, ensureYarn } from "../util.js";
 import listener from "./listener/index.js";
+import { ArgumentsCamelCase } from "yargs";
 
 const shellExec = (cmd: string) => {
   return shell.exec(cmd, { silent: true });
@@ -45,96 +48,129 @@ const promptForYarn = async () => {
   }
 };
 
-const dev = async () => {
+const dev = async (argv: ArgumentsCamelCase) => {
   shell.cd(HOME_DIR);
   await promptForYarn();
   const logger = buildLogger("Starting a local Mintlify instance...");
   await fse.ensureDir(path.join(DOT_MINTLIFY, "mint"));
   const MINT_PATH = path.join(DOT_MINTLIFY, "mint");
   shell.cd(MINT_PATH);
-  const gitPullStatus = shellExec("git show").stdout;
-  const currBranch = shellExec("git rev-parse --abbrev-ref HEAD").stdout;
-  if (
-    gitPullStatus.startsWith(
-      "commit 78d764335877932a0dc305d615411dedd18bd18a"
-    ) ||
-    currBranch === "legacy-components-import"
-  ) {
-    await fse.emptyDir(MINT_PATH);
-  }
-
-  let runYarn = true;
-  const gitInstalled = shell.which("git");
-  let firstInstallation = false;
-  const gitRepoInitialized = await pathExists(
-    path.join(DOT_MINTLIFY, "mint", ".git")
-  );
-  if (!gitRepoInitialized) {
-    firstInstallation = true;
-    if (gitInstalled) {
-      logger.start("Initializing local Mintlify instance...");
-      shellExec("git init");
-      shellExec(
-        "git remote add -f mint-origin https://github.com/mintlify/mint.git"
-      );
-    } else {
-      logger.fail(
-        "git must be installed (https://github.com/git-guides/install-git)"
-      );
-      process.exit(1);
-    }
-  }
 
+  // The CLI can only run offline if Mint was already downloaded
   const internet = await isInternetAvailable();
-  let pullOutput = null;
-  if (internet && gitInstalled) {
-    shellExec("git config core.sparseCheckout true");
-    shellExec('echo "client/" >> .git/info/sparse-checkout');
-    pullOutput = shellExec("git pull mint-origin main").stdout;
-    shellExec("git config core.sparseCheckout false");
-    shellExec("rm .git/info/sparse-checkout");
-  }
-  if (pullOutput === "Already up to date.\n") {
-    runYarn = false;
+  if (!internet && !(await pathExists(CLIENT_PATH))) {
+    logger.fail(
+      "Running mintlify dev for the first time requires an internet connection."
+    );
+    process.exit(1);
   }
-  shell.cd(CLIENT_PATH);
-  if (internet && (runYarn || !(await nodeModulesExists()))) {
-    if (firstInstallation) {
-      logger.succeed("Local Mintlify instance initialized");
+
+  // Avoid checking if we are on the target Mint if we are offline
+  if (internet) {
+    const mintVersionExists = await pathExists(VERSION_PATH);
+
+    // We always download the target version of Mintlify if the mint-version.txt file doesn't exist.
+    // We do this because users updating from an older version of the CLI never have mint-version.txt set.
+    let downloadTargetMint = !mintVersionExists;
+
+    // Download target mint if the current version is different. Keep in mind this also allows
+    // downgrading to an older version of Mintlify by installing an older CLI version.
+    if (mintVersionExists) {
+      const currVersion = fse.readFileSync(VERSION_PATH, "utf8");
+      if (currVersion !== TARGET_MINT_VERSION) {
+        downloadTargetMint = true;
+      }
     }
-    logger.start("Updating dependencies...");
-    ensureYarn(logger);
-    shellExec("yarn");
-    if (firstInstallation) {
-      logger.succeed("Installation complete");
-    } else {
-      logger.succeed("Dependencies updated");
+
+    if (downloadTargetMint) {
+      // Delete any existing contents
+      fse.emptyDirSync(MINT_PATH);
+
+      logger.text = "Downloading Mintlify framework...";
+
+      const octokit = new Octokit();
+      const downloadRes = await octokit.repos.downloadTarballArchive({
+        owner: "mintlify",
+        repo: "mint",
+        ref: TARGET_MINT_VERSION,
+      });
+
+      logger.text = "Extracting Mintlify framework...";
+      const TAR_PATH = path.join(MINT_PATH, "mint.tar.gz");
+
+      // Unzip tar file
+      fse.writeFileSync(TAR_PATH, Buffer.from(downloadRes.data as any));
+      shellExec("tar -xzf mint.tar.gz");
+
+      // List all files in tar file and get the first one.
+      // There is never anything else in the tar file, so this is safe.
+      // We do this because the folder name includes the commit sha, so we can't hardcode it.
+      // Lastly, we call .trim() to remove the newline character.
+      const extractedFolderName = shellExec(
+        'tar -tzf mint.tar.gz | head -1 | cut -f1 -d"/"'
+      ).stdout.trim();
+
+      // Delete tar file
+      fse.removeSync(TAR_PATH);
+
+      fse.moveSync(
+        path.join(MINT_PATH, extractedFolderName, "client"),
+        path.join(CLIENT_PATH)
+      );
+
+      // Store the currently downloaded version
+      fse.writeFileSync(VERSION_PATH, TARGET_MINT_VERSION);
+
+      // Delete unnecessary contents downloaded from GitHub
+      fse.removeSync(path.join(MINT_PATH, extractedFolderName));
+
+      logger.text = "Installing dependencies...";
+
+      ensureYarn(logger);
+      shell.cd(CLIENT_PATH);
+      shellExec("yarn");
     }
   }
 
   if (!(await nodeModulesExists())) {
-    logger.fail(`Dependencies weren\'t installed, run
-    
-    mintlify install
-    
-    `);
+    if (!internet) {
+      logger.fail(`Dependencies are missing and you are offline. Connect to the internet and run
+  
+      mintlify install
+      
+      `);
+    } else {
+      logger.fail(`Dependencies were not installed correctly, run
+  
+      mintlify install
+      
+      `);
+    }
     process.exit(1);
   }
+
   const relativePath = path.relative(CLIENT_PATH, CMD_EXEC_PATH);
   shellExec(`yarn preconfigure ${relativePath}`);
-  logger.succeed("Local Mintlify instance initialized");
-  run();
+  logger.succeed("Local Mintlify instance started.");
+  run((argv.port as string) || "3000");
 };
 
-const run = () => {
+const run = (port: string) => {
   shell.cd(CLIENT_PATH);
   console.log(
     `🌿 ${Chalk.green(
-      "Navigate to your local preview at http://localhost:3000"
+      `Your local preview is available at http://localhost:${port}`
     )}`
   );
-  shell.exec("npm run dev-watch", { async: true });
-  open("http://localhost:3000");
+  console.log(
+    `🌿 ${Chalk.green("Press Ctrl+C any time to stop the local preview.")}`
+  );
+
+  // next-remote-watch can only receive ports as env variables
+  // https://github.com/hashicorp/next-remote-watch/issues/23
+  shell.exec(`PORT=${port} npm run dev-watch`, { async: true });
+
+  open(`http://localhost:${port}`);
   listener();
 };
 

package/src/scraping/scrapePageCommands.ts

@@ -6,6 +6,7 @@ import { scrapeReadMePage } from "./site-scrapers/scrapeReadMePage.js";
 import { detectFramework, Frameworks } from "./detectFramework.js";
 import { getHrefFromArgs } from "../util.js";
 import { getHtmlWithPuppeteer } from "../browser.js";
+import { ArgumentsCamelCase } from "yargs";
 
 function validateFramework(framework) {
   if (!framework) {
@@ -20,7 +21,7 @@ function validateFramework(framework) {
 }
 
 export async function scrapePageWrapper(
-  argv: any,
+  argv: ArgumentsCamelCase,
   scrapeFunc: ScrapePageFn,
   options?: { version?: string; puppeteer?: boolean }
 ) {

package/src/scraping/scrapeSectionCommands.ts

@@ -8,9 +8,10 @@ import { scrapeGitBookSection } from "./site-scrapers/scrapeGitBookSection.js";
 import openNestedGitbookMenus from "./site-scrapers/openNestedGitbookMenus.js";
 import { scrapeReadMeSection } from "./site-scrapers/scrapeReadMeSection.js";
 import { startBrowser } from "../browser.js";
+import { ArgumentsCamelCase } from "yargs";
 
 export async function scrapeSectionAxiosWrapper(
-  argv: any,
+  argv: ArgumentsCamelCase,
   scrapeFunc: ScrapeSectionFn
 ) {
   const href = getHrefFromArgs(argv);