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

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

@@ -65,10 +65,10 @@ const downloadTargetClient = async (logger) => {
     shell.cd(CLIENT_PATH);
     shell.exec("yarn", { silent: true });
 };
-const checkForDocsJson = 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 docs.json file exists.");
+        logger.fail("Must be ran in a directory where a layout.json file exists.");
         process.exit(1);
     }
     return;
@@ -115,7 +115,7 @@ const dev = async (argv) => {
         }
         process.exit(1);
     }
-    await checkForDocsJson(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 });

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

@@ -34,7 +34,9 @@ export const categorizeFiles = async (contentDirectoryPath) => {
                     });
                 }
             }
-            else if (!filename.endsWith("docs.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 === "docs.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("⚠️ docs.json deleted. Please create a new docs.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("docs.json has invalid JSON. You are likely missing a comma or a bracket. You can paste your docs.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, "docs.json"))) {
-        return pathUtil.join(contentDirectoryPath, "docs.json");
-    }
     if (await pathExists(pathUtil.join(contentDirectoryPath, "layout.json"))) {
         return pathUtil.join(contentDirectoryPath, "layout.json");
     }

package/dist/local-preview/prod.js

@@ -35,10 +35,10 @@ const promptForYarn = async () => {
         });
     }
 };
-const checkForDocsJson = 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 docs.json file exists.");
+        logger.fail("Must be ran in a directory where a layout.json file exists.");
         process.exit(1);
     }
     return;
@@ -71,7 +71,7 @@ const prod = async (argv) => {
         }
         process.exit(1);
     }
-    await checkForDocsJson(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 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docsalot/previewing",
-  "version": "0.1.0-beta.2",
+  "version": "0.1.0-beta.3",
   "description": "Preview DocsALot docs locally",
   "engines": {
     "node": ">=18.0.0"
@@ -29,8 +29,8 @@
   },
   "dependencies": {
     "@apidevtools/swagger-parser": "^10.1.0",
-    "@docsalot/prebuild": "^0.1.0-beta.2",
-    "@docsalot/validation": "^0.1.0-beta.2",
+    "@docsalot/prebuild": "^0.1.0-beta.3",
+    "@docsalot/validation": "^0.1.0-beta.3",
     "@octokit/rest": "^19.0.5",
     "axios": "^1.2.2",
     "chalk": "^5.1.0",