@mintlify/cli 4.0.781 → 4.0.783

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mintlify/cli",
-  "version": "4.0.781",
+  "version": "4.0.783",
   "description": "The Mintlify CLI",
   "engines": {
     "node": ">=18.0.0"
@@ -39,12 +39,14 @@
     "format:check": "prettier . --check"
   },
   "dependencies": {
-    "@mintlify/common": "1.0.583",
-    "@mintlify/link-rot": "3.0.724",
+    "@inquirer/prompts": "^7.9.0",
+    "@mintlify/common": "1.0.585",
+    "@mintlify/link-rot": "3.0.726",
     "@mintlify/models": "0.0.236",
-    "@mintlify/prebuild": "1.0.711",
-    "@mintlify/previewing": "4.0.760",
-    "@mintlify/validation": "0.1.507",
+    "@mintlify/prebuild": "1.0.713",
+    "@mintlify/previewing": "4.0.762",
+    "@mintlify/validation": "0.1.509",
+    "adm-zip": "^0.5.10",
     "chalk": "^5.2.0",
     "color": "^4.2.3",
     "detect-port": "^1.5.1",
@@ -66,6 +68,7 @@
     "@mintlify/ts-config": "2.0.2",
     "@trivago/prettier-plugin-sort-imports": "^4.2.1",
     "@tsconfig/recommended": "1.x",
+    "@types/adm-zip": "^0.5.7",
     "@types/detect-port": "^1.3.2",
     "@types/node": "^18.7.13",
     "@types/yargs": "^17.0.13",
@@ -78,5 +81,5 @@
     "vitest": "^2.0.4",
     "vitest-mock-process": "^1.0.4"
   },
-  "gitHead": "800cb24f2e15b125779ccfc8cc0ba8d8ef49aa14"
+  "gitHead": "78f8f714999cad2454683e01fb4f856e0336cdbb"
 }

package/src/cli.tsx

@@ -28,6 +28,7 @@ import {
   terminate,
   readLocalOpenApiFile,
 } from './helpers.js';
+import { init } from './init.js';
 import { mdxLinter } from './mdxLinter.js';
 import { migrateMdx } from './migrateMdx.js';
 import { update } from './update.js';
@@ -274,6 +275,27 @@ export const cli = ({ packageName = 'mint' }: { packageName?: string }) => {
           );
         }
       )
+      .command(
+        'new [directory]',
+        'Create a new Mintlify documentation site',
+        (yargs) =>
+          yargs.positional('directory', {
+            describe: 'The directory to initialize your documentation',
+            type: 'string',
+            default: '.',
+          }),
+        async ({ directory }) => {
+          try {
+            await init(directory);
+            await terminate(0);
+          } catch (error) {
+            addLog(
+              <ErrorLog message={error instanceof Error ? error.message : 'error occurred'} />
+            );
+            await terminate(1);
+          }
+        }
+      )
       // Print the help menu when the user enters an invalid command.
       .strictCommands()
       .demandCommand(1, 'unknown command. see above for the list of supported commands.')

package/src/init.tsx

@@ -0,0 +1,93 @@
+import { select, input } from '@inquirer/prompts';
+import { addLogs, addLog, SpinnerLog, removeLastLog } from '@mintlify/previewing';
+import { docsConfigSchema } from '@mintlify/validation';
+import AdmZip from 'adm-zip';
+import fse from 'fs-extra';
+import { Box, Text } from 'ink';
+
+const sendOnboardingMessage = (installDir: string) => {
+  addLogs(
+    <Text bold>Documentation Setup!</Text>,
+    <Text>To see your docs run</Text>,
+    <Box>
+      <Text color="blue">cd</Text>
+      <Text> {installDir}</Text>
+    </Box>,
+    <Text color="blue">mint dev</Text>
+  );
+};
+
+export async function init(installDir: string): Promise<void> {
+  await fse.ensureDir(installDir);
+  const dirContents = await fse.readdir(installDir).catch(() => []);
+  if (dirContents.length > 0) {
+    const choice = await select({
+      message: `Directory ${installDir} is not empty. What would you like to do?`,
+      choices: [
+        { name: 'Create in a subdirectory', value: 'subdir' },
+        { name: 'Overwrite current directory (may lose contents)', value: 'overwrite' },
+        { name: 'Cancel', value: 'cancel' },
+      ],
+    });
+
+    if (choice === 'cancel') {
+      return;
+    }
+
+    if (choice === 'subdir') {
+      const subdir = await input({
+        message: 'Subdirectory name:',
+        default: 'docs',
+      });
+      if (!subdir || subdir.trim() === '') {
+        throw new Error('Subdirectory name cannot be empty');
+      }
+      installDir = installDir === '.' ? subdir : `${installDir}/${subdir}`;
+      await fse.ensureDir(installDir);
+    }
+  }
+
+  const defaultProject = installDir == '.' ? 'Mintlify' : installDir;
+  const projectName = await input({
+    message: 'Project Name',
+    default: defaultProject,
+  });
+
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  const themes = docsConfigSchema.options.map((option: any) => {
+    return option.shape.theme._def.value;
+  });
+
+  const theme = await select({
+    message: 'Theme',
+    choices: themes.map((t: string) => ({
+      name: t,
+      value: t,
+    })),
+  });
+
+  addLog(<SpinnerLog message="downloading starter template..." />);
+  const response = await fetch('https://github.com/mintlify/starter/archive/refs/heads/main.zip');
+  const buffer = await response.arrayBuffer();
+  await fse.writeFile(installDir + '/starter.zip', Buffer.from(buffer));
+  removeLastLog();
+
+  addLog(<SpinnerLog message="extracting..." />);
+  new AdmZip(installDir + '/starter.zip').extractAllTo(installDir, true);
+  removeLastLog();
+
+  await fse.copy(installDir + '/starter-main', installDir, {
+    overwrite: true,
+    filter: (src) => !src.includes('starter-main/starter-main'),
+  });
+  await fse.remove(installDir + '/starter.zip');
+  await fse.remove(installDir + '/starter-main');
+
+  const docsJsonPath = installDir + '/docs.json';
+  const docsConfig = await fse.readJson(docsJsonPath);
+  docsConfig.theme = theme;
+  docsConfig.name = projectName;
+  await fse.writeJson(docsJsonPath, docsConfig, { spaces: 2 });
+
+  sendOnboardingMessage(installDir);
+}