@mintlify/cli 4.0.781 → 4.0.783

package/CONTRIBUTING.md

@@ -4,13 +4,13 @@ Note: contributing requires `yarn` and it's recommended you install it as a glob
 
 Run `yarn` or `yarn install` to install dependencies. Then, run `npm link` once to link to your local version of the CLI in the npm global namespace (`npm list -g`). Make sure you are working in `packages/cli` and not its alias package, `packages/mintlify`.
 
-If you already have a non-local version of the CLI, you will need to uninstall it (`npm uninstall -g mintlify`) or force overwrite the executable file. Otherwise, you will get an `EEXIST` error on the mintlify binary. You can overwrite the file using the `--force` flag (`npm link --force`), but always double check the file(s) you are overwriting.
+If you already have a non-local version of the CLI, you will need to uninstall it (`npm uninstall -g mint`) or force overwrite the executable file. Otherwise, you will get an `EEXIST` error on the mintlify binary. You can overwrite the file using the `--force` flag (`npm link --force`), but always double check the file(s) you are overwriting.
 
 Make sure to build the CLI using `yarn build` or `yarn watch` to see your local changes reflected. Tip: keep `yarn watch` running in a separate terminal for changes to be quickly and continuously reflected while developing.
 
 To uninstall locally, run `npm uninstall -g @mintlify/cli`.
 
-If you wish to continue using the production version of the CLI, you will need to reinstall it (`npm install -g mintlify`). If you do not uninstall `@mintlify/cli`, then you will need to force overwrite the executable file (`npm install -g mintlify --force`) for the same reasons as mentioned above. As a best practice, we recommend always uninstalling `@mintlify/cli` first.
+If you wish to continue using the production version of the CLI, you will need to reinstall it (`npm install -g mint`). If you do not uninstall `@mintlify/cli`, then you will need to force overwrite the executable file (`npm install -g mint --force`) for the same reasons as mentioned above. As a best practice, we recommend always uninstalling `@mintlify/cli` first.
 
 ## Updating Version of Mint Client
 

package/bin/cli.js

@@ -17,6 +17,7 @@ import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
 import { accessibilityCheck } from './accessibilityCheck.js';
 import { checkPort, checkForMintJson, checkNodeVersion, upgradeConfig, checkForDocsJson, getVersions, suppressConsoleWarnings, 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';
@@ -183,6 +184,20 @@ export const cli = ({ packageName = 'mint' }) => {
         const { cli, client } = getVersions();
         addLog(_jsxs(Text, { children: [_jsx(Text, { bold: true, color: "green", children: "cli version" }), ' ', cli] }));
         addLog(_jsxs(Text, { children: [_jsx(Text, { bold: true, color: "green", children: "client version" }), ' ', client] }));
+    }))
+        .command('new [directory]', 'Create a new Mintlify documentation site', (yargs) => yargs.positional('directory', {
+        describe: 'The directory to initialize your documentation',
+        type: 'string',
+        default: '.',
+    }), (_a) => __awaiter(void 0, [_a], void 0, function* ({ directory }) {
+        try {
+            yield init(directory);
+            yield terminate(0);
+        }
+        catch (error) {
+            addLog(_jsx(ErrorLog, { message: error instanceof Error ? error.message : 'error occurred' }));
+            yield terminate(1);
+        }
     }))
         // Print the help menu when the user enters an invalid command.
         .strictCommands()

package/bin/init.js

@@ -0,0 +1,85 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+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) => {
+    addLogs(_jsx(Text, { bold: true, children: "Documentation Setup!" }), _jsx(Text, { children: "To see your docs run" }), _jsxs(Box, { children: [_jsx(Text, { color: "blue", children: "cd" }), _jsxs(Text, { children: [" ", installDir] })] }), _jsx(Text, { color: "blue", children: "mint dev" }));
+};
+export function init(installDir) {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield fse.ensureDir(installDir);
+        const dirContents = yield fse.readdir(installDir).catch(() => []);
+        if (dirContents.length > 0) {
+            const choice = yield 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 = yield input({
+                    message: 'Subdirectory name:',
+                    default: 'docs',
+                });
+                if (!subdir || subdir.trim() === '') {
+                    throw new Error('Subdirectory name cannot be empty');
+                }
+                installDir = installDir === '.' ? subdir : `${installDir}/${subdir}`;
+                yield fse.ensureDir(installDir);
+            }
+        }
+        const defaultProject = installDir == '.' ? 'Mintlify' : installDir;
+        const projectName = yield input({
+            message: 'Project Name',
+            default: defaultProject,
+        });
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const themes = docsConfigSchema.options.map((option) => {
+            return option.shape.theme._def.value;
+        });
+        const theme = yield select({
+            message: 'Theme',
+            choices: themes.map((t) => ({
+                name: t,
+                value: t,
+            })),
+        });
+        addLog(_jsx(SpinnerLog, { message: "downloading starter template..." }));
+        const response = yield fetch('https://github.com/mintlify/starter/archive/refs/heads/main.zip');
+        const buffer = yield response.arrayBuffer();
+        yield fse.writeFile(installDir + '/starter.zip', Buffer.from(buffer));
+        removeLastLog();
+        addLog(_jsx(SpinnerLog, { message: "extracting..." }));
+        new AdmZip(installDir + '/starter.zip').extractAllTo(installDir, true);
+        removeLastLog();
+        yield fse.copy(installDir + '/starter-main', installDir, {
+            overwrite: true,
+            filter: (src) => !src.includes('starter-main/starter-main'),
+        });
+        yield fse.remove(installDir + '/starter.zip');
+        yield fse.remove(installDir + '/starter-main');
+        const docsJsonPath = installDir + '/docs.json';
+        const docsConfig = yield fse.readJson(docsJsonPath);
+        docsConfig.theme = theme;
+        docsConfig.name = projectName;
+        yield fse.writeJson(docsJsonPath, docsConfig, { spaces: 2 });
+        sendOnboardingMessage(installDir);
+    });
+}